@twin.org/standards-dataspace-protocol 0.0.3-next.55 → 0.0.3-next.56
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/es/schemas/DataspaceProtocolAgreement.json +3 -3
- package/dist/es/schemas/DataspaceProtocolContractAgreementMessage.json +3 -3
- package/dist/es/schemas/DataspaceProtocolOfferBase.json +3 -3
- package/dist/es/schemas/DataspaceProtocolPolicy.json +4 -4
- package/dist/es/schemas/DataspaceProtocolSet.json +3 -3
- package/docs/changelog.md +17 -0
- package/docs/reference/interfaces/IDataspaceProtocolAgreement.md +8 -8
- package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +34 -34
- package/docs/reference/interfaces/IDataspaceProtocolCatalogBase.md +34 -34
- package/docs/reference/interfaces/IDataspaceProtocolCatalogError.md +1 -1
- package/docs/reference/interfaces/IDataspaceProtocolCatalogRequestMessage.md +1 -1
- package/docs/reference/interfaces/IDataspaceProtocolContractAgreementMessage.md +1 -1
- package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationError.md +2 -2
- package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationTerminationMessage.md +2 -2
- package/docs/reference/interfaces/IDataspaceProtocolContractOfferMessage.md +2 -2
- package/docs/reference/interfaces/IDataspaceProtocolContractRequestMessage.md +2 -2
- package/docs/reference/interfaces/IDataspaceProtocolDataAddress.md +2 -2
- package/docs/reference/interfaces/IDataspaceProtocolDataService.md +21 -21
- package/docs/reference/interfaces/IDataspaceProtocolDataServiceBase.md +21 -21
- package/docs/reference/interfaces/IDataspaceProtocolDataset.md +25 -25
- package/docs/reference/interfaces/IDataspaceProtocolDatasetBase.md +25 -25
- package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +19 -19
- package/docs/reference/interfaces/IDataspaceProtocolDistributionBase.md +20 -20
- package/docs/reference/interfaces/IDataspaceProtocolOffer.md +9 -9
- package/docs/reference/interfaces/IDataspaceProtocolOfferBase.md +9 -9
- package/docs/reference/interfaces/IDataspaceProtocolPolicy.md +11 -11
- package/docs/reference/interfaces/IDataspaceProtocolSet.md +10 -10
- package/docs/reference/interfaces/IDataspaceProtocolTransferError.md +2 -2
- package/docs/reference/interfaces/IDataspaceProtocolTransferRequestMessage.md +1 -1
- package/docs/reference/interfaces/IDataspaceProtocolTransferStartMessage.md +1 -1
- package/docs/reference/interfaces/IDataspaceProtocolTransferSuspensionMessage.md +2 -2
- package/docs/reference/interfaces/IDataspaceProtocolTransferTerminationMessage.md +2 -2
- package/package.json +3 -3
|
@@ -72,7 +72,7 @@ REQUIRED per Eclipse Data Space Protocol.
|
|
|
72
72
|
|
|
73
73
|
### hasPolicy? {#haspolicy}
|
|
74
74
|
|
|
75
|
-
> `optional` **hasPolicy
|
|
75
|
+
> `optional` **hasPolicy?**: `ObjectOrArray`\<[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)\>
|
|
76
76
|
|
|
77
77
|
Array of ODRL policies (Offers) as required by DS Protocol.
|
|
78
78
|
|
|
@@ -115,7 +115,7 @@ REQUIRED per Eclipse Data Space Protocol.
|
|
|
115
115
|
|
|
116
116
|
### dcterms:title? {#dctermstitle}
|
|
117
117
|
|
|
118
|
-
> `optional` **dcterms:title
|
|
118
|
+
> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
|
|
119
119
|
|
|
120
120
|
A name given to the distribution.
|
|
121
121
|
|
|
@@ -131,7 +131,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
|
|
|
131
131
|
|
|
132
132
|
### dcterms:description? {#dctermsdescription}
|
|
133
133
|
|
|
134
|
-
> `optional` **dcterms:description
|
|
134
|
+
> `optional` **dcterms:description?**: `ObjectOrArray`\<`string`\>
|
|
135
135
|
|
|
136
136
|
A free-text account of the distribution.
|
|
137
137
|
|
|
@@ -147,7 +147,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
|
|
|
147
147
|
|
|
148
148
|
### dcterms:issued? {#dctermsissued}
|
|
149
149
|
|
|
150
|
-
> `optional` **dcterms:issued
|
|
150
|
+
> `optional` **dcterms:issued?**: `string`
|
|
151
151
|
|
|
152
152
|
Date of formal issuance of the distribution.
|
|
153
153
|
|
|
@@ -163,7 +163,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date
|
|
|
163
163
|
|
|
164
164
|
### dcterms:modified? {#dctermsmodified}
|
|
165
165
|
|
|
166
|
-
> `optional` **dcterms:modified
|
|
166
|
+
> `optional` **dcterms:modified?**: `string`
|
|
167
167
|
|
|
168
168
|
Most recent date on which the distribution was changed, updated or modified.
|
|
169
169
|
|
|
@@ -179,7 +179,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_update_date
|
|
|
179
179
|
|
|
180
180
|
### dcterms:license? {#dctermslicense}
|
|
181
181
|
|
|
182
|
-
> `optional` **dcterms:license
|
|
182
|
+
> `optional` **dcterms:license?**: `string`
|
|
183
183
|
|
|
184
184
|
A legal document under which the distribution is made available.
|
|
185
185
|
|
|
@@ -195,7 +195,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_license
|
|
|
195
195
|
|
|
196
196
|
### dcterms:accessRights? {#dctermsaccessrights}
|
|
197
197
|
|
|
198
|
-
> `optional` **dcterms:accessRights
|
|
198
|
+
> `optional` **dcterms:accessRights?**: `string`
|
|
199
199
|
|
|
200
200
|
Information about who can access the distribution.
|
|
201
201
|
|
|
@@ -211,7 +211,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_rights
|
|
|
211
211
|
|
|
212
212
|
### dcterms:rights? {#dctermsrights}
|
|
213
213
|
|
|
214
|
-
> `optional` **dcterms:rights
|
|
214
|
+
> `optional` **dcterms:rights?**: `string`
|
|
215
215
|
|
|
216
216
|
Information about rights held in and over the distribution.
|
|
217
217
|
|
|
@@ -227,7 +227,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_rights
|
|
|
227
227
|
|
|
228
228
|
### dcat:accessURL? {#dcataccessurl}
|
|
229
229
|
|
|
230
|
-
> `optional` **dcat:accessURL
|
|
230
|
+
> `optional` **dcat:accessURL?**: `string`
|
|
231
231
|
|
|
232
232
|
A URL of the resource that gives access to a distribution of the dataset.
|
|
233
233
|
|
|
@@ -243,7 +243,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_url
|
|
|
243
243
|
|
|
244
244
|
### dcat:accessService? {#dcataccessservice}
|
|
245
245
|
|
|
246
|
-
> `optional` **dcat:accessService
|
|
246
|
+
> `optional` **dcat:accessService?**: `string`
|
|
247
247
|
|
|
248
248
|
A data service that gives access to the distribution.
|
|
249
249
|
|
|
@@ -259,7 +259,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_service
|
|
|
259
259
|
|
|
260
260
|
### dcat:downloadURL? {#dcatdownloadurl}
|
|
261
261
|
|
|
262
|
-
> `optional` **dcat:downloadURL
|
|
262
|
+
> `optional` **dcat:downloadURL?**: `string`
|
|
263
263
|
|
|
264
264
|
The URL of the downloadable file in a given format.
|
|
265
265
|
|
|
@@ -275,7 +275,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_download_url
|
|
|
275
275
|
|
|
276
276
|
### dcat:byteSize? {#dcatbytesize}
|
|
277
277
|
|
|
278
|
-
> `optional` **dcat:byteSize
|
|
278
|
+
> `optional` **dcat:byteSize?**: `number`
|
|
279
279
|
|
|
280
280
|
The size of the distribution in bytes.
|
|
281
281
|
|
|
@@ -291,7 +291,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_byte_size
|
|
|
291
291
|
|
|
292
292
|
### dcat:spatialResolutionInMeters? {#dcatspatialresolutioninmeters}
|
|
293
293
|
|
|
294
|
-
> `optional` **dcat:spatialResolutionInMeters
|
|
294
|
+
> `optional` **dcat:spatialResolutionInMeters?**: `number`
|
|
295
295
|
|
|
296
296
|
The minimum spatial separation resolvable in a distribution, measured in meters.
|
|
297
297
|
|
|
@@ -307,7 +307,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_spatial_resolution
|
|
|
307
307
|
|
|
308
308
|
### dcat:temporalResolution? {#dcattemporalresolution}
|
|
309
309
|
|
|
310
|
-
> `optional` **dcat:temporalResolution
|
|
310
|
+
> `optional` **dcat:temporalResolution?**: `string`
|
|
311
311
|
|
|
312
312
|
Minimum time period resolvable in the distribution.
|
|
313
313
|
|
|
@@ -323,7 +323,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_temporal_resolution
|
|
|
323
323
|
|
|
324
324
|
### dcterms:conformsTo? {#dctermsconformsto}
|
|
325
325
|
|
|
326
|
-
> `optional` **dcterms:conformsTo
|
|
326
|
+
> `optional` **dcterms:conformsTo?**: `ObjectOrArray`\<`string`\>
|
|
327
327
|
|
|
328
328
|
An established standard to which the distribution conforms.
|
|
329
329
|
|
|
@@ -339,7 +339,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_conforms_to
|
|
|
339
339
|
|
|
340
340
|
### dcat:mediaType? {#dcatmediatype}
|
|
341
341
|
|
|
342
|
-
> `optional` **dcat:mediaType
|
|
342
|
+
> `optional` **dcat:mediaType?**: `string`
|
|
343
343
|
|
|
344
344
|
The media type of the distribution as defined by IANA.
|
|
345
345
|
|
|
@@ -355,7 +355,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_media_type
|
|
|
355
355
|
|
|
356
356
|
### dcat:compressFormat? {#dcatcompressformat}
|
|
357
357
|
|
|
358
|
-
> `optional` **dcat:compressFormat
|
|
358
|
+
> `optional` **dcat:compressFormat?**: `string`
|
|
359
359
|
|
|
360
360
|
The compression format of the distribution.
|
|
361
361
|
|
|
@@ -371,7 +371,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_compression_format
|
|
|
371
371
|
|
|
372
372
|
### dcat:packageFormat? {#dcatpackageformat}
|
|
373
373
|
|
|
374
|
-
> `optional` **dcat:packageFormat
|
|
374
|
+
> `optional` **dcat:packageFormat?**: `string`
|
|
375
375
|
|
|
376
376
|
The package format of the distribution.
|
|
377
377
|
|
|
@@ -387,7 +387,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_packaging_format
|
|
|
387
387
|
|
|
388
388
|
### spdx:checksum? {#spdxchecksum}
|
|
389
389
|
|
|
390
|
-
> `optional` **spdx:checksum
|
|
390
|
+
> `optional` **spdx:checksum?**: `string`
|
|
391
391
|
|
|
392
392
|
The checksum property provides a mechanism to verify the data integrity.
|
|
393
393
|
|
|
@@ -51,7 +51,7 @@ REQUIRED per Eclipse Data Space Protocol.
|
|
|
51
51
|
|
|
52
52
|
### @id? {#id}
|
|
53
53
|
|
|
54
|
-
> `optional` **@id
|
|
54
|
+
> `optional` **@id?**: `string`
|
|
55
55
|
|
|
56
56
|
Unique identifier for the distribution.
|
|
57
57
|
OPTIONAL for embedded distributions (may use JSON-LD blank nodes).
|
|
@@ -65,7 +65,7 @@ REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
|
|
|
65
65
|
|
|
66
66
|
### hasPolicy? {#haspolicy}
|
|
67
67
|
|
|
68
|
-
> `optional` **hasPolicy
|
|
68
|
+
> `optional` **hasPolicy?**: `ObjectOrArray`\<[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)\>
|
|
69
69
|
|
|
70
70
|
Array of ODRL policies (Offers) as required by DS Protocol.
|
|
71
71
|
|
|
@@ -96,7 +96,7 @@ REQUIRED per Eclipse Data Space Protocol.
|
|
|
96
96
|
|
|
97
97
|
### dcterms:title? {#dctermstitle}
|
|
98
98
|
|
|
99
|
-
> `optional` **dcterms:title
|
|
99
|
+
> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
|
|
100
100
|
|
|
101
101
|
A name given to the distribution.
|
|
102
102
|
|
|
@@ -112,7 +112,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
|
|
|
112
112
|
|
|
113
113
|
### dcterms:description? {#dctermsdescription}
|
|
114
114
|
|
|
115
|
-
> `optional` **dcterms:description
|
|
115
|
+
> `optional` **dcterms:description?**: `ObjectOrArray`\<`string`\>
|
|
116
116
|
|
|
117
117
|
A free-text account of the distribution.
|
|
118
118
|
|
|
@@ -128,7 +128,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
|
|
|
128
128
|
|
|
129
129
|
### dcterms:issued? {#dctermsissued}
|
|
130
130
|
|
|
131
|
-
> `optional` **dcterms:issued
|
|
131
|
+
> `optional` **dcterms:issued?**: `string`
|
|
132
132
|
|
|
133
133
|
Date of formal issuance of the distribution.
|
|
134
134
|
|
|
@@ -144,7 +144,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date
|
|
|
144
144
|
|
|
145
145
|
### dcterms:modified? {#dctermsmodified}
|
|
146
146
|
|
|
147
|
-
> `optional` **dcterms:modified
|
|
147
|
+
> `optional` **dcterms:modified?**: `string`
|
|
148
148
|
|
|
149
149
|
Most recent date on which the distribution was changed, updated or modified.
|
|
150
150
|
|
|
@@ -160,7 +160,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_update_date
|
|
|
160
160
|
|
|
161
161
|
### dcterms:license? {#dctermslicense}
|
|
162
162
|
|
|
163
|
-
> `optional` **dcterms:license
|
|
163
|
+
> `optional` **dcterms:license?**: `string`
|
|
164
164
|
|
|
165
165
|
A legal document under which the distribution is made available.
|
|
166
166
|
|
|
@@ -176,7 +176,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_license
|
|
|
176
176
|
|
|
177
177
|
### dcterms:accessRights? {#dctermsaccessrights}
|
|
178
178
|
|
|
179
|
-
> `optional` **dcterms:accessRights
|
|
179
|
+
> `optional` **dcterms:accessRights?**: `string`
|
|
180
180
|
|
|
181
181
|
Information about who can access the distribution.
|
|
182
182
|
|
|
@@ -192,7 +192,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_rights
|
|
|
192
192
|
|
|
193
193
|
### dcterms:rights? {#dctermsrights}
|
|
194
194
|
|
|
195
|
-
> `optional` **dcterms:rights
|
|
195
|
+
> `optional` **dcterms:rights?**: `string`
|
|
196
196
|
|
|
197
197
|
Information about rights held in and over the distribution.
|
|
198
198
|
|
|
@@ -208,7 +208,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_rights
|
|
|
208
208
|
|
|
209
209
|
### dcat:accessURL? {#dcataccessurl}
|
|
210
210
|
|
|
211
|
-
> `optional` **dcat:accessURL
|
|
211
|
+
> `optional` **dcat:accessURL?**: `string`
|
|
212
212
|
|
|
213
213
|
A URL of the resource that gives access to a distribution of the dataset.
|
|
214
214
|
|
|
@@ -224,7 +224,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_url
|
|
|
224
224
|
|
|
225
225
|
### dcat:accessService? {#dcataccessservice}
|
|
226
226
|
|
|
227
|
-
> `optional` **dcat:accessService
|
|
227
|
+
> `optional` **dcat:accessService?**: `string`
|
|
228
228
|
|
|
229
229
|
A data service that gives access to the distribution.
|
|
230
230
|
|
|
@@ -240,7 +240,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_service
|
|
|
240
240
|
|
|
241
241
|
### dcat:downloadURL? {#dcatdownloadurl}
|
|
242
242
|
|
|
243
|
-
> `optional` **dcat:downloadURL
|
|
243
|
+
> `optional` **dcat:downloadURL?**: `string`
|
|
244
244
|
|
|
245
245
|
The URL of the downloadable file in a given format.
|
|
246
246
|
|
|
@@ -256,7 +256,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_download_url
|
|
|
256
256
|
|
|
257
257
|
### dcat:byteSize? {#dcatbytesize}
|
|
258
258
|
|
|
259
|
-
> `optional` **dcat:byteSize
|
|
259
|
+
> `optional` **dcat:byteSize?**: `number`
|
|
260
260
|
|
|
261
261
|
The size of the distribution in bytes.
|
|
262
262
|
|
|
@@ -272,7 +272,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_byte_size
|
|
|
272
272
|
|
|
273
273
|
### dcat:spatialResolutionInMeters? {#dcatspatialresolutioninmeters}
|
|
274
274
|
|
|
275
|
-
> `optional` **dcat:spatialResolutionInMeters
|
|
275
|
+
> `optional` **dcat:spatialResolutionInMeters?**: `number`
|
|
276
276
|
|
|
277
277
|
The minimum spatial separation resolvable in a distribution, measured in meters.
|
|
278
278
|
|
|
@@ -288,7 +288,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_spatial_resolution
|
|
|
288
288
|
|
|
289
289
|
### dcat:temporalResolution? {#dcattemporalresolution}
|
|
290
290
|
|
|
291
|
-
> `optional` **dcat:temporalResolution
|
|
291
|
+
> `optional` **dcat:temporalResolution?**: `string`
|
|
292
292
|
|
|
293
293
|
Minimum time period resolvable in the distribution.
|
|
294
294
|
|
|
@@ -304,7 +304,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_temporal_resolution
|
|
|
304
304
|
|
|
305
305
|
### dcterms:conformsTo? {#dctermsconformsto}
|
|
306
306
|
|
|
307
|
-
> `optional` **dcterms:conformsTo
|
|
307
|
+
> `optional` **dcterms:conformsTo?**: `ObjectOrArray`\<`string`\>
|
|
308
308
|
|
|
309
309
|
An established standard to which the distribution conforms.
|
|
310
310
|
|
|
@@ -320,7 +320,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_conforms_to
|
|
|
320
320
|
|
|
321
321
|
### dcat:mediaType? {#dcatmediatype}
|
|
322
322
|
|
|
323
|
-
> `optional` **dcat:mediaType
|
|
323
|
+
> `optional` **dcat:mediaType?**: `string`
|
|
324
324
|
|
|
325
325
|
The media type of the distribution as defined by IANA.
|
|
326
326
|
|
|
@@ -336,7 +336,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_media_type
|
|
|
336
336
|
|
|
337
337
|
### dcat:compressFormat? {#dcatcompressformat}
|
|
338
338
|
|
|
339
|
-
> `optional` **dcat:compressFormat
|
|
339
|
+
> `optional` **dcat:compressFormat?**: `string`
|
|
340
340
|
|
|
341
341
|
The compression format of the distribution.
|
|
342
342
|
|
|
@@ -352,7 +352,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_compression_format
|
|
|
352
352
|
|
|
353
353
|
### dcat:packageFormat? {#dcatpackageformat}
|
|
354
354
|
|
|
355
|
-
> `optional` **dcat:packageFormat
|
|
355
|
+
> `optional` **dcat:packageFormat?**: `string`
|
|
356
356
|
|
|
357
357
|
The package format of the distribution.
|
|
358
358
|
|
|
@@ -368,7 +368,7 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_packaging_format
|
|
|
368
368
|
|
|
369
369
|
### spdx:checksum? {#spdxchecksum}
|
|
370
370
|
|
|
371
|
-
> `optional` **spdx:checksum
|
|
371
|
+
> `optional` **spdx:checksum?**: `string`
|
|
372
372
|
|
|
373
373
|
The checksum property provides a mechanism to verify the data integrity.
|
|
374
374
|
|
|
@@ -64,7 +64,7 @@ Required for Offer policies.
|
|
|
64
64
|
|
|
65
65
|
### profile? {#profile}
|
|
66
66
|
|
|
67
|
-
> `optional` **profile
|
|
67
|
+
> `optional` **profile?**: `ObjectOrArray`\<`string`\>
|
|
68
68
|
|
|
69
69
|
The profile(s) this policy conforms to.
|
|
70
70
|
IRIs identifying the ODRL Profile(s).
|
|
@@ -77,7 +77,7 @@ IRIs identifying the ODRL Profile(s).
|
|
|
77
77
|
|
|
78
78
|
### assignee? {#assignee}
|
|
79
79
|
|
|
80
|
-
> `optional` **assignee
|
|
80
|
+
> `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
|
|
81
81
|
|
|
82
82
|
The assignee of the policy.
|
|
83
83
|
Applies to all rules unless overridden at rule level.
|
|
@@ -90,7 +90,7 @@ Applies to all rules unless overridden at rule level.
|
|
|
90
90
|
|
|
91
91
|
### target? {#target}
|
|
92
92
|
|
|
93
|
-
> `optional` **target
|
|
93
|
+
> `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
|
|
94
94
|
|
|
95
95
|
The target asset for the rule.
|
|
96
96
|
|
|
@@ -102,7 +102,7 @@ The target asset for the rule.
|
|
|
102
102
|
|
|
103
103
|
### action? {#action}
|
|
104
104
|
|
|
105
|
-
> `optional` **action
|
|
105
|
+
> `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
|
|
106
106
|
|
|
107
107
|
The action associated with the rule.
|
|
108
108
|
|
|
@@ -114,7 +114,7 @@ The action associated with the rule.
|
|
|
114
114
|
|
|
115
115
|
### inheritFrom? {#inheritfrom}
|
|
116
116
|
|
|
117
|
-
> `optional` **inheritFrom
|
|
117
|
+
> `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
|
|
118
118
|
|
|
119
119
|
The parent policy(ies) this policy inherits from.
|
|
120
120
|
IRIs identifying the parent Policy(ies).
|
|
@@ -127,7 +127,7 @@ IRIs identifying the parent Policy(ies).
|
|
|
127
127
|
|
|
128
128
|
### conflict? {#conflict}
|
|
129
129
|
|
|
130
|
-
> `optional` **conflict
|
|
130
|
+
> `optional` **conflict?**: `OdrlConflictStrategyType`
|
|
131
131
|
|
|
132
132
|
The conflict resolution strategy.
|
|
133
133
|
- perm: Permissions override Prohibitions
|
|
@@ -142,7 +142,7 @@ The conflict resolution strategy.
|
|
|
142
142
|
|
|
143
143
|
### permission? {#permission}
|
|
144
144
|
|
|
145
|
-
> `optional` **permission
|
|
145
|
+
> `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
|
|
146
146
|
|
|
147
147
|
The permissions in the policy.
|
|
148
148
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -155,7 +155,7 @@ At least one of permission, prohibition, or obligation must be present.
|
|
|
155
155
|
|
|
156
156
|
### prohibition? {#prohibition}
|
|
157
157
|
|
|
158
|
-
> `optional` **prohibition
|
|
158
|
+
> `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
|
|
159
159
|
|
|
160
160
|
The prohibitions in the policy.
|
|
161
161
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -168,7 +168,7 @@ At least one of permission, prohibition, or obligation must be present.
|
|
|
168
168
|
|
|
169
169
|
### obligation? {#obligation}
|
|
170
170
|
|
|
171
|
-
> `optional` **obligation
|
|
171
|
+
> `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
|
|
172
172
|
|
|
173
173
|
The obligations in the policy.
|
|
174
174
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -57,7 +57,7 @@ Required for Offer policies.
|
|
|
57
57
|
|
|
58
58
|
### profile? {#profile}
|
|
59
59
|
|
|
60
|
-
> `optional` **profile
|
|
60
|
+
> `optional` **profile?**: `ObjectOrArray`\<`string`\>
|
|
61
61
|
|
|
62
62
|
The profile(s) this policy conforms to.
|
|
63
63
|
IRIs identifying the ODRL Profile(s).
|
|
@@ -70,7 +70,7 @@ IRIs identifying the ODRL Profile(s).
|
|
|
70
70
|
|
|
71
71
|
### assignee? {#assignee}
|
|
72
72
|
|
|
73
|
-
> `optional` **assignee
|
|
73
|
+
> `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
|
|
74
74
|
|
|
75
75
|
The assignee of the policy.
|
|
76
76
|
Applies to all rules unless overridden at rule level.
|
|
@@ -83,7 +83,7 @@ Applies to all rules unless overridden at rule level.
|
|
|
83
83
|
|
|
84
84
|
### target? {#target}
|
|
85
85
|
|
|
86
|
-
> `optional` **target
|
|
86
|
+
> `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
|
|
87
87
|
|
|
88
88
|
The target asset for the rule.
|
|
89
89
|
|
|
@@ -95,7 +95,7 @@ The target asset for the rule.
|
|
|
95
95
|
|
|
96
96
|
### action? {#action}
|
|
97
97
|
|
|
98
|
-
> `optional` **action
|
|
98
|
+
> `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
|
|
99
99
|
|
|
100
100
|
The action associated with the rule.
|
|
101
101
|
|
|
@@ -107,7 +107,7 @@ The action associated with the rule.
|
|
|
107
107
|
|
|
108
108
|
### inheritFrom? {#inheritfrom}
|
|
109
109
|
|
|
110
|
-
> `optional` **inheritFrom
|
|
110
|
+
> `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
|
|
111
111
|
|
|
112
112
|
The parent policy(ies) this policy inherits from.
|
|
113
113
|
IRIs identifying the parent Policy(ies).
|
|
@@ -120,7 +120,7 @@ IRIs identifying the parent Policy(ies).
|
|
|
120
120
|
|
|
121
121
|
### conflict? {#conflict}
|
|
122
122
|
|
|
123
|
-
> `optional` **conflict
|
|
123
|
+
> `optional` **conflict?**: `OdrlConflictStrategyType`
|
|
124
124
|
|
|
125
125
|
The conflict resolution strategy.
|
|
126
126
|
- perm: Permissions override Prohibitions
|
|
@@ -135,7 +135,7 @@ The conflict resolution strategy.
|
|
|
135
135
|
|
|
136
136
|
### permission? {#permission}
|
|
137
137
|
|
|
138
|
-
> `optional` **permission
|
|
138
|
+
> `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
|
|
139
139
|
|
|
140
140
|
The permissions in the policy.
|
|
141
141
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -148,7 +148,7 @@ At least one of permission, prohibition, or obligation must be present.
|
|
|
148
148
|
|
|
149
149
|
### prohibition? {#prohibition}
|
|
150
150
|
|
|
151
|
-
> `optional` **prohibition
|
|
151
|
+
> `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
|
|
152
152
|
|
|
153
153
|
The prohibitions in the policy.
|
|
154
154
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -161,7 +161,7 @@ At least one of permission, prohibition, or obligation must be present.
|
|
|
161
161
|
|
|
162
162
|
### obligation? {#obligation}
|
|
163
163
|
|
|
164
|
-
> `optional` **obligation
|
|
164
|
+
> `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
|
|
165
165
|
|
|
166
166
|
The obligations in the policy.
|
|
167
167
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -40,7 +40,7 @@ Must include "https://www.w3.org/ns/odrl.jsonld"
|
|
|
40
40
|
|
|
41
41
|
### @type {#type}
|
|
42
42
|
|
|
43
|
-
> **@type**: `
|
|
43
|
+
> **@type**: `OdrlPolicyType`
|
|
44
44
|
|
|
45
45
|
The type of policy.
|
|
46
46
|
Must be one of: "Set", "Offer", "Agreement"
|
|
@@ -53,7 +53,7 @@ Must be one of: "Set", "Offer", "Agreement"
|
|
|
53
53
|
|
|
54
54
|
### profile? {#profile}
|
|
55
55
|
|
|
56
|
-
> `optional` **profile
|
|
56
|
+
> `optional` **profile?**: `ObjectOrArray`\<`string`\>
|
|
57
57
|
|
|
58
58
|
The profile(s) this policy conforms to.
|
|
59
59
|
IRIs identifying the ODRL Profile(s).
|
|
@@ -66,7 +66,7 @@ IRIs identifying the ODRL Profile(s).
|
|
|
66
66
|
|
|
67
67
|
### assigner? {#assigner}
|
|
68
68
|
|
|
69
|
-
> `optional` **assigner
|
|
69
|
+
> `optional` **assigner?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
|
|
70
70
|
|
|
71
71
|
The assigner of the policy.
|
|
72
72
|
Applies to all rules unless overridden at rule level.
|
|
@@ -79,7 +79,7 @@ Applies to all rules unless overridden at rule level.
|
|
|
79
79
|
|
|
80
80
|
### assignee? {#assignee}
|
|
81
81
|
|
|
82
|
-
> `optional` **assignee
|
|
82
|
+
> `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
|
|
83
83
|
|
|
84
84
|
The assignee of the policy.
|
|
85
85
|
Applies to all rules unless overridden at rule level.
|
|
@@ -92,7 +92,7 @@ Applies to all rules unless overridden at rule level.
|
|
|
92
92
|
|
|
93
93
|
### target? {#target}
|
|
94
94
|
|
|
95
|
-
> `optional` **target
|
|
95
|
+
> `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
|
|
96
96
|
|
|
97
97
|
The target asset for the rule.
|
|
98
98
|
|
|
@@ -104,7 +104,7 @@ The target asset for the rule.
|
|
|
104
104
|
|
|
105
105
|
### action? {#action}
|
|
106
106
|
|
|
107
|
-
> `optional` **action
|
|
107
|
+
> `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
|
|
108
108
|
|
|
109
109
|
The action associated with the rule.
|
|
110
110
|
|
|
@@ -116,7 +116,7 @@ The action associated with the rule.
|
|
|
116
116
|
|
|
117
117
|
### inheritFrom? {#inheritfrom}
|
|
118
118
|
|
|
119
|
-
> `optional` **inheritFrom
|
|
119
|
+
> `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
|
|
120
120
|
|
|
121
121
|
The parent policy(ies) this policy inherits from.
|
|
122
122
|
IRIs identifying the parent Policy(ies).
|
|
@@ -129,7 +129,7 @@ IRIs identifying the parent Policy(ies).
|
|
|
129
129
|
|
|
130
130
|
### conflict? {#conflict}
|
|
131
131
|
|
|
132
|
-
> `optional` **conflict
|
|
132
|
+
> `optional` **conflict?**: `OdrlConflictStrategyType`
|
|
133
133
|
|
|
134
134
|
The conflict resolution strategy.
|
|
135
135
|
- perm: Permissions override Prohibitions
|
|
@@ -144,7 +144,7 @@ The conflict resolution strategy.
|
|
|
144
144
|
|
|
145
145
|
### permission? {#permission}
|
|
146
146
|
|
|
147
|
-
> `optional` **permission
|
|
147
|
+
> `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
|
|
148
148
|
|
|
149
149
|
The permissions in the policy.
|
|
150
150
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -157,7 +157,7 @@ At least one of permission, prohibition, or obligation must be present.
|
|
|
157
157
|
|
|
158
158
|
### prohibition? {#prohibition}
|
|
159
159
|
|
|
160
|
-
> `optional` **prohibition
|
|
160
|
+
> `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
|
|
161
161
|
|
|
162
162
|
The prohibitions in the policy.
|
|
163
163
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -170,7 +170,7 @@ At least one of permission, prohibition, or obligation must be present.
|
|
|
170
170
|
|
|
171
171
|
### obligation? {#obligation}
|
|
172
172
|
|
|
173
|
-
> `optional` **obligation
|
|
173
|
+
> `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
|
|
174
174
|
|
|
175
175
|
The obligations in the policy.
|
|
176
176
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -40,7 +40,7 @@ Must include "https://www.w3.org/ns/odrl.jsonld"
|
|
|
40
40
|
|
|
41
41
|
### profile? {#profile}
|
|
42
42
|
|
|
43
|
-
> `optional` **profile
|
|
43
|
+
> `optional` **profile?**: `ObjectOrArray`\<`string`\>
|
|
44
44
|
|
|
45
45
|
The profile(s) this policy conforms to.
|
|
46
46
|
IRIs identifying the ODRL Profile(s).
|
|
@@ -53,7 +53,7 @@ IRIs identifying the ODRL Profile(s).
|
|
|
53
53
|
|
|
54
54
|
### assigner? {#assigner}
|
|
55
55
|
|
|
56
|
-
> `optional` **assigner
|
|
56
|
+
> `optional` **assigner?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
|
|
57
57
|
|
|
58
58
|
The assigner of the policy.
|
|
59
59
|
Applies to all rules unless overridden at rule level.
|
|
@@ -66,7 +66,7 @@ Applies to all rules unless overridden at rule level.
|
|
|
66
66
|
|
|
67
67
|
### assignee? {#assignee}
|
|
68
68
|
|
|
69
|
-
> `optional` **assignee
|
|
69
|
+
> `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
|
|
70
70
|
|
|
71
71
|
The assignee of the policy.
|
|
72
72
|
Applies to all rules unless overridden at rule level.
|
|
@@ -79,7 +79,7 @@ Applies to all rules unless overridden at rule level.
|
|
|
79
79
|
|
|
80
80
|
### target? {#target}
|
|
81
81
|
|
|
82
|
-
> `optional` **target
|
|
82
|
+
> `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
|
|
83
83
|
|
|
84
84
|
The target asset for the rule.
|
|
85
85
|
|
|
@@ -91,7 +91,7 @@ The target asset for the rule.
|
|
|
91
91
|
|
|
92
92
|
### action? {#action}
|
|
93
93
|
|
|
94
|
-
> `optional` **action
|
|
94
|
+
> `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
|
|
95
95
|
|
|
96
96
|
The action associated with the rule.
|
|
97
97
|
|
|
@@ -103,7 +103,7 @@ The action associated with the rule.
|
|
|
103
103
|
|
|
104
104
|
### inheritFrom? {#inheritfrom}
|
|
105
105
|
|
|
106
|
-
> `optional` **inheritFrom
|
|
106
|
+
> `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
|
|
107
107
|
|
|
108
108
|
The parent policy(ies) this policy inherits from.
|
|
109
109
|
IRIs identifying the parent Policy(ies).
|
|
@@ -116,7 +116,7 @@ IRIs identifying the parent Policy(ies).
|
|
|
116
116
|
|
|
117
117
|
### conflict? {#conflict}
|
|
118
118
|
|
|
119
|
-
> `optional` **conflict
|
|
119
|
+
> `optional` **conflict?**: `OdrlConflictStrategyType`
|
|
120
120
|
|
|
121
121
|
The conflict resolution strategy.
|
|
122
122
|
- perm: Permissions override Prohibitions
|
|
@@ -131,7 +131,7 @@ The conflict resolution strategy.
|
|
|
131
131
|
|
|
132
132
|
### permission? {#permission}
|
|
133
133
|
|
|
134
|
-
> `optional` **permission
|
|
134
|
+
> `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
|
|
135
135
|
|
|
136
136
|
The permissions in the policy.
|
|
137
137
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -144,7 +144,7 @@ At least one of permission, prohibition, or obligation must be present.
|
|
|
144
144
|
|
|
145
145
|
### prohibition? {#prohibition}
|
|
146
146
|
|
|
147
|
-
> `optional` **prohibition
|
|
147
|
+
> `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
|
|
148
148
|
|
|
149
149
|
The prohibitions in the policy.
|
|
150
150
|
At least one of permission, prohibition, or obligation must be present.
|
|
@@ -157,7 +157,7 @@ At least one of permission, prohibition, or obligation must be present.
|
|
|
157
157
|
|
|
158
158
|
### obligation? {#obligation}
|
|
159
159
|
|
|
160
|
-
> `optional` **obligation
|
|
160
|
+
> `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
|
|
161
161
|
|
|
162
162
|
The obligations in the policy.
|
|
163
163
|
At least one of permission, prohibition, or obligation must be present.
|