@twin.org/dataspace-models 0.0.3-next.20 → 0.0.3-next.22
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/DataspaceActivity.json +724 -18
- package/docs/changelog.md +14 -0
- package/docs/reference/classes/TransferProcess.md +6 -6
- package/docs/reference/interfaces/IActivityLogDates.md +1 -1
- package/docs/reference/interfaces/IActivityLogDetails.md +2 -2
- package/docs/reference/interfaces/IActivityLogEntry.md +6 -6
- package/docs/reference/interfaces/IActivityLogStatusNotification.md +1 -1
- package/docs/reference/interfaces/IActivityQuery.md +2 -2
- package/docs/reference/interfaces/ICompleteTransferResponse.md +1 -1
- package/docs/reference/interfaces/IDataAssetEntitiesResponse.md +2 -2
- package/docs/reference/interfaces/IDataAssetGetEntitiesRequest.md +6 -6
- package/docs/reference/interfaces/IDataAssetItemListResult.md +1 -1
- package/docs/reference/interfaces/IDataAssetQueryRequest.md +5 -5
- package/docs/reference/interfaces/IDataspaceActivity.md +1 -1
- package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md +4 -4
- package/docs/reference/interfaces/IEntitySet.md +1 -1
- package/docs/reference/interfaces/IFilteringQuery.md +1 -1
- package/docs/reference/interfaces/IGetTransferProcessResponse.md +1 -1
- package/docs/reference/interfaces/IRequestTransferResponse.md +1 -1
- package/docs/reference/interfaces/IStartTransferResponse.md +1 -1
- package/docs/reference/interfaces/ISuspendTransferResponse.md +1 -1
- package/docs/reference/interfaces/ITerminateTransferResponse.md +1 -1
- package/docs/reference/interfaces/ITransferContext.md +3 -3
- package/docs/reference/interfaces/ITransferProcess.md +6 -6
- package/package.json +1 -1
|
@@ -1,33 +1,739 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://schema.twindev.org/dataspace/DataspaceActivity",
|
|
4
|
-
"description": "Activity Streams Activity expected by the Dataspace Data Plane",
|
|
5
4
|
"title": "DataspaceActivity",
|
|
6
|
-
"
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
"description": "A dataspace activity that restricts an activity so that it can be handled by a Dataspace Data Plane",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"object": {
|
|
9
|
+
"anyOf": [
|
|
10
|
+
{
|
|
11
|
+
"properties": {
|
|
12
|
+
"type": {
|
|
13
|
+
"anyOf": [
|
|
14
|
+
{
|
|
15
|
+
"type": "string"
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"type": "array",
|
|
19
|
+
"items": {
|
|
20
|
+
"type": "string"
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
]
|
|
24
|
+
},
|
|
25
|
+
"@context": {
|
|
26
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
"required": [
|
|
30
|
+
"type",
|
|
31
|
+
"@context"
|
|
32
|
+
],
|
|
33
|
+
"type": "object",
|
|
34
|
+
"$comment": "Inlined utility base type O & { type: ObjectOrArray<string> } so utility transformations can operate on concrete properties instead of a $ref."
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"type": "array",
|
|
38
|
+
"items": {
|
|
39
|
+
"properties": {
|
|
40
|
+
"type": {
|
|
41
|
+
"anyOf": [
|
|
42
|
+
{
|
|
43
|
+
"type": "string"
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"type": "array",
|
|
47
|
+
"items": {
|
|
48
|
+
"type": "string"
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
"@context": {
|
|
54
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
"required": [
|
|
58
|
+
"type",
|
|
59
|
+
"@context"
|
|
60
|
+
],
|
|
61
|
+
"type": "object",
|
|
62
|
+
"$comment": "Inlined utility base type O & { type: ObjectOrArray<string> } so utility transformations can operate on concrete properties instead of a $ref."
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
],
|
|
66
|
+
"description": "Activity's Object"
|
|
9
67
|
},
|
|
68
|
+
"target": {
|
|
69
|
+
"properties": {
|
|
70
|
+
"type": {
|
|
71
|
+
"anyOf": [
|
|
72
|
+
{
|
|
73
|
+
"type": "string"
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"type": "array",
|
|
77
|
+
"items": {
|
|
78
|
+
"type": "string"
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
]
|
|
82
|
+
},
|
|
83
|
+
"@context": {
|
|
84
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
"required": [
|
|
88
|
+
"type",
|
|
89
|
+
"@context"
|
|
90
|
+
],
|
|
91
|
+
"type": "object",
|
|
92
|
+
"$comment": "Inlined utility base type T & { type: ObjectOrArray<string> } so utility transformations can operate on concrete properties instead of a $ref.",
|
|
93
|
+
"description": "Activity's target"
|
|
94
|
+
}
|
|
95
|
+
},
|
|
96
|
+
"required": [
|
|
97
|
+
"object"
|
|
98
|
+
],
|
|
99
|
+
"allOf": [
|
|
10
100
|
{
|
|
101
|
+
"description": "A W3C Activity from Activity Streams.\n\nAn `Activity` describes an action performed by an `actor` on an `object`, and\ncan optionally include a `target`, `result`, `origin`, or `instrument`.",
|
|
11
102
|
"type": "object",
|
|
12
103
|
"properties": {
|
|
13
|
-
"
|
|
14
|
-
"
|
|
15
|
-
"
|
|
16
|
-
|
|
17
|
-
"type"
|
|
18
|
-
]
|
|
104
|
+
"@context": {
|
|
105
|
+
"$ref": "https://schema.twindev.org/w3c-activity-streams/ActivityStreamsContextType",
|
|
106
|
+
"description": "The LD Context.",
|
|
107
|
+
"$comment": "Inherited from ActivityStreamsActivity"
|
|
19
108
|
},
|
|
20
|
-
"
|
|
21
|
-
"
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
109
|
+
"type": {
|
|
110
|
+
"anyOf": [
|
|
111
|
+
{
|
|
112
|
+
"$ref": "https://schema.twindev.org/w3c-activity-streams/ActivityStreamsTypes"
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"type": "string"
|
|
116
|
+
},
|
|
117
|
+
{
|
|
118
|
+
"type": "array",
|
|
119
|
+
"items": {
|
|
120
|
+
"anyOf": [
|
|
121
|
+
{
|
|
122
|
+
"$ref": "https://schema.twindev.org/w3c-activity-streams/ActivityStreamsTypes"
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
"type": "string"
|
|
126
|
+
}
|
|
127
|
+
]
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
],
|
|
131
|
+
"description": "Activity Type.",
|
|
132
|
+
"$comment": "Inherited from ActivityStreamsActivity"
|
|
133
|
+
},
|
|
134
|
+
"id": {
|
|
135
|
+
"type": "string",
|
|
136
|
+
"description": "Global identifier.",
|
|
137
|
+
"format": "uri",
|
|
138
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
139
|
+
},
|
|
140
|
+
"name": {
|
|
141
|
+
"anyOf": [
|
|
142
|
+
{
|
|
143
|
+
"type": "string"
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
147
|
+
}
|
|
148
|
+
],
|
|
149
|
+
"description": "Natural language name.",
|
|
150
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
151
|
+
},
|
|
152
|
+
"nameMap": {
|
|
153
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap",
|
|
154
|
+
"description": "Natural language name map.",
|
|
155
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
156
|
+
},
|
|
157
|
+
"summary": {
|
|
158
|
+
"anyOf": [
|
|
159
|
+
{
|
|
160
|
+
"type": "string"
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
164
|
+
}
|
|
165
|
+
],
|
|
166
|
+
"description": "Summary of the Activity.",
|
|
167
|
+
"$comment": "Inherited from ActivityStreamsActivity"
|
|
168
|
+
},
|
|
169
|
+
"summaryMap": {
|
|
170
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap",
|
|
171
|
+
"description": "Natural language summary map.",
|
|
172
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
173
|
+
},
|
|
174
|
+
"content": {
|
|
175
|
+
"anyOf": [
|
|
176
|
+
{
|
|
177
|
+
"type": "string"
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
|
|
181
|
+
}
|
|
182
|
+
],
|
|
183
|
+
"description": "Natural language content.",
|
|
184
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
185
|
+
},
|
|
186
|
+
"contentMap": {
|
|
187
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap",
|
|
188
|
+
"description": "Natural language content map.",
|
|
189
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
190
|
+
},
|
|
191
|
+
"url": {
|
|
192
|
+
"anyOf": [
|
|
193
|
+
{
|
|
194
|
+
"type": "string"
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
"type": "array",
|
|
201
|
+
"items": {
|
|
202
|
+
"anyOf": [
|
|
203
|
+
{
|
|
204
|
+
"type": "string"
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
208
|
+
}
|
|
209
|
+
]
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
],
|
|
213
|
+
"description": "A link to the representation of the object.\n\nThe value can be a URI or an embedded node object.",
|
|
214
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
215
|
+
},
|
|
216
|
+
"image": {
|
|
217
|
+
"anyOf": [
|
|
218
|
+
{
|
|
219
|
+
"type": "string"
|
|
220
|
+
},
|
|
221
|
+
{
|
|
222
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
"type": "array",
|
|
226
|
+
"items": {
|
|
227
|
+
"anyOf": [
|
|
228
|
+
{
|
|
229
|
+
"type": "string"
|
|
230
|
+
},
|
|
231
|
+
{
|
|
232
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
233
|
+
}
|
|
234
|
+
]
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
],
|
|
238
|
+
"description": "A graphical representation of the object.\n\nThe value can be a URI or an embedded `Image`/`Link` object.",
|
|
239
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
240
|
+
},
|
|
241
|
+
"icon": {
|
|
242
|
+
"anyOf": [
|
|
243
|
+
{
|
|
244
|
+
"type": "string"
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"type": "array",
|
|
251
|
+
"items": {
|
|
252
|
+
"anyOf": [
|
|
253
|
+
{
|
|
254
|
+
"type": "string"
|
|
255
|
+
},
|
|
256
|
+
{
|
|
257
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
258
|
+
}
|
|
259
|
+
]
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
],
|
|
263
|
+
"description": "An icon for the object.\n\nThe value can be a URI or an embedded `Image`/`Link` object.",
|
|
264
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
265
|
+
},
|
|
266
|
+
"published": {
|
|
267
|
+
"type": "string",
|
|
268
|
+
"description": "Published date-time.",
|
|
269
|
+
"format": "date-time",
|
|
270
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
271
|
+
},
|
|
272
|
+
"updated": {
|
|
273
|
+
"type": "string",
|
|
274
|
+
"description": "Updated date-time.",
|
|
275
|
+
"format": "date-time",
|
|
276
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
277
|
+
},
|
|
278
|
+
"startTime": {
|
|
279
|
+
"type": "string",
|
|
280
|
+
"description": "Start time.",
|
|
281
|
+
"format": "date-time",
|
|
282
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
283
|
+
},
|
|
284
|
+
"endTime": {
|
|
285
|
+
"type": "string",
|
|
286
|
+
"description": "End time.",
|
|
287
|
+
"format": "date-time",
|
|
288
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
289
|
+
},
|
|
290
|
+
"duration": {
|
|
291
|
+
"type": "string",
|
|
292
|
+
"description": "Duration.",
|
|
293
|
+
"format": "duration",
|
|
294
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
295
|
+
},
|
|
296
|
+
"generator": {
|
|
297
|
+
"anyOf": [
|
|
298
|
+
{
|
|
299
|
+
"type": "string"
|
|
300
|
+
},
|
|
301
|
+
{
|
|
302
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
"type": "array",
|
|
306
|
+
"items": {
|
|
307
|
+
"anyOf": [
|
|
308
|
+
{
|
|
309
|
+
"type": "string"
|
|
310
|
+
},
|
|
311
|
+
{
|
|
312
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
313
|
+
}
|
|
314
|
+
]
|
|
315
|
+
}
|
|
316
|
+
}
|
|
317
|
+
],
|
|
318
|
+
"description": "The generator of the Activity.",
|
|
319
|
+
"$comment": "Inherited from ActivityStreamsActivity"
|
|
320
|
+
},
|
|
321
|
+
"attachment": {
|
|
322
|
+
"anyOf": [
|
|
323
|
+
{
|
|
324
|
+
"type": "string"
|
|
325
|
+
},
|
|
326
|
+
{
|
|
327
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
"type": "array",
|
|
331
|
+
"items": {
|
|
332
|
+
"anyOf": [
|
|
333
|
+
{
|
|
334
|
+
"type": "string"
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
338
|
+
}
|
|
339
|
+
]
|
|
340
|
+
}
|
|
341
|
+
}
|
|
342
|
+
],
|
|
343
|
+
"description": "Attachments.",
|
|
344
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
345
|
+
},
|
|
346
|
+
"attributedTo": {
|
|
347
|
+
"anyOf": [
|
|
348
|
+
{
|
|
349
|
+
"type": "string"
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
353
|
+
},
|
|
354
|
+
{
|
|
355
|
+
"type": "array",
|
|
356
|
+
"items": {
|
|
357
|
+
"anyOf": [
|
|
358
|
+
{
|
|
359
|
+
"type": "string"
|
|
360
|
+
},
|
|
361
|
+
{
|
|
362
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
363
|
+
}
|
|
364
|
+
]
|
|
365
|
+
}
|
|
366
|
+
}
|
|
367
|
+
],
|
|
368
|
+
"description": "Objects attributed to.",
|
|
369
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
370
|
+
},
|
|
371
|
+
"audience": {
|
|
372
|
+
"anyOf": [
|
|
373
|
+
{
|
|
374
|
+
"type": "string"
|
|
375
|
+
},
|
|
376
|
+
{
|
|
377
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
"type": "array",
|
|
381
|
+
"items": {
|
|
382
|
+
"anyOf": [
|
|
383
|
+
{
|
|
384
|
+
"type": "string"
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
388
|
+
}
|
|
389
|
+
]
|
|
390
|
+
}
|
|
391
|
+
}
|
|
392
|
+
],
|
|
393
|
+
"description": "Audience.",
|
|
394
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
395
|
+
},
|
|
396
|
+
"context": {
|
|
397
|
+
"anyOf": [
|
|
398
|
+
{
|
|
399
|
+
"type": "string"
|
|
400
|
+
},
|
|
401
|
+
{
|
|
402
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
403
|
+
},
|
|
404
|
+
{
|
|
405
|
+
"type": "array",
|
|
406
|
+
"items": {
|
|
407
|
+
"anyOf": [
|
|
408
|
+
{
|
|
409
|
+
"type": "string"
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
413
|
+
}
|
|
414
|
+
]
|
|
415
|
+
}
|
|
416
|
+
}
|
|
417
|
+
],
|
|
418
|
+
"description": "Context.",
|
|
419
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
420
|
+
},
|
|
421
|
+
"location": {
|
|
422
|
+
"anyOf": [
|
|
423
|
+
{
|
|
424
|
+
"type": "string"
|
|
425
|
+
},
|
|
426
|
+
{
|
|
427
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
428
|
+
},
|
|
429
|
+
{
|
|
430
|
+
"type": "array",
|
|
431
|
+
"items": {
|
|
432
|
+
"anyOf": [
|
|
433
|
+
{
|
|
434
|
+
"type": "string"
|
|
435
|
+
},
|
|
436
|
+
{
|
|
437
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
438
|
+
}
|
|
439
|
+
]
|
|
440
|
+
}
|
|
441
|
+
}
|
|
442
|
+
],
|
|
443
|
+
"description": "Location.",
|
|
444
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
445
|
+
},
|
|
446
|
+
"tag": {
|
|
447
|
+
"anyOf": [
|
|
448
|
+
{
|
|
449
|
+
"type": "string"
|
|
450
|
+
},
|
|
451
|
+
{
|
|
452
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
"type": "array",
|
|
456
|
+
"items": {
|
|
457
|
+
"anyOf": [
|
|
458
|
+
{
|
|
459
|
+
"type": "string"
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
463
|
+
}
|
|
464
|
+
]
|
|
465
|
+
}
|
|
466
|
+
}
|
|
467
|
+
],
|
|
468
|
+
"description": "Tag.",
|
|
469
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
470
|
+
},
|
|
471
|
+
"inReplyTo": {
|
|
472
|
+
"anyOf": [
|
|
473
|
+
{
|
|
474
|
+
"type": "string"
|
|
475
|
+
},
|
|
476
|
+
{
|
|
477
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
478
|
+
},
|
|
479
|
+
{
|
|
480
|
+
"type": "array",
|
|
481
|
+
"items": {
|
|
482
|
+
"anyOf": [
|
|
483
|
+
{
|
|
484
|
+
"type": "string"
|
|
485
|
+
},
|
|
486
|
+
{
|
|
487
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
488
|
+
}
|
|
489
|
+
]
|
|
490
|
+
}
|
|
491
|
+
}
|
|
492
|
+
],
|
|
493
|
+
"description": "In reply to.",
|
|
494
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
495
|
+
},
|
|
496
|
+
"replies": {
|
|
497
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
|
|
498
|
+
"description": "Replies collection.\n\nTypically an embedded `Collection` of Objects that are replies to this object.",
|
|
499
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
500
|
+
},
|
|
501
|
+
"preview": {
|
|
502
|
+
"anyOf": [
|
|
503
|
+
{
|
|
504
|
+
"type": "string"
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
"type": "array",
|
|
511
|
+
"items": {
|
|
512
|
+
"anyOf": [
|
|
513
|
+
{
|
|
514
|
+
"type": "string"
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
518
|
+
}
|
|
519
|
+
]
|
|
520
|
+
}
|
|
521
|
+
}
|
|
522
|
+
],
|
|
523
|
+
"description": "Preview.",
|
|
524
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
525
|
+
},
|
|
526
|
+
"to": {
|
|
527
|
+
"anyOf": [
|
|
528
|
+
{
|
|
529
|
+
"type": "string"
|
|
530
|
+
},
|
|
531
|
+
{
|
|
532
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"type": "array",
|
|
536
|
+
"items": {
|
|
537
|
+
"anyOf": [
|
|
538
|
+
{
|
|
539
|
+
"type": "string"
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
543
|
+
}
|
|
544
|
+
]
|
|
545
|
+
}
|
|
546
|
+
}
|
|
547
|
+
],
|
|
548
|
+
"description": "To.",
|
|
549
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
550
|
+
},
|
|
551
|
+
"bto": {
|
|
552
|
+
"anyOf": [
|
|
553
|
+
{
|
|
554
|
+
"type": "string"
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"type": "array",
|
|
561
|
+
"items": {
|
|
562
|
+
"anyOf": [
|
|
563
|
+
{
|
|
564
|
+
"type": "string"
|
|
565
|
+
},
|
|
566
|
+
{
|
|
567
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
568
|
+
}
|
|
569
|
+
]
|
|
570
|
+
}
|
|
571
|
+
}
|
|
572
|
+
],
|
|
573
|
+
"description": "BTo.",
|
|
574
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
575
|
+
},
|
|
576
|
+
"cc": {
|
|
577
|
+
"anyOf": [
|
|
578
|
+
{
|
|
579
|
+
"type": "string"
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"type": "array",
|
|
586
|
+
"items": {
|
|
587
|
+
"anyOf": [
|
|
588
|
+
{
|
|
589
|
+
"type": "string"
|
|
590
|
+
},
|
|
591
|
+
{
|
|
592
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
593
|
+
}
|
|
594
|
+
]
|
|
595
|
+
}
|
|
596
|
+
}
|
|
597
|
+
],
|
|
598
|
+
"description": "CC.",
|
|
599
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
600
|
+
},
|
|
601
|
+
"bcc": {
|
|
602
|
+
"anyOf": [
|
|
603
|
+
{
|
|
604
|
+
"type": "string"
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
"type": "array",
|
|
611
|
+
"items": {
|
|
612
|
+
"anyOf": [
|
|
613
|
+
{
|
|
614
|
+
"type": "string"
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
618
|
+
}
|
|
619
|
+
]
|
|
620
|
+
}
|
|
621
|
+
}
|
|
622
|
+
],
|
|
623
|
+
"description": "BCC.",
|
|
624
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
625
|
+
},
|
|
626
|
+
"mediaType": {
|
|
627
|
+
"type": "string",
|
|
628
|
+
"description": "MIME media type of the referenced resource.",
|
|
629
|
+
"$comment": "Inherited from ActivityStreamsObject"
|
|
630
|
+
},
|
|
631
|
+
"actor": {
|
|
632
|
+
"anyOf": [
|
|
633
|
+
{
|
|
634
|
+
"type": "string"
|
|
635
|
+
},
|
|
636
|
+
{
|
|
637
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
"type": "array",
|
|
641
|
+
"items": {
|
|
642
|
+
"anyOf": [
|
|
643
|
+
{
|
|
644
|
+
"type": "string"
|
|
645
|
+
},
|
|
646
|
+
{
|
|
647
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
648
|
+
}
|
|
649
|
+
]
|
|
650
|
+
}
|
|
651
|
+
}
|
|
652
|
+
],
|
|
653
|
+
"description": "The Actor behind the Activity.",
|
|
654
|
+
"$comment": "Inherited from ActivityStreamsActivity"
|
|
655
|
+
},
|
|
656
|
+
"result": {
|
|
657
|
+
"anyOf": [
|
|
658
|
+
{
|
|
659
|
+
"type": "string"
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
663
|
+
},
|
|
664
|
+
{
|
|
665
|
+
"type": "array",
|
|
666
|
+
"items": {
|
|
667
|
+
"anyOf": [
|
|
668
|
+
{
|
|
669
|
+
"type": "string"
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
673
|
+
}
|
|
674
|
+
]
|
|
675
|
+
}
|
|
676
|
+
}
|
|
677
|
+
],
|
|
678
|
+
"description": "Result of the Activity.",
|
|
679
|
+
"$comment": "Inherited from ActivityStreamsActivity"
|
|
680
|
+
},
|
|
681
|
+
"origin": {
|
|
682
|
+
"anyOf": [
|
|
683
|
+
{
|
|
684
|
+
"type": "string"
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
688
|
+
},
|
|
689
|
+
{
|
|
690
|
+
"type": "array",
|
|
691
|
+
"items": {
|
|
692
|
+
"anyOf": [
|
|
693
|
+
{
|
|
694
|
+
"type": "string"
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
698
|
+
}
|
|
699
|
+
]
|
|
700
|
+
}
|
|
701
|
+
}
|
|
702
|
+
],
|
|
703
|
+
"description": "Activity's origin.",
|
|
704
|
+
"$comment": "Inherited from ActivityStreamsActivity"
|
|
705
|
+
},
|
|
706
|
+
"instrument": {
|
|
707
|
+
"anyOf": [
|
|
708
|
+
{
|
|
709
|
+
"type": "string"
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
"type": "array",
|
|
716
|
+
"items": {
|
|
717
|
+
"anyOf": [
|
|
718
|
+
{
|
|
719
|
+
"type": "string"
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
723
|
+
}
|
|
724
|
+
]
|
|
725
|
+
}
|
|
726
|
+
}
|
|
727
|
+
],
|
|
728
|
+
"description": "Instrument used in the Activity.",
|
|
729
|
+
"$comment": "Inherited from ActivityStreamsActivity"
|
|
26
730
|
}
|
|
27
731
|
},
|
|
28
732
|
"required": [
|
|
29
|
-
"
|
|
30
|
-
|
|
733
|
+
"@context",
|
|
734
|
+
"type"
|
|
735
|
+
],
|
|
736
|
+
"$comment": "Inlined utility base type ActivityStreamsActivity so utility transformations can operate on concrete properties instead of a $ref."
|
|
31
737
|
}
|
|
32
738
|
]
|
|
33
739
|
}
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.22](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.21...dataspace-models-v0.0.3-next.22) (2026-03-20)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Miscellaneous Chores
|
|
7
|
+
|
|
8
|
+
* **dataspace-models:** Synchronize repo versions
|
|
9
|
+
|
|
10
|
+
## [0.0.3-next.21](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.20...dataspace-models-v0.0.3-next.21) (2026-03-17)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* improve open-api examples ([1368dbe](https://github.com/twinfoundation/dataspace/commit/1368dbed5c36e074b4854942304a19b9ce51e088))
|
|
16
|
+
|
|
3
17
|
## [0.0.3-next.20](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.19...dataspace-models-v0.0.3-next.20) (2026-03-17)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -76,7 +76,7 @@ Offer ID from the original Catalog offer.
|
|
|
76
76
|
|
|
77
77
|
### consumerIdentity? {#consumeridentity}
|
|
78
78
|
|
|
79
|
-
> `optional` **consumerIdentity
|
|
79
|
+
> `optional` **consumerIdentity?**: `string`
|
|
80
80
|
|
|
81
81
|
Consumer identity (DID or URI).
|
|
82
82
|
|
|
@@ -84,7 +84,7 @@ Consumer identity (DID or URI).
|
|
|
84
84
|
|
|
85
85
|
### providerIdentity? {#provideridentity}
|
|
86
86
|
|
|
87
|
-
> `optional` **providerIdentity
|
|
87
|
+
> `optional` **providerIdentity?**: `string`
|
|
88
88
|
|
|
89
89
|
Provider identity (DID or URI).
|
|
90
90
|
|
|
@@ -92,7 +92,7 @@ Provider identity (DID or URI).
|
|
|
92
92
|
|
|
93
93
|
### format? {#format}
|
|
94
94
|
|
|
95
|
-
> `optional` **format
|
|
95
|
+
> `optional` **format?**: `string`
|
|
96
96
|
|
|
97
97
|
Data format from the Dataset Distribution.
|
|
98
98
|
|
|
@@ -100,7 +100,7 @@ Data format from the Dataset Distribution.
|
|
|
100
100
|
|
|
101
101
|
### callbackAddress? {#callbackaddress}
|
|
102
102
|
|
|
103
|
-
> `optional` **callbackAddress
|
|
103
|
+
> `optional` **callbackAddress?**: `string`
|
|
104
104
|
|
|
105
105
|
Callback address for Consumer notifications.
|
|
106
106
|
|
|
@@ -124,7 +124,7 @@ Last update timestamp (ISO string format).
|
|
|
124
124
|
|
|
125
125
|
### policies? {#policies}
|
|
126
126
|
|
|
127
|
-
> `optional` **policies
|
|
127
|
+
> `optional` **policies?**: `IDataspaceProtocolPolicy`[]
|
|
128
128
|
|
|
129
129
|
Policies from the Agreement (stored as JSON).
|
|
130
130
|
|
|
@@ -132,6 +132,6 @@ Policies from the Agreement (stored as JSON).
|
|
|
132
132
|
|
|
133
133
|
### dataAddress? {#dataaddress}
|
|
134
134
|
|
|
135
|
-
> `optional` **dataAddress
|
|
135
|
+
> `optional` **dataAddress?**: `IDataspaceProtocolDataAddress`
|
|
136
136
|
|
|
137
137
|
Data address for push mode transfers (stored as JSON).
|
|
@@ -18,7 +18,7 @@ The Id of the Activity Log entry.
|
|
|
18
18
|
|
|
19
19
|
### activityId? {#activityid}
|
|
20
20
|
|
|
21
|
-
> `optional` **activityId
|
|
21
|
+
> `optional` **activityId?**: `string`
|
|
22
22
|
|
|
23
23
|
The activity Id that this entry refers to.
|
|
24
24
|
|
|
@@ -50,6 +50,6 @@ The last update date of this object.
|
|
|
50
50
|
|
|
51
51
|
### retryCount? {#retrycount}
|
|
52
52
|
|
|
53
|
-
> `optional` **retryCount
|
|
53
|
+
> `optional` **retryCount?**: `number`
|
|
54
54
|
|
|
55
55
|
Number of times this activity has been retried.
|
|
@@ -22,7 +22,7 @@ The Id of the Activity Log entry.
|
|
|
22
22
|
|
|
23
23
|
### activityId? {#activityid}
|
|
24
24
|
|
|
25
|
-
> `optional` **activityId
|
|
25
|
+
> `optional` **activityId?**: `string`
|
|
26
26
|
|
|
27
27
|
The activity Id that this entry refers to.
|
|
28
28
|
|
|
@@ -70,7 +70,7 @@ The last update date of this object.
|
|
|
70
70
|
|
|
71
71
|
### retryCount? {#retrycount}
|
|
72
72
|
|
|
73
|
-
> `optional` **retryCount
|
|
73
|
+
> `optional` **retryCount?**: `number`
|
|
74
74
|
|
|
75
75
|
Number of times this activity has been retried.
|
|
76
76
|
|
|
@@ -90,7 +90,7 @@ Status of the Activity Processing.
|
|
|
90
90
|
|
|
91
91
|
### pendingTasks? {#pendingtasks}
|
|
92
92
|
|
|
93
|
-
> `optional` **pendingTasks
|
|
93
|
+
> `optional` **pendingTasks?**: [`ITaskApp`](ITaskApp.md)[]
|
|
94
94
|
|
|
95
95
|
The pending tasks that have to be run to process the Activity.
|
|
96
96
|
|
|
@@ -98,7 +98,7 @@ The pending tasks that have to be run to process the Activity.
|
|
|
98
98
|
|
|
99
99
|
### runningTasks? {#runningtasks}
|
|
100
100
|
|
|
101
|
-
> `optional` **runningTasks
|
|
101
|
+
> `optional` **runningTasks?**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md)[]
|
|
102
102
|
|
|
103
103
|
The running tasks that are processing the Activity.
|
|
104
104
|
|
|
@@ -106,7 +106,7 @@ The running tasks that are processing the Activity.
|
|
|
106
106
|
|
|
107
107
|
### finalizedTasks? {#finalizedtasks}
|
|
108
108
|
|
|
109
|
-
> `optional` **finalizedTasks
|
|
109
|
+
> `optional` **finalizedTasks?**: [`ITaskApp`](ITaskApp.md) & [`IActivityLogDates`](IActivityLogDates.md) & `object`[]
|
|
110
110
|
|
|
111
111
|
The tasks that have already finalized.
|
|
112
112
|
|
|
@@ -114,6 +114,6 @@ The tasks that have already finalized.
|
|
|
114
114
|
|
|
115
115
|
### inErrorTasks? {#inerrortasks}
|
|
116
116
|
|
|
117
|
-
> `optional` **inErrorTasks
|
|
117
|
+
> `optional` **inErrorTasks?**: [`ITaskApp`](ITaskApp.md) & `object`[]
|
|
118
118
|
|
|
119
119
|
The tasks that are in error.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
### activityType? {#activitytype}
|
|
8
8
|
|
|
9
|
-
> `optional` **activityType
|
|
9
|
+
> `optional` **activityType?**: `string`
|
|
10
10
|
|
|
11
11
|
FQN of the Activity type.
|
|
12
12
|
|
|
@@ -22,6 +22,6 @@ FQN of the Object Type.
|
|
|
22
22
|
|
|
23
23
|
### targetType? {#targettype}
|
|
24
24
|
|
|
25
|
-
> `optional` **targetType
|
|
25
|
+
> `optional` **targetType?**: `string`
|
|
26
26
|
|
|
27
27
|
FQN of the target type.
|
|
@@ -6,13 +6,13 @@ Response containing data asset entities with optional pagination Link header.
|
|
|
6
6
|
|
|
7
7
|
### headers? {#headers}
|
|
8
8
|
|
|
9
|
-
> `optional` **headers
|
|
9
|
+
> `optional` **headers?**: `object`
|
|
10
10
|
|
|
11
11
|
Optional headers.
|
|
12
12
|
|
|
13
13
|
#### link?
|
|
14
14
|
|
|
15
|
-
> `optional` **link
|
|
15
|
+
> `optional` **link?**: `string` \| `string`[]
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
@@ -6,13 +6,13 @@ Get Request Data Asset Entities
|
|
|
6
6
|
|
|
7
7
|
### headers? {#headers}
|
|
8
8
|
|
|
9
|
-
> `optional` **headers
|
|
9
|
+
> `optional` **headers?**: `object`
|
|
10
10
|
|
|
11
11
|
The headers which can be used to determine the response data type.
|
|
12
12
|
|
|
13
13
|
#### authorization?
|
|
14
14
|
|
|
15
|
-
> `optional` **authorization
|
|
15
|
+
> `optional` **authorization?**: `string`
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
@@ -24,7 +24,7 @@ The parameters from the query.
|
|
|
24
24
|
|
|
25
25
|
#### id?
|
|
26
26
|
|
|
27
|
-
> `optional` **id
|
|
27
|
+
> `optional` **id?**: `string`
|
|
28
28
|
|
|
29
29
|
The ID of the entity(ies) to get. (comma separated list)
|
|
30
30
|
|
|
@@ -44,18 +44,18 @@ The datasetId is resolved from the Transfer Process using this ID.
|
|
|
44
44
|
|
|
45
45
|
#### dataServiceId?
|
|
46
46
|
|
|
47
|
-
> `optional` **dataServiceId
|
|
47
|
+
> `optional` **dataServiceId?**: `string`
|
|
48
48
|
|
|
49
49
|
The Id of the data service that offers the data asset
|
|
50
50
|
|
|
51
51
|
#### limit?
|
|
52
52
|
|
|
53
|
-
> `optional` **limit
|
|
53
|
+
> `optional` **limit?**: `string`
|
|
54
54
|
|
|
55
55
|
The maximum number of entities to retrieve.
|
|
56
56
|
|
|
57
57
|
#### cursor?
|
|
58
58
|
|
|
59
|
-
> `optional` **cursor
|
|
59
|
+
> `optional` **cursor?**: `string`
|
|
60
60
|
|
|
61
61
|
Cursor to control pagination.
|
|
@@ -6,13 +6,13 @@ Request to query data asset entities.
|
|
|
6
6
|
|
|
7
7
|
### headers? {#headers}
|
|
8
8
|
|
|
9
|
-
> `optional` **headers
|
|
9
|
+
> `optional` **headers?**: `object`
|
|
10
10
|
|
|
11
11
|
The headers which can be used to determine the response data type.
|
|
12
12
|
|
|
13
13
|
#### authorization?
|
|
14
14
|
|
|
15
|
-
> `optional` **authorization
|
|
15
|
+
> `optional` **authorization?**: `string`
|
|
16
16
|
|
|
17
17
|
***
|
|
18
18
|
|
|
@@ -40,19 +40,19 @@ The filtering query.
|
|
|
40
40
|
|
|
41
41
|
### query? {#query}
|
|
42
42
|
|
|
43
|
-
> `optional` **query
|
|
43
|
+
> `optional` **query?**: `object`
|
|
44
44
|
|
|
45
45
|
Optional query parameters for pagination.
|
|
46
46
|
Used when following Link header URLs.
|
|
47
47
|
|
|
48
48
|
#### cursor?
|
|
49
49
|
|
|
50
|
-
> `optional` **cursor
|
|
50
|
+
> `optional` **cursor?**: `string`
|
|
51
51
|
|
|
52
52
|
Opaque cursor token for pagination.
|
|
53
53
|
|
|
54
54
|
#### limit?
|
|
55
55
|
|
|
56
|
-
> `optional` **limit
|
|
56
|
+
> `optional` **limit?**: `string`
|
|
57
57
|
|
|
58
58
|
Maximum number of items to return.
|
|
@@ -168,15 +168,15 @@ Supports optional filtering by state and pagination via cursor.
|
|
|
168
168
|
|
|
169
169
|
##### state
|
|
170
170
|
|
|
171
|
-
|
|
171
|
+
`string` \| `undefined`
|
|
172
172
|
|
|
173
|
-
|
|
173
|
+
Optional filter by negotiation state (e.g., "FINALIZED", "TERMINATED").
|
|
174
174
|
|
|
175
175
|
##### cursor
|
|
176
176
|
|
|
177
|
-
|
|
177
|
+
`string` \| `undefined`
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Optional pagination cursor for fetching next page.
|
|
180
180
|
|
|
181
181
|
##### trustPayload
|
|
182
182
|
|
|
@@ -22,6 +22,6 @@ The representation of the query.
|
|
|
22
22
|
|
|
23
23
|
### jsonLdContext? {#jsonldcontext}
|
|
24
24
|
|
|
25
|
-
> `optional` **jsonLdContext
|
|
25
|
+
> `optional` **jsonLdContext?**: `IJsonLdContextDefinitionElement`[]
|
|
26
26
|
|
|
27
27
|
The JSON-LD context to be applied over the query terms.
|
|
@@ -60,7 +60,7 @@ DSC should only allow queries if state is STARTED.
|
|
|
60
60
|
|
|
61
61
|
### consumerIdentity? {#consumeridentity}
|
|
62
62
|
|
|
63
|
-
> `optional` **consumerIdentity
|
|
63
|
+
> `optional` **consumerIdentity?**: `string`
|
|
64
64
|
|
|
65
65
|
Consumer identity (for auditing).
|
|
66
66
|
|
|
@@ -68,7 +68,7 @@ Consumer identity (for auditing).
|
|
|
68
68
|
|
|
69
69
|
### providerIdentity? {#provideridentity}
|
|
70
70
|
|
|
71
|
-
> `optional` **providerIdentity
|
|
71
|
+
> `optional` **providerIdentity?**: `string`
|
|
72
72
|
|
|
73
73
|
Provider identity (for auditing).
|
|
74
74
|
Extracted from Agreement's assigner field.
|
|
@@ -77,7 +77,7 @@ Extracted from Agreement's assigner field.
|
|
|
77
77
|
|
|
78
78
|
### dataAddress? {#dataaddress}
|
|
79
79
|
|
|
80
|
-
> `optional` **dataAddress
|
|
80
|
+
> `optional` **dataAddress?**: `IDataspaceProtocolDataAddress`
|
|
81
81
|
|
|
82
82
|
Data address for push mode transfers.
|
|
83
83
|
Contains endpoint information where data should be pushed (for Activity Stream push mode).
|
|
@@ -69,7 +69,7 @@ Offer ID from the original Catalog offer.
|
|
|
69
69
|
|
|
70
70
|
### policies? {#policies}
|
|
71
71
|
|
|
72
|
-
> `optional` **policies
|
|
72
|
+
> `optional` **policies?**: `IDataspaceProtocolPolicy`[]
|
|
73
73
|
|
|
74
74
|
Policies from the Agreement.
|
|
75
75
|
Used by DSC for runtime policy enforcement.
|
|
@@ -78,7 +78,7 @@ Used by DSC for runtime policy enforcement.
|
|
|
78
78
|
|
|
79
79
|
### consumerIdentity? {#consumeridentity}
|
|
80
80
|
|
|
81
|
-
> `optional` **consumerIdentity
|
|
81
|
+
> `optional` **consumerIdentity?**: `string`
|
|
82
82
|
|
|
83
83
|
Consumer identity (DID or URI).
|
|
84
84
|
Used for auditing and access control.
|
|
@@ -87,7 +87,7 @@ Used for auditing and access control.
|
|
|
87
87
|
|
|
88
88
|
### providerIdentity? {#provideridentity}
|
|
89
89
|
|
|
90
|
-
> `optional` **providerIdentity
|
|
90
|
+
> `optional` **providerIdentity?**: `string`
|
|
91
91
|
|
|
92
92
|
Provider identity (DID or URI).
|
|
93
93
|
Used for auditing.
|
|
@@ -96,7 +96,7 @@ Used for auditing.
|
|
|
96
96
|
|
|
97
97
|
### callbackAddress? {#callbackaddress}
|
|
98
98
|
|
|
99
|
-
> `optional` **callbackAddress
|
|
99
|
+
> `optional` **callbackAddress?**: `string`
|
|
100
100
|
|
|
101
101
|
Callback address for Consumer notifications.
|
|
102
102
|
URI where messages to the Consumer should be sent.
|
|
@@ -105,7 +105,7 @@ URI where messages to the Consumer should be sent.
|
|
|
105
105
|
|
|
106
106
|
### format? {#format}
|
|
107
107
|
|
|
108
|
-
> `optional` **format
|
|
108
|
+
> `optional` **format?**: `string`
|
|
109
109
|
|
|
110
110
|
Data format from the Dataset Distribution.
|
|
111
111
|
Specified by a Distribution for the Dataset associated with the Agreement.
|
|
@@ -114,7 +114,7 @@ Specified by a Distribution for the Dataset associated with the Agreement.
|
|
|
114
114
|
|
|
115
115
|
### dataAddress? {#dataaddress}
|
|
116
116
|
|
|
117
|
-
> `optional` **dataAddress
|
|
117
|
+
> `optional` **dataAddress?**: `IDataspaceProtocolDataAddress`
|
|
118
118
|
|
|
119
119
|
Data address for push mode transfers.
|
|
120
120
|
Contains endpoint information where data should be pushed (for Activity Stream push mode).
|
package/package.json
CHANGED