@twin.org/node 0.0.3-next.28 → 0.0.3-next.30

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.
Files changed (4) hide show
  1. package/dist/locales/en.json +19 -7
  2. package/docs/changelog.md +28 -0
  3. package/docs/open-api/spec.json +1109 -1347
  4. package/package.json +2 -2
package/docs/open-api/spec.json CHANGED
@@ -196,7 +196,7 @@
196
196
  "content": {
197
197
  "image/x-icon": {
198
198
  "schema": {
199
- "$ref": "#/components/schemas/Uint8Array"
199
+ "$ref": "#/components/schemas/ServerFavIconResponse"
200
200
  }
201
201
  }
202
202
  }
@@ -960,7 +960,7 @@
960
960
  "content": {
961
961
  "application/json": {
962
962
  "schema": {
963
- "$ref": "#/components/schemas/AuthenticationUser"
963
+ "$ref": "#/components/schemas/AdminUserCreateRequest"
964
964
  },
965
965
  "examples": {
966
966
  "createUserRequestExample": {
@@ -1075,7 +1075,7 @@
1075
1075
  "content": {
1076
1076
  "application/json": {
1077
1077
  "schema": {
1078
- "$ref": "#/components/schemas/Partial<AuthenticationUser"
1078
+ "$ref": "#/components/schemas/AdminUserUpdateRequest"
1079
1079
  },
1080
1080
  "examples": {
1081
1081
  "updateUserRequestExample": {
@@ -1186,7 +1186,7 @@
1186
1186
  "content": {
1187
1187
  "application/json": {
1188
1188
  "schema": {
1189
- "$ref": "#/components/schemas/AuthenticationUser"
1189
+ "$ref": "#/components/schemas/AdminUserGetResponse"
1190
1190
  },
1191
1191
  "examples": {
1192
1192
  "getUserResponseExample": {
@@ -1491,7 +1491,7 @@
1491
1491
  "content": {
1492
1492
  "application/json": {
1493
1493
  "schema": {
1494
- "$ref": "#/components/schemas/AuthenticationUser"
1494
+ "$ref": "#/components/schemas/AdminUserGetResponse"
1495
1495
  },
1496
1496
  "examples": {
1497
1497
  "getUserResponseExample": {
@@ -3503,7 +3503,7 @@
3503
3503
  "content": {
3504
3504
  "application/json": {
3505
3505
  "schema": {
3506
- "$ref": "#/components/schemas/ConflictResponse"
3506
+ "$ref": "#/components/schemas/Error"
3507
3507
  },
3508
3508
  "examples": {
3509
3509
  "exampleResponse": {
@@ -3933,7 +3933,7 @@
3933
3933
  "content": {
3934
3934
  "application/ld+json": {
3935
3935
  "schema": {
3936
- "$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
3936
+ "$ref": "#/components/schemas/IdentityProfileGetPublicResponse"
3937
3937
  },
3938
3938
  "examples": {
3939
3939
  "identityGetPublicResponseExample": {
@@ -4286,7 +4286,6 @@
4286
4286
  "in": "query",
4287
4287
  "required": false,
4288
4288
  "schema": {
4289
- "type": "string",
4290
4289
  "enum": [
4291
4290
  "dateCreated",
4292
4291
  "dateModified"
@@ -9604,6 +9603,11 @@
9604
9603
  "examples": {
9605
9604
  "auditableItemGraphCreateRequestExample": {
9606
9605
  "value": {
9606
+ "@context": [
9607
+ "https://schema.twindev.org/aig/",
9608
+ "https://schema.twindev.org/common/"
9609
+ ],
9610
+ "type": "AuditableItemGraphVertex",
9607
9611
  "annotationObject": {
9608
9612
  "@context": "https://schema.org",
9609
9613
  "@type": "Note",
@@ -9611,6 +9615,7 @@
9611
9615
  },
9612
9616
  "aliases": [
9613
9617
  {
9618
+ "type": "AuditableItemGraphAlias",
9614
9619
  "id": "bar456",
9615
9620
  "annotationObject": {
9616
9621
  "@context": "https://schema.org",
@@ -9619,6 +9624,7 @@
9619
9624
  }
9620
9625
  },
9621
9626
  {
9627
+ "type": "AuditableItemGraphAlias",
9622
9628
  "id": "foo321",
9623
9629
  "annotationObject": {
9624
9630
  "@context": "https://schema.org",
@@ -9629,6 +9635,7 @@
9629
9635
  ],
9630
9636
  "resources": [
9631
9637
  {
9638
+ "type": "AuditableItemGraphResource",
9632
9639
  "id": "resource1",
9633
9640
  "resourceObject": {
9634
9641
  "@context": "https://schema.org",
@@ -9637,6 +9644,7 @@
9637
9644
  }
9638
9645
  },
9639
9646
  {
9647
+ "type": "AuditableItemGraphResource",
9640
9648
  "id": "resource2",
9641
9649
  "resourceObject": {
9642
9650
  "@context": "https://schema.org",
@@ -9647,6 +9655,7 @@
9647
9655
  ],
9648
9656
  "edges": [
9649
9657
  {
9658
+ "type": "AuditableItemGraphEdge",
9650
9659
  "targetId": "aig:1234567890",
9651
9660
  "edgeRelationships": [
9652
9661
  "frenemy"
@@ -9658,6 +9667,7 @@
9658
9667
  }
9659
9668
  },
9660
9669
  {
9670
+ "type": "AuditableItemGraphEdge",
9661
9671
  "targetId": "aig:45678901234",
9662
9672
  "edgeRelationships": [
9663
9673
  "end"
@@ -9768,11 +9778,16 @@
9768
9778
  "in": "query",
9769
9779
  "required": false,
9770
9780
  "schema": {
9771
- "type": "string",
9772
- "enum": [
9773
- "id",
9774
- "alias",
9775
- "both"
9781
+ "anyOf": [
9782
+ {
9783
+ "const": "id"
9784
+ },
9785
+ {
9786
+ "const": "alias"
9787
+ },
9788
+ {
9789
+ "const": "both"
9790
+ }
9776
9791
  ]
9777
9792
  }
9778
9793
  },
@@ -9809,7 +9824,6 @@
9809
9824
  "in": "query",
9810
9825
  "required": false,
9811
9826
  "schema": {
9812
- "type": "string",
9813
9827
  "enum": [
9814
9828
  "dateCreated",
9815
9829
  "dateModified"
@@ -10264,6 +10278,11 @@
10264
10278
  "examples": {
10265
10279
  "auditableItemGraphUpdateRequestExample": {
10266
10280
  "value": {
10281
+ "@context": [
10282
+ "https://schema.twindev.org/aig/",
10283
+ "https://schema.twindev.org/common/"
10284
+ ],
10285
+ "type": "AuditableItemGraphVertex",
10267
10286
  "annotationObject": {
10268
10287
  "@context": "https://schema.org",
10269
10288
  "@type": "Note",
@@ -10271,6 +10290,7 @@
10271
10290
  },
10272
10291
  "aliases": [
10273
10292
  {
10293
+ "type": "AuditableItemGraphAlias",
10274
10294
  "id": "bar456",
10275
10295
  "annotationObject": {
10276
10296
  "@context": "https://schema.org",
@@ -10279,6 +10299,7 @@
10279
10299
  }
10280
10300
  },
10281
10301
  {
10302
+ "type": "AuditableItemGraphAlias",
10282
10303
  "id": "foo321",
10283
10304
  "annotationObject": {
10284
10305
  "@context": "https://schema.org",
@@ -10289,6 +10310,7 @@
10289
10310
  ],
10290
10311
  "resources": [
10291
10312
  {
10313
+ "type": "AuditableItemGraphResource",
10292
10314
  "id": "resource1",
10293
10315
  "resourceObject": {
10294
10316
  "@context": "https://schema.org",
@@ -10297,6 +10319,7 @@
10297
10319
  }
10298
10320
  },
10299
10321
  {
10322
+ "type": "AuditableItemGraphResource",
10300
10323
  "id": "resource2",
10301
10324
  "resourceObject": {
10302
10325
  "@context": "https://schema.org",
@@ -10307,6 +10330,7 @@
10307
10330
  ],
10308
10331
  "edges": [
10309
10332
  {
10333
+ "type": "AuditableItemGraphEdge",
10310
10334
  "id": "edge1",
10311
10335
  "targetId": "aig:1234567890",
10312
10336
  "edgeRelationships": [
@@ -10319,6 +10343,7 @@
10319
10343
  }
10320
10344
  },
10321
10345
  {
10346
+ "type": "AuditableItemGraphEdge",
10322
10347
  "id": "edge2",
10323
10348
  "targetId": "aig:45678901234",
10324
10349
  "edgeRelationships": [
@@ -10940,26 +10965,36 @@
10940
10965
  "content": {
10941
10966
  "application/json": {
10942
10967
  "schema": {
10943
- "$ref": "#/components/schemas/AuditableItemStreamCreateRequest"
10968
+ "$ref": "https://schema.twindev.org/ais/AuditableItemStreamBase"
10944
10969
  },
10945
10970
  "examples": {
10946
10971
  "auditableItemStreamCreateRequestExample": {
10947
10972
  "value": {
10973
+ "@context": [
10974
+ "https://schema.org",
10975
+ "https://schema.twindev.org/ais/",
10976
+ "https://schema.twindev.org/common/"
10977
+ ],
10978
+ "type": "AuditableItemStream",
10948
10979
  "annotationObject": {
10949
10980
  "@context": "https://schema.org",
10950
10981
  "@type": "Note",
10951
10982
  "content": "This is a simple note"
10952
10983
  },
10953
- "entries": [
10954
- {
10955
- "entryObject": {
10956
- "@context": "https://schema.org",
10957
- "@type": "Event",
10958
- "startDate": "2011-04-09T20:00:00Z",
10959
- "description": "A description of the event"
10984
+ "entries": {
10985
+ "type": "ItemList",
10986
+ "itemListElement": [
10987
+ {
10988
+ "type": "AuditableItemStreamEntry",
10989
+ "entryObject": {
10990
+ "@context": "https://schema.org",
10991
+ "@type": "Event",
10992
+ "startDate": "2011-04-09T20:00:00Z",
10993
+ "description": "A description of the event"
10994
+ }
10960
10995
  }
10961
- }
10962
- ]
10996
+ ]
10997
+ }
10963
10998
  }
10964
10999
  }
10965
11000
  }
@@ -11059,7 +11094,6 @@
11059
11094
  "in": "query",
11060
11095
  "required": false,
11061
11096
  "schema": {
11062
- "type": "string",
11063
11097
  "enum": [
11064
11098
  "dateCreated",
11065
11099
  "dateModified"
@@ -11140,6 +11174,7 @@
11140
11174
  "itemListElement": [
11141
11175
  {
11142
11176
  "@context": [
11177
+ "https://schema.org",
11143
11178
  "https://schema.twindev.org/ais/",
11144
11179
  "https://schema.twindev.org/common/"
11145
11180
  ],
@@ -11181,6 +11216,7 @@
11181
11216
  "itemListElement": [
11182
11217
  {
11183
11218
  "@context": [
11219
+ "https://schema.org",
11184
11220
  "https://schema.twindev.org/ais/",
11185
11221
  "https://schema.twindev.org/common/"
11186
11222
  ],
@@ -11313,9 +11349,27 @@
11313
11349
  "style": "simple",
11314
11350
  "example": "ais:1234567890"
11315
11351
  },
11352
+ {
11353
+ "name": "cursor",
11354
+ "description": "Cursor to use for next chunk of entries.",
11355
+ "in": "query",
11356
+ "required": false,
11357
+ "schema": {
11358
+ "type": "string"
11359
+ }
11360
+ },
11361
+ {
11362
+ "name": "limit",
11363
+ "description": "Limit the number of entries to return, only applicable if includeEntries is true.",
11364
+ "in": "query",
11365
+ "required": false,
11366
+ "schema": {
11367
+ "type": "string"
11368
+ }
11369
+ },
11316
11370
  {
11317
11371
  "name": "includeEntries",
11318
- "description": "Whether to include the entries, defaults to false. The entries will be limited to the first page of entries in date descending order. If you want to get more entries you can use the returned cursor with the get entries method.",
11372
+ "description": "Whether to include the entries, defaults to false.\nThe entries will be limited to the first page of entries in date descending order.\nIf you want to get more entries you can use the returned cursor with the get entries method.",
11319
11373
  "in": "query",
11320
11374
  "required": false,
11321
11375
  "schema": {
@@ -11377,6 +11431,7 @@
11377
11431
  "auditableItemStreamGetResponseExample": {
11378
11432
  "value": {
11379
11433
  "@context": [
11434
+ "https://schema.org",
11380
11435
  "https://schema.twindev.org/ais/",
11381
11436
  "https://schema.twindev.org/common/"
11382
11437
  ],
@@ -11393,25 +11448,28 @@
11393
11448
  "proofId": "0101010101010101010101010101010101010101010101010101010101010101",
11394
11449
  "immutableInterval": 10,
11395
11450
  "numberOfItems": 1,
11396
- "entries": [
11397
- {
11398
- "@context": [
11399
- "https://schema.twindev.org/ais/",
11400
- "https://schema.twindev.org/common/"
11401
- ],
11402
- "type": "AuditableItemStreamEntry",
11403
- "id": "tst:1234567890",
11404
- "dateCreated": "2024-08-22T11:55:16.271Z",
11405
- "proofId": "0101010101010101010101010101010101010101010101010101010101010101",
11406
- "index": 0,
11407
- "entryObject": {
11408
- "@context": "https://schema.org",
11409
- "@type": "Event",
11410
- "startDate": "2011-04-09T20:00:00Z",
11411
- "description": "A description of the event"
11451
+ "entries": {
11452
+ "type": "ItemList",
11453
+ "itemListElement": [
11454
+ {
11455
+ "@context": [
11456
+ "https://schema.twindev.org/ais/",
11457
+ "https://schema.twindev.org/common/"
11458
+ ],
11459
+ "type": "AuditableItemStreamEntry",
11460
+ "id": "tst:1234567890",
11461
+ "dateCreated": "2024-08-22T11:55:16.271Z",
11462
+ "proofId": "0101010101010101010101010101010101010101010101010101010101010101",
11463
+ "index": 0,
11464
+ "entryObject": {
11465
+ "@context": "https://schema.org",
11466
+ "@type": "Event",
11467
+ "startDate": "2011-04-09T20:00:00Z",
11468
+ "description": "A description of the event"
11469
+ }
11412
11470
  }
11413
- }
11414
- ]
11471
+ ]
11472
+ }
11415
11473
  }
11416
11474
  }
11417
11475
  }
@@ -11424,6 +11482,7 @@
11424
11482
  "auditableItemStreamJsonLdGetResponseExample": {
11425
11483
  "value": {
11426
11484
  "@context": [
11485
+ "https://schema.org",
11427
11486
  "https://schema.twindev.org/ais/",
11428
11487
  "https://schema.twindev.org/common/"
11429
11488
  ],
@@ -11440,25 +11499,28 @@
11440
11499
  "proofId": "0101010101010101010101010101010101010101010101010101010101010101",
11441
11500
  "immutableInterval": 10,
11442
11501
  "numberOfItems": 1,
11443
- "entries": [
11444
- {
11445
- "@context": [
11446
- "https://schema.twindev.org/ais/",
11447
- "https://schema.twindev.org/common/"
11448
- ],
11449
- "type": "AuditableItemStreamEntry",
11450
- "id": "tst:1234567890",
11451
- "dateCreated": "2024-08-22T11:55:16.271Z",
11452
- "proofId": "0101010101010101010101010101010101010101010101010101010101010101",
11453
- "index": 0,
11454
- "entryObject": {
11455
- "@context": "https://schema.org",
11456
- "@type": "Event",
11457
- "startDate": "2011-04-09T20:00:00Z",
11458
- "description": "A description of the event"
11502
+ "entries": {
11503
+ "type": "ItemList",
11504
+ "itemListElement": [
11505
+ {
11506
+ "@context": [
11507
+ "https://schema.twindev.org/ais/",
11508
+ "https://schema.twindev.org/common/"
11509
+ ],
11510
+ "type": "AuditableItemStreamEntry",
11511
+ "id": "tst:1234567890",
11512
+ "dateCreated": "2024-08-22T11:55:16.271Z",
11513
+ "proofId": "0101010101010101010101010101010101010101010101010101010101010101",
11514
+ "index": 0,
11515
+ "entryObject": {
11516
+ "@context": "https://schema.org",
11517
+ "@type": "Event",
11518
+ "startDate": "2011-04-09T20:00:00Z",
11519
+ "description": "A description of the event"
11520
+ }
11459
11521
  }
11460
- }
11461
- ]
11522
+ ]
11523
+ }
11462
11524
  }
11463
11525
  }
11464
11526
  }
@@ -11588,6 +11650,12 @@
11588
11650
  "examples": {
11589
11651
  "auditableItemStreamUpdateRequestExample": {
11590
11652
  "value": {
11653
+ "@context": [
11654
+ "https://schema.org",
11655
+ "https://schema.twindev.org/ais/",
11656
+ "https://schema.twindev.org/common/"
11657
+ ],
11658
+ "type": "AuditableItemStream",
11591
11659
  "annotationObject": {
11592
11660
  "@context": "https://schema.org",
11593
11661
  "@type": "Note",
@@ -13668,7 +13736,7 @@
13668
13736
  },
13669
13737
  "responses": {
13670
13738
  "200": {
13671
- "description": "The response payload for the catalog request method. Returns a DS Protocol compliant Catalog with participantId, or CatalogError if no datasets found.",
13739
+ "description": "The response payload for the catalog request method.\nReturns a DS Protocol compliant Catalog with participantId, or CatalogError if no datasets found.",
13672
13740
  "content": {
13673
13741
  "application/json": {
13674
13742
  "schema": {
@@ -13689,21 +13757,25 @@
13689
13757
  "@type": "Dataset",
13690
13758
  "dcterms:title": "Energy Consumption Data",
13691
13759
  "dcterms:description": "Historical energy consumption data",
13692
- "hasPolicy": {
13693
- "@id": "urn:uuid:policy-456",
13694
- "@type": "Offer",
13695
- "assigner": "did:example:data-provider-789"
13696
- },
13697
- "distribution": {
13698
- "@id": "urn:uuid:distribution-789",
13699
- "@type": "Distribution",
13700
- "format": "application/json",
13701
- "accessService": {
13702
- "@id": "urn:uuid:access-service-321",
13703
- "@type": "DataService",
13704
- "endpointURL": "https://example.com/data-access"
13760
+ "hasPolicy": [
13761
+ {
13762
+ "@id": "urn:uuid:policy-456",
13763
+ "@type": "Offer",
13764
+ "assigner": "did:example:data-provider-789"
13705
13765
  }
13706
- }
13766
+ ],
13767
+ "distribution": [
13768
+ {
13769
+ "@id": "urn:uuid:distribution-789",
13770
+ "@type": "Distribution",
13771
+ "format": "application/json",
13772
+ "accessService": {
13773
+ "@id": "urn:uuid:access-service-321",
13774
+ "@type": "DataService",
13775
+ "endpointURL": "https://example.com/data-access"
13776
+ }
13777
+ }
13778
+ ]
13707
13779
  }
13708
13780
  ]
13709
13781
  }
@@ -13897,10 +13969,10 @@
13897
13969
  "content": {
13898
13970
  "application/ld+json": {
13899
13971
  "schema": {
13900
- "$ref": "#/components/schemas/ActivityStreamsActivity"
13972
+ "$ref": "https://schema.twindev.org/w3c-activity-streams/ActivityStreamsActivity"
13901
13973
  },
13902
13974
  "examples": {
13903
- "activityStreamNotifyExample": {
13975
+ "activityStreamNotifyRequestExample": {
13904
13976
  "value": {
13905
13977
  "@context": "https://www.w3.org/ns/activitystreams",
13906
13978
  "type": "Add",
@@ -14035,7 +14107,7 @@
14035
14107
  "$ref": "#/components/schemas/ActivityLogEntry"
14036
14108
  },
14037
14109
  "examples": {
14038
- "activityLogEntryResponseExample": {
14110
+ "activityLogEntryGetResponseExample": {
14039
14111
  "value": {
14040
14112
  "id": "urn:x-activity-log:134567",
14041
14113
  "dateCreated": "2025-08-12T12:00:00Z",
@@ -14208,7 +14280,7 @@
14208
14280
  "$ref": "#/components/schemas/DataAssetQueryRequest"
14209
14281
  },
14210
14282
  "examples": {
14211
- "dataAssetQuery": {
14283
+ "dataAssetQueryRequestExample": {
14212
14284
  "value": {
14213
14285
  "consumerPid": "urn:uuid:consumer-pid-12345",
14214
14286
  "query": {
@@ -14230,7 +14302,7 @@
14230
14302
  "$ref": "#/components/schemas/DataAssetItemList"
14231
14303
  },
14232
14304
  "examples": {
14233
- "dataAssetEntitiesGetResponseExample": {
14305
+ "dataAssetQueryResponseExample": {
14234
14306
  "value": {
14235
14307
  "@context": "https://schema.org",
14236
14308
  "type": "ItemList",
@@ -14296,13 +14368,74 @@
14296
14368
  "tags": [
14297
14369
  "Transfer Process"
14298
14370
  ],
14371
+ "parameters": [
14372
+ {
14373
+ "name": "authorization",
14374
+ "in": "header",
14375
+ "required": true,
14376
+ "schema": {
14377
+ "type": "string"
14378
+ },
14379
+ "style": "simple",
14380
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14381
+ }
14382
+ ],
14383
+ "requestBody": {
14384
+ "description": "API request for requesting a transfer process.",
14385
+ "required": true,
14386
+ "content": {
14387
+ "application/ld+json": {
14388
+ "schema": {
14389
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferRequestMessage"
14390
+ },
14391
+ "examples": {
14392
+ "requestTransferRequestExample": {
14393
+ "value": {
14394
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14395
+ "@type": "TransferRequestMessage",
14396
+ "processId": "urn:uuid:consumer-process-12345",
14397
+ "consumerPid": "urn:uuid:consumer-process-12345",
14398
+ "providerPid": "urn:uuid:provider-process-12345",
14399
+ "agreementId": "urn:uuid:agreement-12345",
14400
+ "dataAddress": {
14401
+ "@type": "DataAddress",
14402
+ "@id": "https://provider.example.com/data",
14403
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14404
+ "baseUrl": "https://provider.example.com/data"
14405
+ },
14406
+ "callbackAddress": "https://consumer.example.com/transfer/webhook",
14407
+ "format": "urn:example:format"
14408
+ }
14409
+ }
14410
+ }
14411
+ }
14412
+ }
14413
+ },
14299
14414
  "responses": {
14300
14415
  "200": {
14301
- "description": "The rest request ended in success with no data.",
14416
+ "description": "API response for requesting a transfer process.",
14302
14417
  "content": {
14303
- "text/plain": {
14418
+ "application/json": {
14304
14419
  "schema": {
14305
- "$ref": "#/components/schemas/OkResponse"
14420
+ "$ref": "#/components/schemas/RequestTransferResponse"
14421
+ },
14422
+ "examples": {
14423
+ "requestTransferResponseExample": {
14424
+ "value": {
14425
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14426
+ "@type": "TransferProcess",
14427
+ "processId": "urn:uuid:provider-process-12345",
14428
+ "consumerPid": "urn:uuid:consumer-process-12345",
14429
+ "providerPid": "urn:uuid:provider-process-12345",
14430
+ "state": "STARTED",
14431
+ "dataAddress": {
14432
+ "@type": "DataAddress",
14433
+ "@id": "https://provider.example.com/data/transfer-12345",
14434
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14435
+ "baseUrl": "https://provider.example.com/data/transfer-12345"
14436
+ }
14437
+ }
14438
+ }
14306
14439
  }
14307
14440
  }
14308
14441
  }
@@ -14359,22 +14492,51 @@
14359
14492
  "parameters": [
14360
14493
  {
14361
14494
  "name": "pid",
14362
- "description": "",
14495
+ "description": "Process ID (consumerPid or providerPid).",
14363
14496
  "in": "path",
14364
14497
  "required": true,
14365
14498
  "schema": {
14366
14499
  "type": "string"
14367
14500
  },
14368
- "style": "simple"
14501
+ "style": "simple",
14502
+ "example": "urn:uuid:provider-process-12345"
14503
+ },
14504
+ {
14505
+ "name": "authorization",
14506
+ "in": "header",
14507
+ "required": true,
14508
+ "schema": {
14509
+ "type": "string"
14510
+ },
14511
+ "style": "simple",
14512
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14369
14513
  }
14370
14514
  ],
14371
14515
  "responses": {
14372
14516
  "200": {
14373
- "description": "The rest request ended in success with no data.",
14517
+ "description": "API response for getting a transfer process state.",
14374
14518
  "content": {
14375
- "text/plain": {
14519
+ "application/json": {
14376
14520
  "schema": {
14377
- "$ref": "#/components/schemas/OkResponse"
14521
+ "$ref": "#/components/schemas/GetTransferProcessResponse"
14522
+ },
14523
+ "examples": {
14524
+ "getTransferProcessResponseExample": {
14525
+ "value": {
14526
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14527
+ "@type": "TransferProcess",
14528
+ "processId": "urn:uuid:provider-process-12345",
14529
+ "consumerPid": "urn:uuid:consumer-process-12345",
14530
+ "providerPid": "urn:uuid:provider-process-12345",
14531
+ "state": "STARTED",
14532
+ "dataAddress": {
14533
+ "@type": "DataAddress",
14534
+ "@id": "https://provider.example.com/data/transfer-12345",
14535
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14536
+ "baseUrl": "https://provider.example.com/data/transfer-12345"
14537
+ }
14538
+ }
14539
+ }
14378
14540
  }
14379
14541
  }
14380
14542
  }
@@ -14431,22 +14593,64 @@
14431
14593
  "parameters": [
14432
14594
  {
14433
14595
  "name": "pid",
14434
- "description": "",
14596
+ "description": "Process ID (consumerPid).",
14435
14597
  "in": "path",
14436
14598
  "required": true,
14437
14599
  "schema": {
14438
14600
  "type": "string"
14439
14601
  },
14440
- "style": "simple"
14602
+ "style": "simple",
14603
+ "example": "urn:uuid:consumer-process-12345"
14604
+ },
14605
+ {
14606
+ "name": "authorization",
14607
+ "in": "header",
14608
+ "required": true,
14609
+ "schema": {
14610
+ "type": "string"
14611
+ },
14612
+ "style": "simple",
14613
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14441
14614
  }
14442
14615
  ],
14616
+ "requestBody": {
14617
+ "description": "API request for starting a transfer process.",
14618
+ "required": true,
14619
+ "content": {
14620
+ "application/ld+json": {
14621
+ "schema": {
14622
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferStartMessage"
14623
+ },
14624
+ "examples": {
14625
+ "startTransferRequestExample": {
14626
+ "value": {
14627
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14628
+ "@type": "TransferStartMessage",
14629
+ "consumerPid": "urn:uuid:consumer-process-12345",
14630
+ "providerPid": "urn:uuid:provider-process-12345"
14631
+ }
14632
+ }
14633
+ }
14634
+ }
14635
+ }
14636
+ },
14443
14637
  "responses": {
14444
14638
  "200": {
14445
- "description": "The rest request ended in success with no data.",
14639
+ "description": "API response for starting a transfer process.",
14446
14640
  "content": {
14447
- "text/plain": {
14641
+ "application/json": {
14448
14642
  "schema": {
14449
- "$ref": "#/components/schemas/OkResponse"
14643
+ "$ref": "#/components/schemas/StartTransferResponse"
14644
+ },
14645
+ "examples": {
14646
+ "startTransferResponseExample": {
14647
+ "value": {
14648
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14649
+ "@type": "TransferStartMessage",
14650
+ "consumerPid": "urn:uuid:consumer-process-12345",
14651
+ "providerPid": "urn:uuid:provider-process-12345"
14652
+ }
14653
+ }
14450
14654
  }
14451
14655
  }
14452
14656
  }
@@ -14503,22 +14707,72 @@
14503
14707
  "parameters": [
14504
14708
  {
14505
14709
  "name": "pid",
14506
- "description": "",
14710
+ "description": "Process ID (consumerPid).",
14507
14711
  "in": "path",
14508
14712
  "required": true,
14509
14713
  "schema": {
14510
14714
  "type": "string"
14511
14715
  },
14512
- "style": "simple"
14716
+ "style": "simple",
14717
+ "example": "urn:uuid:consumer-process-12345"
14718
+ },
14719
+ {
14720
+ "name": "authorization",
14721
+ "in": "header",
14722
+ "required": true,
14723
+ "schema": {
14724
+ "type": "string"
14725
+ },
14726
+ "style": "simple",
14727
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14513
14728
  }
14514
14729
  ],
14730
+ "requestBody": {
14731
+ "description": "API request for completing a transfer process.",
14732
+ "required": true,
14733
+ "content": {
14734
+ "application/ld+json": {
14735
+ "schema": {
14736
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferCompletionMessage"
14737
+ },
14738
+ "examples": {
14739
+ "completeTransferRequestExample": {
14740
+ "value": {
14741
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14742
+ "@type": "TransferCompletionMessage",
14743
+ "consumerPid": "urn:uuid:consumer-process-12345",
14744
+ "providerPid": "urn:uuid:provider-process-12345"
14745
+ }
14746
+ }
14747
+ }
14748
+ }
14749
+ }
14750
+ },
14515
14751
  "responses": {
14516
14752
  "200": {
14517
- "description": "The rest request ended in success with no data.",
14753
+ "description": "API response for completing a transfer process.",
14518
14754
  "content": {
14519
- "text/plain": {
14755
+ "application/json": {
14520
14756
  "schema": {
14521
- "$ref": "#/components/schemas/OkResponse"
14757
+ "$ref": "#/components/schemas/CompleteTransferResponse"
14758
+ },
14759
+ "examples": {
14760
+ "completeTransferResponseExample": {
14761
+ "value": {
14762
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14763
+ "@type": "TransferProcess",
14764
+ "processId": "urn:uuid:provider-process-12345",
14765
+ "consumerPid": "urn:uuid:consumer-process-12345",
14766
+ "providerPid": "urn:uuid:provider-process-12345",
14767
+ "state": "COMPLETED",
14768
+ "dataAddress": {
14769
+ "@type": "DataAddress",
14770
+ "@id": "https://provider.example.com/data/transfer-12345",
14771
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14772
+ "baseUrl": "https://provider.example.com/data/transfer-12345"
14773
+ }
14774
+ }
14775
+ }
14522
14776
  }
14523
14777
  }
14524
14778
  }
@@ -14575,29 +14829,79 @@
14575
14829
  "parameters": [
14576
14830
  {
14577
14831
  "name": "pid",
14578
- "description": "",
14832
+ "description": "Process ID (consumerPid).",
14579
14833
  "in": "path",
14580
14834
  "required": true,
14581
14835
  "schema": {
14582
14836
  "type": "string"
14583
14837
  },
14584
- "style": "simple"
14838
+ "style": "simple",
14839
+ "example": "urn:uuid:consumer-process-12345"
14840
+ },
14841
+ {
14842
+ "name": "authorization",
14843
+ "in": "header",
14844
+ "required": true,
14845
+ "schema": {
14846
+ "type": "string"
14847
+ },
14848
+ "style": "simple",
14849
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14585
14850
  }
14586
14851
  ],
14587
- "responses": {
14588
- "200": {
14589
- "description": "The rest request ended in success with no data.",
14590
- "content": {
14591
- "text/plain": {
14592
- "schema": {
14593
- "$ref": "#/components/schemas/OkResponse"
14594
- }
14595
- }
14596
- }
14597
- },
14598
- "400": {
14599
- "description": "The server cannot process the request, see the content for more details.",
14600
- "content": {
14852
+ "requestBody": {
14853
+ "description": "API request for suspending a transfer process.",
14854
+ "required": true,
14855
+ "content": {
14856
+ "application/ld+json": {
14857
+ "schema": {
14858
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferSuspensionMessage"
14859
+ },
14860
+ "examples": {
14861
+ "suspendTransferRequestExample": {
14862
+ "value": {
14863
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14864
+ "@type": "TransferSuspensionMessage",
14865
+ "consumerPid": "urn:uuid:consumer-process-12345",
14866
+ "providerPid": "urn:uuid:provider-process-12345"
14867
+ }
14868
+ }
14869
+ }
14870
+ }
14871
+ }
14872
+ },
14873
+ "responses": {
14874
+ "200": {
14875
+ "description": "API response for suspending a transfer process.",
14876
+ "content": {
14877
+ "application/json": {
14878
+ "schema": {
14879
+ "$ref": "#/components/schemas/SuspendTransferResponse"
14880
+ },
14881
+ "examples": {
14882
+ "suspendTransferResponseExample": {
14883
+ "value": {
14884
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14885
+ "@type": "TransferProcess",
14886
+ "processId": "urn:uuid:provider-process-12345",
14887
+ "consumerPid": "urn:uuid:consumer-process-12345",
14888
+ "providerPid": "urn:uuid:provider-process-12345",
14889
+ "state": "SUSPENDED",
14890
+ "dataAddress": {
14891
+ "@type": "DataAddress",
14892
+ "@id": "https://provider.example.com/data/transfer-12345",
14893
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14894
+ "baseUrl": "https://provider.example.com/data/transfer-12345"
14895
+ }
14896
+ }
14897
+ }
14898
+ }
14899
+ }
14900
+ }
14901
+ },
14902
+ "400": {
14903
+ "description": "The server cannot process the request, see the content for more details.",
14904
+ "content": {
14601
14905
  "application/json": {
14602
14906
  "schema": {
14603
14907
  "$ref": "#/components/schemas/Error"
@@ -14647,22 +14951,72 @@
14647
14951
  "parameters": [
14648
14952
  {
14649
14953
  "name": "pid",
14650
- "description": "",
14954
+ "description": "Process ID (consumerPid).",
14651
14955
  "in": "path",
14652
14956
  "required": true,
14653
14957
  "schema": {
14654
14958
  "type": "string"
14655
14959
  },
14656
- "style": "simple"
14960
+ "style": "simple",
14961
+ "example": "urn:uuid:consumer-process-12345"
14962
+ },
14963
+ {
14964
+ "name": "authorization",
14965
+ "in": "header",
14966
+ "required": true,
14967
+ "schema": {
14968
+ "type": "string"
14969
+ },
14970
+ "style": "simple",
14971
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14657
14972
  }
14658
14973
  ],
14974
+ "requestBody": {
14975
+ "description": "API request for terminating a transfer process.",
14976
+ "required": true,
14977
+ "content": {
14978
+ "application/ld+json": {
14979
+ "schema": {
14980
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferTerminationMessage"
14981
+ },
14982
+ "examples": {
14983
+ "terminateTransferRequestExample": {
14984
+ "value": {
14985
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14986
+ "@type": "TransferTerminationMessage",
14987
+ "consumerPid": "urn:uuid:consumer-process-12345",
14988
+ "providerPid": "urn:uuid:provider-process-12345"
14989
+ }
14990
+ }
14991
+ }
14992
+ }
14993
+ }
14994
+ },
14659
14995
  "responses": {
14660
14996
  "200": {
14661
- "description": "The rest request ended in success with no data.",
14997
+ "description": "API response for terminating a transfer process.",
14662
14998
  "content": {
14663
- "text/plain": {
14999
+ "application/json": {
14664
15000
  "schema": {
14665
- "$ref": "#/components/schemas/OkResponse"
15001
+ "$ref": "#/components/schemas/TerminateTransferResponse"
15002
+ },
15003
+ "examples": {
15004
+ "terminateTransferResponseExample": {
15005
+ "value": {
15006
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
15007
+ "@type": "TransferProcess",
15008
+ "processId": "urn:uuid:provider-process-12345",
15009
+ "consumerPid": "urn:uuid:consumer-process-12345",
15010
+ "providerPid": "urn:uuid:provider-process-12345",
15011
+ "state": "TERMINATED",
15012
+ "dataAddress": {
15013
+ "@type": "DataAddress",
15014
+ "@id": "https://provider.example.com/data/transfer-12345",
15015
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
15016
+ "baseUrl": "https://provider.example.com/data/transfer-12345"
15017
+ }
15018
+ }
15019
+ }
14666
15020
  }
14667
15021
  }
14668
15022
  }
@@ -14727,7 +15081,7 @@
14727
15081
  "content": {
14728
15082
  "application/json": {
14729
15083
  "schema": {
14730
- "$ref": "https://schema.twindev.org/json-ld/JsonLdObjectWithOptionalAtId<DataspaceProtocolPolicy>"
15084
+ "$ref": "#/components/schemas/PapCreateRequest"
14731
15085
  },
14732
15086
  "examples": {
14733
15087
  "papCreateRequestExample": {
@@ -17090,7 +17444,25 @@
17090
17444
  },
17091
17445
  "components": {
17092
17446
  "schemas": {
17093
- "ActivityLogEntry": {
17447
+ "ActivityLogDates": {
17448
+ "description": "Activity log dates.",
17449
+ "type": "object",
17450
+ "properties": {
17451
+ "startDate": {
17452
+ "type": "string",
17453
+ "description": "Task processing start timestamp"
17454
+ },
17455
+ "endDate": {
17456
+ "type": "string",
17457
+ "description": "Task processing end timestamp"
17458
+ }
17459
+ },
17460
+ "required": [
17461
+ "startDate"
17462
+ ]
17463
+ },
17464
+ "ActivityLogDetails": {
17465
+ "description": "The details related to the processing of an Activity",
17094
17466
  "type": "object",
17095
17467
  "properties": {
17096
17468
  "id": {
@@ -17116,7 +17488,19 @@
17116
17488
  "retryCount": {
17117
17489
  "type": "number",
17118
17490
  "description": "Number of times this activity has been retried."
17119
- },
17491
+ }
17492
+ },
17493
+ "required": [
17494
+ "id",
17495
+ "generator",
17496
+ "dateCreated",
17497
+ "dateModified"
17498
+ ]
17499
+ },
17500
+ "ActivityLogEntry": {
17501
+ "description": "The details related to the processing of an Activity",
17502
+ "type": "object",
17503
+ "properties": {
17120
17504
  "status": {
17121
17505
  "$ref": "#/components/schemas/ActivityProcessingStatus"
17122
17506
  },
@@ -17131,29 +17515,13 @@
17131
17515
  "type": "array",
17132
17516
  "items": {
17133
17517
  "type": "object",
17134
- "additionalProperties": false,
17135
- "properties": {
17136
- "startDate": {
17137
- "type": "string",
17138
- "description": "Task processing start timestamp"
17139
- },
17140
- "endDate": {
17141
- "type": "string",
17142
- "description": "Task processing end timestamp"
17143
- },
17144
- "taskId": {
17145
- "type": "string",
17146
- "description": "Task Id."
17518
+ "allOf": [
17519
+ {
17520
+ "$ref": "#/components/schemas/TaskApp"
17147
17521
  },
17148
- "dataspaceAppId": {
17149
- "type": "string",
17150
- "description": "Dataspace App Id."
17522
+ {
17523
+ "$ref": "#/components/schemas/ActivityLogDates"
17151
17524
  }
17152
- },
17153
- "required": [
17154
- "dataspaceAppId",
17155
- "startDate",
17156
- "taskId"
17157
17525
  ]
17158
17526
  },
17159
17527
  "description": "The running tasks that are processing the Activity."
@@ -17162,34 +17530,22 @@
17162
17530
  "type": "array",
17163
17531
  "items": {
17164
17532
  "type": "object",
17165
- "additionalProperties": false,
17166
17533
  "properties": {
17167
17534
  "result": {
17168
17535
  "type": "string",
17169
17536
  "description": "The task result."
17170
- },
17171
- "startDate": {
17172
- "type": "string",
17173
- "description": "Task processing start timestamp"
17174
- },
17175
- "endDate": {
17176
- "type": "string",
17177
- "description": "Task processing end timestamp"
17178
- },
17179
- "taskId": {
17180
- "type": "string",
17181
- "description": "Task Id."
17182
- },
17183
- "dataspaceAppId": {
17184
- "type": "string",
17185
- "description": "Dataspace App Id."
17186
17537
  }
17187
17538
  },
17188
17539
  "required": [
17189
- "dataspaceAppId",
17190
- "result",
17191
- "startDate",
17192
- "taskId"
17540
+ "result"
17541
+ ],
17542
+ "allOf": [
17543
+ {
17544
+ "$ref": "#/components/schemas/TaskApp"
17545
+ },
17546
+ {
17547
+ "$ref": "#/components/schemas/ActivityLogDates"
17548
+ }
17193
17549
  ]
17194
17550
  },
17195
17551
  "description": "The tasks that have already finalized."
@@ -17198,928 +17554,161 @@
17198
17554
  "type": "array",
17199
17555
  "items": {
17200
17556
  "type": "object",
17201
- "additionalProperties": false,
17202
17557
  "properties": {
17203
17558
  "error": {
17204
17559
  "$ref": "#/components/schemas/Error"
17205
- },
17206
- "taskId": {
17207
- "type": "string",
17208
- "description": "Task Id."
17209
- },
17210
- "dataspaceAppId": {
17211
- "type": "string",
17212
- "description": "Dataspace App Id."
17213
17560
  }
17214
17561
  },
17215
17562
  "required": [
17216
- "dataspaceAppId",
17217
- "error",
17218
- "taskId"
17563
+ "error"
17564
+ ],
17565
+ "allOf": [
17566
+ {
17567
+ "$ref": "#/components/schemas/TaskApp"
17568
+ }
17219
17569
  ]
17220
17570
  },
17221
17571
  "description": "The tasks that are in error."
17222
17572
  }
17223
17573
  },
17224
17574
  "required": [
17225
- "dateCreated",
17226
- "dateModified",
17227
- "generator",
17228
- "id",
17229
17575
  "status"
17230
17576
  ],
17231
- "description": "The details related to the processing of an Activity"
17577
+ "allOf": [
17578
+ {
17579
+ "$ref": "#/components/schemas/ActivityLogDetails"
17580
+ }
17581
+ ]
17232
17582
  },
17233
17583
  "ActivityProcessingStatus": {
17584
+ "description": "The type exported.",
17234
17585
  "anyOf": [
17235
17586
  {
17236
- "type": "string",
17237
17587
  "const": "pending",
17238
17588
  "description": "Pending: Activity Processing has not started yet."
17239
17589
  },
17240
17590
  {
17241
- "type": "string",
17242
17591
  "const": "running",
17243
17592
  "description": "Running Activity processing is running."
17244
17593
  },
17245
17594
  {
17246
- "type": "string",
17247
17595
  "const": "completed",
17248
17596
  "description": "Completed: Activity processing completed without error."
17249
17597
  },
17250
17598
  {
17251
- "type": "string",
17252
17599
  "const": "error",
17253
17600
  "description": "Error: Activity processing cannot be performed and marked as in error. (Depends on application)."
17254
17601
  },
17255
17602
  {
17256
- "type": "string",
17257
17603
  "const": "registering",
17258
17604
  "description": "Transient state. The background tasks associated with the activity are still being registered."
17259
17605
  }
17260
- ],
17261
- "description": "Activity processing statuses. The type exported."
17606
+ ]
17262
17607
  },
17263
- "ActivityStreamsActivity": {
17608
+ "AdminUserCreateRequest": {
17609
+ "description": "The body of the request.",
17264
17610
  "type": "object",
17265
17611
  "properties": {
17266
- "@context": {
17267
- "$ref": "#/components/schemas/ActivityStreamsContextType"
17612
+ "email": {
17613
+ "type": "string",
17614
+ "description": "The user e-mail address."
17268
17615
  },
17269
- "type": {
17270
- "anyOf": [
17271
- {
17272
- "$ref": "#/components/schemas/ActivityStreamsTypes"
17273
- },
17274
- {
17275
- "type": "string"
17276
- },
17277
- {
17278
- "type": "array",
17279
- "items": {
17280
- "anyOf": [
17281
- {
17282
- "$ref": "#/components/schemas/ActivityStreamsTypes"
17283
- },
17284
- {
17285
- "type": "string"
17286
- }
17287
- ]
17288
- }
17289
- }
17290
- ],
17291
- "description": "Activity Type."
17616
+ "password": {
17617
+ "type": "string",
17618
+ "description": "The encrypted password for the user."
17292
17619
  },
17293
- "id": {
17620
+ "userIdentity": {
17294
17621
  "type": "string",
17295
- "description": "Global identifier.",
17296
- "format": "uri"
17622
+ "description": "The user identity."
17297
17623
  },
17298
- "name": {
17299
- "anyOf": [
17300
- {
17301
- "type": "string"
17302
- },
17303
- {
17304
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17305
- }
17306
- ],
17307
- "description": "Natural language name."
17624
+ "organizationIdentity": {
17625
+ "type": "string",
17626
+ "description": "The users organization."
17308
17627
  },
17309
- "nameMap": {
17310
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17628
+ "scope": {
17629
+ "type": "array",
17630
+ "items": {
17631
+ "type": "string"
17632
+ },
17633
+ "description": "The scope assigned to the user, comma separated."
17634
+ }
17635
+ },
17636
+ "required": [
17637
+ "email",
17638
+ "password",
17639
+ "userIdentity",
17640
+ "organizationIdentity",
17641
+ "scope"
17642
+ ]
17643
+ },
17644
+ "AdminUserGetResponse": {
17645
+ "description": "The body of the request.",
17646
+ "type": "object",
17647
+ "properties": {
17648
+ "email": {
17649
+ "type": "string",
17650
+ "description": "The user e-mail address."
17311
17651
  },
17312
- "summary": {
17313
- "anyOf": [
17314
- {
17315
- "type": "string"
17316
- },
17317
- {
17318
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17319
- }
17320
- ],
17321
- "description": "Summary of the Activity."
17652
+ "userIdentity": {
17653
+ "type": "string",
17654
+ "description": "The user identity."
17322
17655
  },
17323
- "summaryMap": {
17324
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17656
+ "organizationIdentity": {
17657
+ "type": "string",
17658
+ "description": "The users organization."
17325
17659
  },
17326
- "content": {
17327
- "anyOf": [
17328
- {
17329
- "type": "string"
17330
- },
17331
- {
17332
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17333
- }
17334
- ],
17335
- "description": "Natural language content."
17660
+ "scope": {
17661
+ "type": "array",
17662
+ "items": {
17663
+ "type": "string"
17664
+ },
17665
+ "description": "The scope assigned to the user, comma separated."
17666
+ }
17667
+ },
17668
+ "required": [
17669
+ "email",
17670
+ "userIdentity",
17671
+ "organizationIdentity",
17672
+ "scope"
17673
+ ]
17674
+ },
17675
+ "AdminUserUpdatePasswordRequest": {
17676
+ "type": "object",
17677
+ "properties": {
17678
+ "newPassword": {
17679
+ "type": "string",
17680
+ "description": "The new password for the user."
17336
17681
  },
17337
- "contentMap": {
17338
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17682
+ "currentPassword": {
17683
+ "type": "string",
17684
+ "description": "The current password for the user."
17685
+ }
17686
+ },
17687
+ "required": [
17688
+ "newPassword"
17689
+ ],
17690
+ "description": "The body of the request."
17691
+ },
17692
+ "AdminUserUpdateRequest": {
17693
+ "description": "The body of the request.",
17694
+ "type": "object",
17695
+ "properties": {
17696
+ "userIdentity": {
17697
+ "type": "string",
17698
+ "description": "The user identity."
17339
17699
  },
17340
- "url": {
17341
- "description": "Object or array data type",
17342
- "anyOf": [
17343
- {
17344
- "type": "string"
17345
- },
17346
- {
17347
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17348
- },
17349
- {
17350
- "type": "array",
17351
- "items": {
17352
- "anyOf": [
17353
- {
17354
- "type": "string"
17355
- },
17356
- {
17357
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17358
- }
17359
- ]
17360
- }
17361
- }
17362
- ]
17700
+ "organizationIdentity": {
17701
+ "type": "string",
17702
+ "description": "The users organization."
17363
17703
  },
17364
- "image": {
17365
- "description": "Object or array data type",
17366
- "anyOf": [
17367
- {
17368
- "type": "string"
17369
- },
17370
- {
17371
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17372
- },
17373
- {
17374
- "type": "array",
17375
- "items": {
17376
- "anyOf": [
17377
- {
17378
- "type": "string"
17379
- },
17380
- {
17381
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17382
- }
17383
- ]
17384
- }
17385
- }
17386
- ]
17387
- },
17388
- "icon": {
17389
- "description": "Object or array data type",
17390
- "anyOf": [
17391
- {
17392
- "type": "string"
17393
- },
17394
- {
17395
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17396
- },
17397
- {
17398
- "type": "array",
17399
- "items": {
17400
- "anyOf": [
17401
- {
17402
- "type": "string"
17403
- },
17404
- {
17405
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17406
- }
17407
- ]
17408
- }
17409
- }
17410
- ]
17411
- },
17412
- "published": {
17413
- "type": "string",
17414
- "description": "Published date-time.",
17415
- "format": "date-time"
17416
- },
17417
- "updated": {
17418
- "type": "string",
17419
- "description": "Updated date-time.",
17420
- "format": "date-time"
17421
- },
17422
- "startTime": {
17423
- "type": "string",
17424
- "description": "Start time.",
17425
- "format": "date-time"
17426
- },
17427
- "endTime": {
17428
- "type": "string",
17429
- "description": "End time.",
17430
- "format": "date-time"
17431
- },
17432
- "duration": {
17433
- "type": "string",
17434
- "description": "Duration.",
17435
- "format": "duration"
17436
- },
17437
- "generator": {
17438
- "description": "Object or array data type",
17439
- "anyOf": [
17440
- {
17441
- "type": "string"
17442
- },
17443
- {
17444
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17445
- },
17446
- {
17447
- "type": "array",
17448
- "items": {
17449
- "anyOf": [
17450
- {
17451
- "type": "string"
17452
- },
17453
- {
17454
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17455
- }
17456
- ]
17457
- }
17458
- }
17459
- ]
17460
- },
17461
- "attachment": {
17462
- "description": "Object or array data type",
17463
- "anyOf": [
17464
- {
17465
- "type": "string"
17466
- },
17467
- {
17468
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17469
- },
17470
- {
17471
- "type": "array",
17472
- "items": {
17473
- "anyOf": [
17474
- {
17475
- "type": "string"
17476
- },
17477
- {
17478
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17479
- }
17480
- ]
17481
- }
17482
- }
17483
- ]
17484
- },
17485
- "attributedTo": {
17486
- "description": "Object or array data type",
17487
- "anyOf": [
17488
- {
17489
- "type": "string"
17490
- },
17491
- {
17492
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17493
- },
17494
- {
17495
- "type": "array",
17496
- "items": {
17497
- "anyOf": [
17498
- {
17499
- "type": "string"
17500
- },
17501
- {
17502
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17503
- }
17504
- ]
17505
- }
17506
- }
17507
- ]
17508
- },
17509
- "audience": {
17510
- "description": "Object or array data type",
17511
- "anyOf": [
17512
- {
17513
- "type": "string"
17514
- },
17515
- {
17516
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17517
- },
17518
- {
17519
- "type": "array",
17520
- "items": {
17521
- "anyOf": [
17522
- {
17523
- "type": "string"
17524
- },
17525
- {
17526
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17527
- }
17528
- ]
17529
- }
17530
- }
17531
- ]
17532
- },
17533
- "context": {
17534
- "description": "Object or array data type",
17535
- "anyOf": [
17536
- {
17537
- "type": "string"
17538
- },
17539
- {
17540
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17541
- },
17542
- {
17543
- "type": "array",
17544
- "items": {
17545
- "anyOf": [
17546
- {
17547
- "type": "string"
17548
- },
17549
- {
17550
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17551
- }
17552
- ]
17553
- }
17554
- }
17555
- ]
17556
- },
17557
- "location": {
17558
- "description": "Object or array data type",
17559
- "anyOf": [
17560
- {
17561
- "type": "string"
17562
- },
17563
- {
17564
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17565
- },
17566
- {
17567
- "type": "array",
17568
- "items": {
17569
- "anyOf": [
17570
- {
17571
- "type": "string"
17572
- },
17573
- {
17574
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17575
- }
17576
- ]
17577
- }
17578
- }
17579
- ]
17580
- },
17581
- "tag": {
17582
- "description": "Object or array data type",
17583
- "anyOf": [
17584
- {
17585
- "type": "string"
17586
- },
17587
- {
17588
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17589
- },
17590
- {
17591
- "type": "array",
17592
- "items": {
17593
- "anyOf": [
17594
- {
17595
- "type": "string"
17596
- },
17597
- {
17598
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17599
- }
17600
- ]
17601
- }
17602
- }
17603
- ]
17604
- },
17605
- "inReplyTo": {
17606
- "description": "Object or array data type",
17607
- "anyOf": [
17608
- {
17609
- "type": "string"
17610
- },
17611
- {
17612
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17613
- },
17614
- {
17615
- "type": "array",
17616
- "items": {
17617
- "anyOf": [
17618
- {
17619
- "type": "string"
17620
- },
17621
- {
17622
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17623
- }
17624
- ]
17625
- }
17626
- }
17627
- ]
17628
- },
17629
- "replies": {
17630
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17631
- },
17632
- "preview": {
17633
- "description": "Object or array data type",
17634
- "anyOf": [
17635
- {
17636
- "type": "string"
17637
- },
17638
- {
17639
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17640
- },
17641
- {
17642
- "type": "array",
17643
- "items": {
17644
- "anyOf": [
17645
- {
17646
- "type": "string"
17647
- },
17648
- {
17649
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17650
- }
17651
- ]
17652
- }
17653
- }
17654
- ]
17655
- },
17656
- "to": {
17657
- "description": "Object or array data type",
17658
- "anyOf": [
17659
- {
17660
- "type": "string"
17661
- },
17662
- {
17663
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17664
- },
17665
- {
17666
- "type": "array",
17667
- "items": {
17668
- "anyOf": [
17669
- {
17670
- "type": "string"
17671
- },
17672
- {
17673
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17674
- }
17675
- ]
17676
- }
17677
- }
17678
- ]
17679
- },
17680
- "bto": {
17681
- "description": "Object or array data type",
17682
- "anyOf": [
17683
- {
17684
- "type": "string"
17685
- },
17686
- {
17687
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17688
- },
17689
- {
17690
- "type": "array",
17691
- "items": {
17692
- "anyOf": [
17693
- {
17694
- "type": "string"
17695
- },
17696
- {
17697
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17698
- }
17699
- ]
17700
- }
17701
- }
17702
- ]
17703
- },
17704
- "cc": {
17705
- "description": "Object or array data type",
17706
- "anyOf": [
17707
- {
17708
- "type": "string"
17709
- },
17710
- {
17711
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17712
- },
17713
- {
17714
- "type": "array",
17715
- "items": {
17716
- "anyOf": [
17717
- {
17718
- "type": "string"
17719
- },
17720
- {
17721
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17722
- }
17723
- ]
17724
- }
17725
- }
17726
- ]
17727
- },
17728
- "bcc": {
17729
- "description": "Object or array data type",
17730
- "anyOf": [
17731
- {
17732
- "type": "string"
17733
- },
17734
- {
17735
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17736
- },
17737
- {
17738
- "type": "array",
17739
- "items": {
17740
- "anyOf": [
17741
- {
17742
- "type": "string"
17743
- },
17744
- {
17745
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17746
- }
17747
- ]
17748
- }
17749
- }
17750
- ]
17751
- },
17752
- "mediaType": {
17753
- "type": "string",
17754
- "description": "MIME media type of the referenced resource."
17755
- },
17756
- "actor": {
17757
- "description": "Object or array data type",
17758
- "anyOf": [
17759
- {
17760
- "type": "string"
17761
- },
17762
- {
17763
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17764
- },
17765
- {
17766
- "type": "array",
17767
- "items": {
17768
- "anyOf": [
17769
- {
17770
- "type": "string"
17771
- },
17772
- {
17773
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17774
- }
17775
- ]
17776
- }
17777
- }
17778
- ]
17779
- },
17780
- "object": {
17781
- "description": "Object or array data type",
17782
- "anyOf": [
17783
- {
17784
- "type": "string"
17785
- },
17786
- {
17787
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17788
- },
17789
- {
17790
- "type": "array",
17791
- "items": {
17792
- "anyOf": [
17793
- {
17794
- "type": "string"
17795
- },
17796
- {
17797
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17798
- }
17799
- ]
17800
- }
17801
- }
17802
- ]
17803
- },
17804
- "target": {
17805
- "description": "Object or array data type",
17806
- "anyOf": [
17807
- {
17808
- "type": "string"
17809
- },
17810
- {
17811
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17812
- },
17813
- {
17814
- "type": "array",
17815
- "items": {
17816
- "anyOf": [
17817
- {
17818
- "type": "string"
17819
- },
17820
- {
17821
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17822
- }
17823
- ]
17824
- }
17825
- }
17826
- ]
17827
- },
17828
- "result": {
17829
- "description": "Object or array data type",
17830
- "anyOf": [
17831
- {
17832
- "type": "string"
17833
- },
17834
- {
17835
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17836
- },
17837
- {
17838
- "type": "array",
17839
- "items": {
17840
- "anyOf": [
17841
- {
17842
- "type": "string"
17843
- },
17844
- {
17845
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17846
- }
17847
- ]
17848
- }
17849
- }
17850
- ]
17851
- },
17852
- "origin": {
17853
- "description": "Object or array data type",
17854
- "anyOf": [
17855
- {
17856
- "type": "string"
17857
- },
17858
- {
17859
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17860
- },
17861
- {
17862
- "type": "array",
17863
- "items": {
17864
- "anyOf": [
17865
- {
17866
- "type": "string"
17867
- },
17868
- {
17869
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17870
- }
17871
- ]
17872
- }
17873
- }
17874
- ]
17875
- },
17876
- "instrument": {
17877
- "description": "Object or array data type",
17878
- "anyOf": [
17879
- {
17880
- "type": "string"
17881
- },
17882
- {
17883
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17884
- },
17885
- {
17886
- "type": "array",
17887
- "items": {
17888
- "anyOf": [
17889
- {
17890
- "type": "string"
17891
- },
17892
- {
17893
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17894
- }
17895
- ]
17896
- }
17897
- }
17898
- ]
17899
- }
17900
- },
17901
- "required": [
17902
- "@context",
17903
- "type"
17904
- ],
17905
- "description": "A W3C Activity from Activity Streams.\n\nAn `Activity` describes an action performed by an `actor` on an `object`, and can optionally include a `target`, `result`, `origin`, or `instrument`."
17906
- },
17907
- "ActivityStreamsContextType": {
17908
- "anyOf": [
17909
- {
17910
- "type": "string",
17911
- "const": "https://www.w3.org/ns/activitystreams"
17912
- },
17913
- {
17914
- "type": "array",
17915
- "items": {
17916
- "type": "string",
17917
- "const": "https://www.w3.org/ns/activitystreams"
17918
- },
17919
- "minItems": 1,
17920
- "maxItems": 1
17921
- },
17922
- {
17923
- "type": "array",
17924
- "minItems": 2,
17925
- "prefixItems": [
17926
- {
17927
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
17928
- },
17929
- {
17930
- "type": "string",
17931
- "const": "https://www.w3.org/ns/activitystreams"
17932
- }
17933
- ],
17934
- "items": {
17935
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
17936
- }
17937
- },
17938
- {
17939
- "type": "array",
17940
- "minItems": 2,
17941
- "prefixItems": [
17942
- {
17943
- "type": "string",
17944
- "const": "https://www.w3.org/ns/activitystreams"
17945
- },
17946
- {
17947
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
17948
- }
17949
- ],
17950
- "items": {
17951
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
17952
- }
17953
- }
17954
- ],
17955
- "description": "The Activity Streams JSON-LD context type."
17956
- },
17957
- "ActivityStreamsTypes": {
17958
- "anyOf": [
17959
- {
17960
- "type": "string",
17961
- "const": "Activity",
17962
- "description": "Activity.\n\nGeneric base type for activities (actions) in Activity Streams."
17963
- },
17964
- {
17965
- "type": "string",
17966
- "const": "Accept",
17967
- "description": "Accept.\n\nIndicates that the actor accepts the object."
17968
- },
17969
- {
17970
- "type": "string",
17971
- "const": "Add",
17972
- "description": "Add.\n\nIndicates that the actor added the object to the target."
17973
- },
17974
- {
17975
- "type": "string",
17976
- "const": "Announce",
17977
- "description": "Announce.\n\nIndicates that the actor is calling attention to the object."
17978
- },
17979
- {
17980
- "type": "string",
17981
- "const": "Arrive",
17982
- "description": "Arrive.\n\nIntransitive activity indicating that the actor arrived at a location."
17983
- },
17984
- {
17985
- "type": "string",
17986
- "const": "Block",
17987
- "description": "Block.\n\nIndicates that the actor is blocking the object (a stronger form of Ignore)."
17988
- },
17989
- {
17990
- "type": "string",
17991
- "const": "Create",
17992
- "description": "Create.\n\nIndicates that the actor has created the object."
17993
- },
17994
- {
17995
- "type": "string",
17996
- "const": "Delete",
17997
- "description": "Delete.\n\nIndicates that the actor has deleted the object."
17998
- },
17999
- {
18000
- "type": "string",
18001
- "const": "Dislike",
18002
- "description": "Dislike.\n\nIndicates that the actor dislikes the object."
18003
- },
18004
- {
18005
- "type": "string",
18006
- "const": "Flag",
18007
- "description": "Flag.\n\nIndicates that the actor is flagging the object (e.g., reporting it)."
18008
- },
18009
- {
18010
- "type": "string",
18011
- "const": "Follow",
18012
- "description": "Follow.\n\nIndicates that the actor is following the object."
18013
- },
18014
- {
18015
- "type": "string",
18016
- "const": "Ignore",
18017
- "description": "Ignore.\n\nIndicates that the actor is ignoring the object."
18018
- },
18019
- {
18020
- "type": "string",
18021
- "const": "Invite",
18022
- "description": "Invite.\n\nSpecialization of Offer in which the actor is extending an invitation."
18023
- },
18024
- {
18025
- "type": "string",
18026
- "const": "Join",
18027
- "description": "Join.\n\nIndicates that the actor has joined the object."
18028
- },
18029
- {
18030
- "type": "string",
18031
- "const": "Leave",
18032
- "description": "Leave.\n\nIndicates that the actor has left the object."
18033
- },
18034
- {
18035
- "type": "string",
18036
- "const": "Like",
18037
- "description": "Like.\n\nIndicates that the actor likes, recommends, or endorses the object."
18038
- },
18039
- {
18040
- "type": "string",
18041
- "const": "Listen",
18042
- "description": "Listen.\n\nIndicates that the actor has listened to the object."
18043
- },
18044
- {
18045
- "type": "string",
18046
- "const": "Move",
18047
- "description": "Move.\n\nIndicates that the actor has moved the object from `origin` to `target`."
18048
- },
18049
- {
18050
- "type": "string",
18051
- "const": "Offer",
18052
- "description": "Offer.\n\nIndicates that the actor is offering the object (optionally to a target)."
18053
- },
18054
- {
18055
- "type": "string",
18056
- "const": "Question",
18057
- "description": "Question.\n\nIntransitive activity representing a question; can express options via `oneOf`/`anyOf`."
18058
- },
18059
- {
18060
- "type": "string",
18061
- "const": "Reject",
18062
- "description": "Reject.\n\nIndicates that the actor is rejecting the object."
18063
- },
18064
- {
18065
- "type": "string",
18066
- "const": "Read",
18067
- "description": "Read.\n\nIndicates that the actor has read the object."
18068
- },
18069
- {
18070
- "type": "string",
18071
- "const": "Remove",
18072
- "description": "Remove.\n\nIndicates that the actor is removing the object (optionally from an origin context)."
18073
- },
18074
- {
18075
- "type": "string",
18076
- "const": "TentativeReject",
18077
- "description": "TentativeReject.\n\nSpecialization of Reject indicating that the rejection is tentative."
18078
- },
18079
- {
18080
- "type": "string",
18081
- "const": "TentativeAccept",
18082
- "description": "TentativeAccept.\n\nSpecialization of Accept indicating that the acceptance is tentative."
18083
- },
18084
- {
18085
- "type": "string",
18086
- "const": "Travel",
18087
- "description": "Travel.\n\nIntransitive activity indicating that the actor is travelling to `target` from `origin`."
18088
- },
18089
- {
18090
- "type": "string",
18091
- "const": "Undo",
18092
- "description": "Undo.\n\nIndicates that the actor is undoing a previous activity."
18093
- },
18094
- {
18095
- "type": "string",
18096
- "const": "Update",
18097
- "description": "Update.\n\nIndicates that the actor has updated the object."
18098
- },
18099
- {
18100
- "type": "string",
18101
- "const": "View",
18102
- "description": "View.\n\nIndicates that the actor has viewed the object."
18103
- }
18104
- ],
18105
- "description": "The types concerning Activity Streams. Section 3.1 Activity Types: https://www.w3.org/TR/activitystreams-vocabulary/#activity-types The types concerning Activity. Section 3.1 Activity Types: https://www.w3.org/TR/activitystreams-vocabulary/#activity-types"
18106
- },
18107
- "AdminUserUpdatePasswordRequest": {
18108
- "type": "object",
18109
- "properties": {
18110
- "newPassword": {
18111
- "type": "string",
18112
- "description": "The new password for the user."
18113
- },
18114
- "currentPassword": {
18115
- "type": "string",
18116
- "description": "The current password for the user."
17704
+ "scope": {
17705
+ "type": "array",
17706
+ "items": {
17707
+ "type": "string"
17708
+ },
17709
+ "description": "The scope assigned to the user, comma separated."
18117
17710
  }
18118
- },
18119
- "required": [
18120
- "newPassword"
18121
- ],
18122
- "description": "The body of the request."
17711
+ }
18123
17712
  },
18124
17713
  "AttestationCreateRequest": {
18125
17714
  "type": "object",
@@ -18156,159 +17745,152 @@
18156
17745
  "description": "The parameters to be used in the transfer."
18157
17746
  },
18158
17747
  "AuditableItemGraphCreateRequest": {
17748
+ "description": "The data to be used in the vertex.",
18159
17749
  "type": "object",
18160
17750
  "properties": {
17751
+ "dateCreated": {
17752
+ "type": "string",
17753
+ "description": "The date/time of when the element was created."
17754
+ },
17755
+ "dateModified": {
17756
+ "type": "string",
17757
+ "description": "The date/time of when the element was modified."
17758
+ },
17759
+ "dateDeleted": {
17760
+ "type": "string",
17761
+ "description": "The date/time of when the element was deleted, as we never actually remove items."
17762
+ },
17763
+ "@context": {
17764
+ "type": "array",
17765
+ "prefixItems": [
17766
+ {
17767
+ "const": "https://schema.twindev.org/aig/"
17768
+ },
17769
+ {
17770
+ "const": "https://schema.twindev.org/common/"
17771
+ }
17772
+ ],
17773
+ "items": {
17774
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
17775
+ },
17776
+ "minItems": 2,
17777
+ "description": "JSON-LD Context."
17778
+ },
17779
+ "type": {
17780
+ "const": "AuditableItemGraphVertex",
17781
+ "description": "JSON-LD Type."
17782
+ },
17783
+ "organizationIdentity": {
17784
+ "type": "string",
17785
+ "description": "The identity of the organization which controls the vertex."
17786
+ },
18161
17787
  "annotationObject": {
18162
17788
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18163
17789
  },
18164
17790
  "aliases": {
18165
17791
  "type": "array",
18166
17792
  "items": {
18167
- "type": "object",
18168
- "properties": {
18169
- "id": {
18170
- "type": "string"
18171
- },
18172
- "aliasFormat": {
18173
- "type": "string"
18174
- },
18175
- "unique": {
18176
- "type": "boolean"
18177
- },
18178
- "annotationObject": {
18179
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18180
- }
18181
- },
18182
- "required": [
18183
- "id"
18184
- ],
18185
- "additionalProperties": false
17793
+ "$ref": "https://schema.twindev.org/aig/AuditableItemGraphAlias"
18186
17794
  },
18187
17795
  "description": "Alternative aliases that can be used to identify the vertex."
18188
17796
  },
18189
17797
  "resources": {
18190
17798
  "type": "array",
18191
17799
  "items": {
18192
- "type": "object",
18193
- "properties": {
18194
- "id": {
18195
- "type": "string"
18196
- },
18197
- "resourceObject": {
18198
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18199
- }
18200
- },
18201
- "additionalProperties": false
17800
+ "$ref": "https://schema.twindev.org/aig/AuditableItemGraphResource"
18202
17801
  },
18203
17802
  "description": "The resources attached to the vertex."
18204
17803
  },
18205
17804
  "edges": {
18206
17805
  "type": "array",
18207
17806
  "items": {
18208
- "type": "object",
18209
- "properties": {
18210
- "targetId": {
18211
- "type": "string"
18212
- },
18213
- "edgeRelationships": {
18214
- "type": "array",
18215
- "items": {
18216
- "type": "string"
18217
- }
18218
- },
18219
- "annotationObject": {
18220
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18221
- }
18222
- },
18223
- "required": [
18224
- "targetId",
18225
- "edgeRelationships"
18226
- ],
18227
- "additionalProperties": false
17807
+ "$ref": "https://schema.twindev.org/aig/AuditableItemGraphEdge"
18228
17808
  },
18229
- "description": "The edges connected to the vertex."
17809
+ "description": "Edges connected to the vertex."
17810
+ },
17811
+ "verified": {
17812
+ "type": "boolean",
17813
+ "description": "Is the vertex verified, will only be populated when verification is requested."
18230
17814
  }
18231
17815
  },
18232
- "description": "The data to be used in the vertex."
17816
+ "required": [
17817
+ "@context",
17818
+ "type"
17819
+ ]
18233
17820
  },
18234
17821
  "AuditableItemGraphUpdateRequest": {
17822
+ "description": "The data to be used in the vertex.",
18235
17823
  "type": "object",
18236
17824
  "properties": {
17825
+ "dateCreated": {
17826
+ "type": "string",
17827
+ "description": "The date/time of when the element was created."
17828
+ },
17829
+ "dateModified": {
17830
+ "type": "string",
17831
+ "description": "The date/time of when the element was modified."
17832
+ },
17833
+ "dateDeleted": {
17834
+ "type": "string",
17835
+ "description": "The date/time of when the element was deleted, as we never actually remove items."
17836
+ },
17837
+ "@context": {
17838
+ "type": "array",
17839
+ "prefixItems": [
17840
+ {
17841
+ "const": "https://schema.twindev.org/aig/"
17842
+ },
17843
+ {
17844
+ "const": "https://schema.twindev.org/common/"
17845
+ }
17846
+ ],
17847
+ "items": {
17848
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
17849
+ },
17850
+ "minItems": 2,
17851
+ "description": "JSON-LD Context."
17852
+ },
17853
+ "type": {
17854
+ "const": "AuditableItemGraphVertex",
17855
+ "description": "JSON-LD Type."
17856
+ },
17857
+ "organizationIdentity": {
17858
+ "type": "string",
17859
+ "description": "The identity of the organization which controls the vertex."
17860
+ },
18237
17861
  "annotationObject": {
18238
17862
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18239
17863
  },
18240
17864
  "aliases": {
18241
17865
  "type": "array",
18242
17866
  "items": {
18243
- "type": "object",
18244
- "properties": {
18245
- "id": {
18246
- "type": "string"
18247
- },
18248
- "aliasFormat": {
18249
- "type": "string"
18250
- },
18251
- "unique": {
18252
- "type": "boolean"
18253
- },
18254
- "annotationObject": {
18255
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18256
- }
18257
- },
18258
- "required": [
18259
- "id"
18260
- ],
18261
- "additionalProperties": false
17867
+ "$ref": "https://schema.twindev.org/aig/AuditableItemGraphAlias"
18262
17868
  },
18263
17869
  "description": "Alternative aliases that can be used to identify the vertex."
18264
17870
  },
18265
17871
  "resources": {
18266
17872
  "type": "array",
18267
17873
  "items": {
18268
- "type": "object",
18269
- "properties": {
18270
- "id": {
18271
- "type": "string"
18272
- },
18273
- "resourceObject": {
18274
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18275
- }
18276
- },
18277
- "additionalProperties": false
17874
+ "$ref": "https://schema.twindev.org/aig/AuditableItemGraphResource"
18278
17875
  },
18279
17876
  "description": "The resources attached to the vertex."
18280
17877
  },
18281
17878
  "edges": {
18282
17879
  "type": "array",
18283
17880
  "items": {
18284
- "type": "object",
18285
- "properties": {
18286
- "id": {
18287
- "type": "string"
18288
- },
18289
- "targetId": {
18290
- "type": "string"
18291
- },
18292
- "edgeRelationships": {
18293
- "type": "array",
18294
- "items": {
18295
- "type": "string"
18296
- }
18297
- },
18298
- "annotationObject": {
18299
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18300
- }
18301
- },
18302
- "required": [
18303
- "targetId",
18304
- "edgeRelationships"
18305
- ],
18306
- "additionalProperties": false
17881
+ "$ref": "https://schema.twindev.org/aig/AuditableItemGraphEdge"
18307
17882
  },
18308
- "description": "The edges connected to the vertex."
17883
+ "description": "Edges connected to the vertex."
17884
+ },
17885
+ "verified": {
17886
+ "type": "boolean",
17887
+ "description": "Is the vertex verified, will only be populated when verification is requested."
18309
17888
  }
18310
17889
  },
18311
- "description": "The data to be used in the vertex."
17890
+ "required": [
17891
+ "@context",
17892
+ "type"
17893
+ ]
18312
17894
  },
18313
17895
  "AuditableItemStreamCreateEntryRequest": {
18314
17896
  "type": "object",
@@ -18322,35 +17904,6 @@
18322
17904
  ],
18323
17905
  "description": "The data to be used in the stream."
18324
17906
  },
18325
- "AuditableItemStreamCreateRequest": {
18326
- "type": "object",
18327
- "properties": {
18328
- "annotationObject": {
18329
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18330
- },
18331
- "entries": {
18332
- "type": "array",
18333
- "items": {
18334
- "type": "object",
18335
- "properties": {
18336
- "entryObject": {
18337
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18338
- }
18339
- },
18340
- "required": [
18341
- "entryObject"
18342
- ],
18343
- "additionalProperties": false
18344
- },
18345
- "description": "The entries for the stream."
18346
- },
18347
- "immutableInterval": {
18348
- "type": "number",
18349
- "description": "After how many entries do we add immutable checks, defaults to service configured value. A value of 0 will disable immutable checks, 1 will be every item, or any other integer for an interval."
18350
- }
18351
- },
18352
- "description": "The data to be used in the stream."
18353
- },
18354
17907
  "AuditableItemStreamUpdateEntryRequest": {
18355
17908
  "type": "object",
18356
17909
  "properties": {
@@ -18364,13 +17917,40 @@
18364
17917
  "description": "The data to be used in the entry."
18365
17918
  },
18366
17919
  "AuditableItemStreamUpdateRequest": {
17920
+ "description": "The data to be used in the stream, entries should be updated separately.",
18367
17921
  "type": "object",
18368
17922
  "properties": {
17923
+ "@context": {
17924
+ "type": "array",
17925
+ "prefixItems": [
17926
+ {
17927
+ "const": "https://schema.org"
17928
+ },
17929
+ {
17930
+ "const": "https://schema.twindev.org/ais/"
17931
+ },
17932
+ {
17933
+ "const": "https://schema.twindev.org/common/"
17934
+ }
17935
+ ],
17936
+ "items": {
17937
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
17938
+ },
17939
+ "minItems": 3,
17940
+ "description": "JSON-LD Context."
17941
+ },
17942
+ "type": {
17943
+ "const": "AuditableItemStream",
17944
+ "description": "JSON-LD Type."
17945
+ },
18369
17946
  "annotationObject": {
18370
17947
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18371
17948
  }
18372
17949
  },
18373
- "description": "The data to be used in the stream."
17950
+ "required": [
17951
+ "@context",
17952
+ "type"
17953
+ ]
18374
17954
  },
18375
17955
  "BlobStorageCreateRequest": {
18376
17956
  "type": "object",
@@ -18439,115 +18019,73 @@
18439
18019
  "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogError"
18440
18020
  }
18441
18021
  ],
18442
- "description": "The response payload containing the DS Protocol compliant catalog with participantId, or a CatalogError if no datasets are found (404). Per DS Protocol: Single participant returns flat catalog, multiple participants return nested catalogs."
18022
+ "description": "The response payload containing the DS Protocol compliant catalog with participantId,\nor a CatalogError if no datasets are found (404).\nPer DS Protocol: Single participant returns flat catalog, multiple participants return nested catalogs."
18443
18023
  },
18444
18024
  "CoerceType": {
18025
+ "description": "The types the extracted data can be coerced to.",
18445
18026
  "anyOf": [
18446
18027
  {
18447
- "type": "string",
18448
18028
  "const": "string",
18449
18029
  "description": "String."
18450
18030
  },
18451
18031
  {
18452
- "type": "string",
18453
18032
  "const": "number",
18454
18033
  "description": "Number."
18455
18034
  },
18456
18035
  {
18457
- "type": "string",
18458
18036
  "const": "integer",
18459
18037
  "description": "Integer."
18460
18038
  },
18461
18039
  {
18462
- "type": "string",
18463
18040
  "const": "boolean",
18464
18041
  "description": "Boolean."
18465
18042
  },
18466
18043
  {
18467
- "type": "string",
18468
18044
  "const": "bigint",
18469
18045
  "description": "Big Integer."
18470
18046
  },
18471
18047
  {
18472
- "type": "string",
18473
18048
  "const": "date",
18474
18049
  "description": "Date."
18475
18050
  },
18476
18051
  {
18477
- "type": "string",
18478
18052
  "const": "datetime",
18479
18053
  "description": "Date Time."
18480
18054
  },
18481
18055
  {
18482
- "type": "string",
18483
18056
  "const": "time",
18484
18057
  "description": "Time."
18485
18058
  },
18486
18059
  {
18487
- "type": "string",
18488
18060
  "const": "object",
18489
18061
  "description": "Object."
18490
18062
  },
18491
18063
  {
18492
- "type": "string",
18493
18064
  "const": "uint8array",
18494
18065
  "description": "Uint8Array."
18495
18066
  }
18496
- ],
18497
- "description": "The types the extracted data can be coerced to."
18067
+ ]
18498
18068
  },
18499
- "ConflictResponse": {
18500
- "type": "object",
18501
- "properties": {
18502
- "conflicts": {
18503
- "type": "array",
18504
- "items": {
18505
- "type": "string"
18506
- },
18507
- "description": "The conflicting items."
18508
- },
18509
- "name": {
18510
- "type": "string",
18511
- "description": "The name for the error."
18512
- },
18513
- "message": {
18514
- "type": "string",
18515
- "description": "The message for the error."
18516
- },
18517
- "source": {
18518
- "type": "string",
18519
- "description": "The source of the error."
18520
- },
18521
- "properties": {
18522
- "type": "object",
18523
- "additionalProperties": {},
18524
- "description": "Any additional information for the error."
18525
- },
18526
- "stack": {
18527
- "type": "string",
18528
- "description": "The stack trace for the error."
18069
+ "CompleteTransferResponse": {
18070
+ "oneOf": [
18071
+ {
18072
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess"
18529
18073
  },
18530
- "cause": {
18531
- "$ref": "#/components/schemas/Error"
18074
+ {
18075
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
18532
18076
  }
18533
- },
18534
- "required": [
18535
- "conflicts",
18536
- "message",
18537
- "name"
18538
18077
  ],
18539
- "description": "The body which contains the error."
18078
+ "description": "Transfer Process (DSP compliant) with state COMPLETED, or error."
18540
18079
  },
18541
18080
  "DataAssetItemList": {
18081
+ "description": "Interface describing a list of entities that are within a Data Asset.\nPagination is handled via HTTP Link headers.",
18542
18082
  "type": "object",
18543
18083
  "properties": {
18544
18084
  "@context": {
18545
- "type": "string",
18546
18085
  "const": "https://schema.org",
18547
18086
  "description": "The LD Context."
18548
18087
  },
18549
18088
  "type": {
18550
- "type": "string",
18551
18089
  "const": "ItemList",
18552
18090
  "description": "The type"
18553
18091
  },
@@ -18563,15 +18101,14 @@
18563
18101
  "@context",
18564
18102
  "type",
18565
18103
  "itemListElement"
18566
- ],
18567
- "description": "Interface describing a list of entities that are within a Data Asset. Pagination is handled via HTTP Link headers."
18104
+ ]
18568
18105
  },
18569
18106
  "DataAssetQueryRequest": {
18570
18107
  "type": "object",
18571
18108
  "properties": {
18572
18109
  "consumerPid": {
18573
18110
  "type": "string",
18574
- "description": "The consumer Process ID from the DSP Transfer Process. Mandatory - used to determine the Dataset, Distribution, and Agreement. The datasetId is resolved from the Transfer Process using this ID."
18111
+ "description": "The consumer Process ID from the DSP Transfer Process.\nMandatory - used to determine the Dataset, Distribution, and Agreement.\nThe datasetId is resolved from the Transfer Process using this ID."
18575
18112
  },
18576
18113
  "query": {
18577
18114
  "$ref": "#/components/schemas/FilteringQuery"
@@ -18630,7 +18167,7 @@
18630
18167
  "description": "The params for the extract."
18631
18168
  },
18632
18169
  "DataProcessingExtractResponse": {
18633
- "description": "The extracted data in extended JSON format which keeps types like bigint, dates and uint8array intact. Use ObjectHelper.fromExtended to get the object with original types."
18170
+ "description": "The extracted data in extended JSON format which keeps types like bigint, dates and uint8array intact.\nUse ObjectHelper.fromExtended to get the object with original types."
18634
18171
  },
18635
18172
  "DataProcessingRuleGroupListResponse": {
18636
18173
  "type": "object",
@@ -18711,8 +18248,7 @@
18711
18248
  },
18712
18249
  "required": [
18713
18250
  "targetId"
18714
- ],
18715
- "additionalProperties": false
18251
+ ]
18716
18252
  },
18717
18253
  "description": "The auditable item graph vertices to connect the document to."
18718
18254
  },
@@ -18730,6 +18266,7 @@
18730
18266
  },
18731
18267
  "required": [
18732
18268
  "documentId",
18269
+ "documentIdFormat",
18733
18270
  "documentCode",
18734
18271
  "blob"
18735
18272
  ],
@@ -18762,8 +18299,7 @@
18762
18299
  },
18763
18300
  "required": [
18764
18301
  "targetId"
18765
- ],
18766
- "additionalProperties": false
18302
+ ]
18767
18303
  },
18768
18304
  "description": "The auditable item graph vertices to connect the document to."
18769
18305
  }
@@ -18771,6 +18307,7 @@
18771
18307
  "description": "The body parameters."
18772
18308
  },
18773
18309
  "Error": {
18310
+ "description": "Model to describe serialized error.",
18774
18311
  "type": "object",
18775
18312
  "properties": {
18776
18313
  "name": {
@@ -18801,10 +18338,10 @@
18801
18338
  "required": [
18802
18339
  "name",
18803
18340
  "message"
18804
- ],
18805
- "description": "Model to describe serialized error."
18341
+ ]
18806
18342
  },
18807
18343
  "FilteringQuery": {
18344
+ "description": "A query over a data asset that to be processed by a Dataspace Data Plane App.",
18808
18345
  "type": "object",
18809
18346
  "properties": {
18810
18347
  "type": {
@@ -18825,8 +18362,7 @@
18825
18362
  "required": [
18826
18363
  "type",
18827
18364
  "q"
18828
- ],
18829
- "description": "A query over a data asset that to be processed by a Dataspace Data Plane App."
18365
+ ]
18830
18366
  },
18831
18367
  "GetDatasetResponse": {
18832
18368
  "anyOf": [
@@ -18839,7 +18375,19 @@
18839
18375
  ],
18840
18376
  "description": "The response payload containing the dataset or error."
18841
18377
  },
18378
+ "GetTransferProcessResponse": {
18379
+ "oneOf": [
18380
+ {
18381
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess"
18382
+ },
18383
+ {
18384
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
18385
+ }
18386
+ ],
18387
+ "description": "Transfer Process (DSP compliant) with current state, or error."
18388
+ },
18842
18389
  "HealthComponentInfo": {
18390
+ "description": "The health component information.",
18843
18391
  "type": "object",
18844
18392
  "properties": {
18845
18393
  "name": {
@@ -18857,10 +18405,10 @@
18857
18405
  "required": [
18858
18406
  "name",
18859
18407
  "status"
18860
- ],
18861
- "description": "The health component information."
18408
+ ]
18862
18409
  },
18863
18410
  "HealthInfo": {
18411
+ "description": "The status of the server.",
18864
18412
  "type": "object",
18865
18413
  "properties": {
18866
18414
  "status": {
@@ -18876,28 +18424,24 @@
18876
18424
  },
18877
18425
  "required": [
18878
18426
  "status"
18879
- ],
18880
- "description": "The status of the server."
18427
+ ]
18881
18428
  },
18882
18429
  "HealthStatus": {
18430
+ "description": "The health status of the component.",
18883
18431
  "anyOf": [
18884
18432
  {
18885
- "type": "string",
18886
18433
  "const": "ok",
18887
18434
  "description": "OK."
18888
18435
  },
18889
18436
  {
18890
- "type": "string",
18891
18437
  "const": "warning",
18892
18438
  "description": "Warning."
18893
18439
  },
18894
18440
  {
18895
- "type": "string",
18896
18441
  "const": "error",
18897
18442
  "description": "Error."
18898
18443
  }
18899
- ],
18900
- "description": "The health status of the component."
18444
+ ]
18901
18445
  },
18902
18446
  "IdentityCreateRequest": {
18903
18447
  "type": "object",
@@ -18921,18 +18465,13 @@
18921
18465
  },
18922
18466
  "description": "The data for the request."
18923
18467
  },
18468
+ "IdentityProfileGetPublicResponse": {},
18924
18469
  "IdentityProfileGetResponse": {
18925
18470
  "type": "object",
18926
18471
  "properties": {
18927
18472
  "identity": {
18928
18473
  "type": "string",
18929
18474
  "description": "The identity of the profile, this is the authenticated user identity."
18930
- },
18931
- "publicProfile": {
18932
- "$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
18933
- },
18934
- "privateProfile": {
18935
- "$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
18936
18475
  }
18937
18476
  },
18938
18477
  "required": [
@@ -18951,15 +18490,11 @@
18951
18490
  "identity": {
18952
18491
  "type": "string",
18953
18492
  "description": "The identity."
18954
- },
18955
- "publicProfile": {
18956
- "$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
18957
18493
  }
18958
18494
  },
18959
18495
  "required": [
18960
18496
  "identity"
18961
- ],
18962
- "additionalProperties": false
18497
+ ]
18963
18498
  },
18964
18499
  "description": "The identities."
18965
18500
  },
@@ -19246,6 +18781,7 @@
19246
18781
  "description": "The parameters from the body."
19247
18782
  },
19248
18783
  "LogEntry": {
18784
+ "description": "Interface describing a log entry.",
19249
18785
  "type": "object",
19250
18786
  "properties": {
19251
18787
  "level": {
@@ -19276,38 +18812,32 @@
19276
18812
  "level",
19277
18813
  "source",
19278
18814
  "message"
19279
- ],
19280
- "description": "Interface describing a log entry."
18815
+ ]
19281
18816
  },
19282
18817
  "LogLevel": {
18818
+ "description": "The log levels.",
19283
18819
  "anyOf": [
19284
18820
  {
19285
- "type": "string",
19286
18821
  "const": "info",
19287
18822
  "description": "Info."
19288
18823
  },
19289
18824
  {
19290
- "type": "string",
19291
18825
  "const": "error",
19292
18826
  "description": "Error."
19293
18827
  },
19294
18828
  {
19295
- "type": "string",
19296
18829
  "const": "warn",
19297
18830
  "description": "Warn."
19298
18831
  },
19299
18832
  {
19300
- "type": "string",
19301
18833
  "const": "trace",
19302
18834
  "description": "Trace."
19303
18835
  },
19304
18836
  {
19305
- "type": "string",
19306
18837
  "const": "debug",
19307
18838
  "description": "Debug."
19308
18839
  }
19309
- ],
19310
- "description": "The log levels."
18840
+ ]
19311
18841
  },
19312
18842
  "LoggingListResponse": {
19313
18843
  "type": "object",
@@ -19361,24 +18891,21 @@
19361
18891
  "description": "The login response details."
19362
18892
  },
19363
18893
  "MetricType": {
18894
+ "description": "The types of metrics.",
19364
18895
  "anyOf": [
19365
18896
  {
19366
- "type": "number",
19367
18897
  "const": 0,
19368
18898
  "description": "Counter."
19369
18899
  },
19370
18900
  {
19371
- "type": "number",
19372
18901
  "const": 1,
19373
18902
  "description": "Increment Decrement Counter."
19374
18903
  },
19375
18904
  {
19376
- "type": "number",
19377
18905
  "const": 2,
19378
18906
  "description": "Gauge."
19379
18907
  }
19380
- ],
19381
- "description": "The types of metrics."
18908
+ ]
19382
18909
  },
19383
18910
  "NftMintRequest": {
19384
18911
  "type": "object",
@@ -19468,37 +18995,227 @@
19468
18995
  "notFoundId": {
19469
18996
  "type": "string",
19470
18997
  "description": "The id if the item that was not found."
18998
+ }
18999
+ },
19000
+ "allOf": [
19001
+ {
19002
+ "$ref": "#/components/schemas/Error"
19003
+ }
19004
+ ],
19005
+ "description": "The body which contains the error."
19006
+ },
19007
+ "PapCreateRequest": {
19008
+ "description": "The body of the request - the policy to create (id will be auto-generated if not provided).",
19009
+ "type": "object",
19010
+ "properties": {
19011
+ "@context": {
19012
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlContextType"
19471
19013
  },
19472
- "name": {
19473
- "type": "string",
19474
- "description": "The name for the error."
19014
+ "@type": {
19015
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicyType"
19475
19016
  },
19476
- "message": {
19477
- "type": "string",
19478
- "description": "The message for the error."
19017
+ "profile": {
19018
+ "anyOf": [
19019
+ {
19020
+ "type": "string"
19021
+ },
19022
+ {
19023
+ "type": "array",
19024
+ "items": {
19025
+ "type": "string"
19026
+ }
19027
+ }
19028
+ ],
19029
+ "description": "The profile(s) this policy conforms to.\nIRIs identifying the ODRL Profile(s)."
19479
19030
  },
19480
- "source": {
19481
- "type": "string",
19482
- "description": "The source of the error."
19031
+ "assigner": {
19032
+ "anyOf": [
19033
+ {
19034
+ "type": "string"
19035
+ },
19036
+ {
19037
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
19038
+ },
19039
+ {
19040
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
19041
+ },
19042
+ {
19043
+ "type": "array",
19044
+ "items": {
19045
+ "anyOf": [
19046
+ {
19047
+ "type": "string"
19048
+ },
19049
+ {
19050
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
19051
+ },
19052
+ {
19053
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
19054
+ }
19055
+ ]
19056
+ }
19057
+ }
19058
+ ],
19059
+ "description": "The assigner of the policy.\nApplies to all rules unless overridden at rule level."
19483
19060
  },
19484
- "properties": {
19485
- "type": "object",
19486
- "additionalProperties": {},
19487
- "description": "Any additional information for the error."
19061
+ "assignee": {
19062
+ "anyOf": [
19063
+ {
19064
+ "type": "string"
19065
+ },
19066
+ {
19067
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
19068
+ },
19069
+ {
19070
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
19071
+ },
19072
+ {
19073
+ "type": "array",
19074
+ "items": {
19075
+ "anyOf": [
19076
+ {
19077
+ "type": "string"
19078
+ },
19079
+ {
19080
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
19081
+ },
19082
+ {
19083
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
19084
+ }
19085
+ ]
19086
+ }
19087
+ }
19088
+ ],
19089
+ "description": "The assignee of the policy.\nApplies to all rules unless overridden at rule level."
19488
19090
  },
19489
- "stack": {
19490
- "type": "string",
19491
- "description": "The stack trace for the error."
19091
+ "target": {
19092
+ "anyOf": [
19093
+ {
19094
+ "type": "string"
19095
+ },
19096
+ {
19097
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
19098
+ },
19099
+ {
19100
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
19101
+ },
19102
+ {
19103
+ "type": "array",
19104
+ "items": {
19105
+ "anyOf": [
19106
+ {
19107
+ "type": "string"
19108
+ },
19109
+ {
19110
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
19111
+ },
19112
+ {
19113
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
19114
+ }
19115
+ ]
19116
+ }
19117
+ }
19118
+ ],
19119
+ "description": "The target asset for the rule."
19492
19120
  },
19493
- "cause": {
19494
- "$ref": "#/components/schemas/Error"
19121
+ "action": {
19122
+ "anyOf": [
19123
+ {
19124
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
19125
+ },
19126
+ {
19127
+ "type": "string"
19128
+ },
19129
+ {
19130
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
19131
+ },
19132
+ {
19133
+ "type": "array",
19134
+ "items": {
19135
+ "anyOf": [
19136
+ {
19137
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
19138
+ },
19139
+ {
19140
+ "type": "string"
19141
+ },
19142
+ {
19143
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
19144
+ }
19145
+ ]
19146
+ }
19147
+ }
19148
+ ],
19149
+ "description": "The action associated with the rule."
19150
+ },
19151
+ "inheritFrom": {
19152
+ "anyOf": [
19153
+ {
19154
+ "type": "string"
19155
+ },
19156
+ {
19157
+ "type": "array",
19158
+ "items": {
19159
+ "type": "string"
19160
+ }
19161
+ }
19162
+ ],
19163
+ "description": "The parent policy(ies) this policy inherits from.\nIRIs identifying the parent Policy(ies)."
19164
+ },
19165
+ "conflict": {
19166
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlConflictStrategyType"
19167
+ },
19168
+ "permission": {
19169
+ "anyOf": [
19170
+ {
19171
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
19172
+ },
19173
+ {
19174
+ "type": "array",
19175
+ "items": {
19176
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
19177
+ }
19178
+ }
19179
+ ],
19180
+ "description": "The permissions in the policy.\nAt least one of permission, prohibition, or obligation must be present."
19181
+ },
19182
+ "prohibition": {
19183
+ "anyOf": [
19184
+ {
19185
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
19186
+ },
19187
+ {
19188
+ "type": "array",
19189
+ "items": {
19190
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
19191
+ }
19192
+ }
19193
+ ],
19194
+ "description": "The prohibitions in the policy.\nAt least one of permission, prohibition, or obligation must be present."
19195
+ },
19196
+ "obligation": {
19197
+ "anyOf": [
19198
+ {
19199
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
19200
+ },
19201
+ {
19202
+ "type": "array",
19203
+ "items": {
19204
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
19205
+ }
19206
+ }
19207
+ ],
19208
+ "description": "The obligations in the policy.\nAt least one of permission, prohibition, or obligation must be present."
19209
+ },
19210
+ "@id": {
19211
+ "type": "string",
19212
+ "description": "Unique identifier for the policy."
19495
19213
  }
19496
19214
  },
19497
19215
  "required": [
19498
- "message",
19499
- "name"
19500
- ],
19501
- "description": "The body which contains the error."
19216
+ "@context",
19217
+ "@type"
19218
+ ]
19502
19219
  },
19503
19220
  "PapQueryResponse": {
19504
19221
  "type": "array",
@@ -19515,7 +19232,7 @@
19515
19232
  "description": "The body of the response."
19516
19233
  },
19517
19234
  "PnpContractNegotiationResponse": {
19518
- "anyOf": [
19235
+ "oneOf": [
19519
19236
  {
19520
19237
  "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiation"
19521
19238
  },
@@ -19526,6 +19243,7 @@
19526
19243
  "description": "The state of the policy or an error."
19527
19244
  },
19528
19245
  "PolicyNegotiation": {
19246
+ "description": "Interface describing a rights management policy negotiation.",
19529
19247
  "type": "object",
19530
19248
  "properties": {
19531
19249
  "id": {
@@ -19555,6 +19273,10 @@
19555
19273
  "type": "string",
19556
19274
  "description": "The callback address to send updates to the requester."
19557
19275
  },
19276
+ "publicOrigin": {
19277
+ "type": "string",
19278
+ "description": "The public origin of the server that initiated or received this negotiation.\nUsed to construct callback URLs in subsequent async messages."
19279
+ },
19558
19280
  "organizationIdentity": {
19559
19281
  "type": "string",
19560
19282
  "description": "Organization identity to be used when sending trust payloads."
@@ -19586,8 +19308,7 @@
19586
19308
  },
19587
19309
  "required": [
19588
19310
  "@value"
19589
- ],
19590
- "additionalProperties": false
19311
+ ]
19591
19312
  },
19592
19313
  "description": "A more detailed reason for the negotiation error."
19593
19314
  },
@@ -19605,8 +19326,7 @@
19605
19326
  },
19606
19327
  "required": [
19607
19328
  "@value"
19608
- ],
19609
- "additionalProperties": false
19329
+ ]
19610
19330
  },
19611
19331
  "description": "A more detailed reason for the negotiation error."
19612
19332
  },
@@ -19628,8 +19348,7 @@
19628
19348
  "dateCreated",
19629
19349
  "state",
19630
19350
  "organizationIdentity"
19631
- ],
19632
- "description": "Interface describing a rights management policy negotiation."
19351
+ ]
19633
19352
  },
19634
19353
  "RefreshTokenResponse": {
19635
19354
  "type": "object",
@@ -19644,16 +19363,28 @@
19644
19363
  ],
19645
19364
  "description": "The refresh token details."
19646
19365
  },
19366
+ "RequestTransferResponse": {
19367
+ "oneOf": [
19368
+ {
19369
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess"
19370
+ },
19371
+ {
19372
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
19373
+ }
19374
+ ],
19375
+ "description": "Transfer Process (DSP compliant) with state REQUESTED, or error."
19376
+ },
19647
19377
  "Rule": {
19378
+ "description": "Rule defining how to extract data from an object.",
19648
19379
  "type": "object",
19649
19380
  "properties": {
19650
19381
  "source": {
19651
19382
  "type": "string",
19652
- "description": "The path to the data in the document to extract. should be in JSONPath format https://www.rfc-editor.org/rfc/rfc9535.html."
19383
+ "description": "The path to the data in the document to extract.\nshould be in JSONPath format https://www.rfc-editor.org/rfc/rfc9535.html."
19653
19384
  },
19654
19385
  "target": {
19655
19386
  "type": "string",
19656
- "description": "The target path of where to store the extracted data. Supports simple dotted path notation, and numeric index notation."
19387
+ "description": "The target path of where to store the extracted data.\nSupports simple dotted path notation, and numeric index notation."
19657
19388
  },
19658
19389
  "retainPathDepth": {
19659
19390
  "type": "number",
@@ -19666,10 +19397,10 @@
19666
19397
  "required": [
19667
19398
  "source",
19668
19399
  "target"
19669
- ],
19670
- "description": "Rule defining how to extract data from an object."
19400
+ ]
19671
19401
  },
19672
19402
  "RuleGroup": {
19403
+ "description": "Group of rules for extraction.",
19673
19404
  "type": "object",
19674
19405
  "properties": {
19675
19406
  "id": {
@@ -19692,10 +19423,17 @@
19692
19423
  "id",
19693
19424
  "label",
19694
19425
  "rules"
19695
- ],
19696
- "description": "Group of rules for extraction."
19426
+ ]
19427
+ },
19428
+ "ServerFavIconResponse": {
19429
+ "type": "array",
19430
+ "items": {
19431
+ "type": "number"
19432
+ },
19433
+ "description": "The favicon for the server."
19697
19434
  },
19698
19435
  "ServerInfo": {
19436
+ "description": "The information about the server.",
19699
19437
  "type": "object",
19700
19438
  "properties": {
19701
19439
  "name": {
@@ -19710,14 +19448,16 @@
19710
19448
  "required": [
19711
19449
  "name",
19712
19450
  "version"
19713
- ],
19714
- "description": "The information about the server."
19451
+ ]
19715
19452
  },
19716
19453
  "ServerLivezResponse": {
19717
- "type": "string",
19718
- "enum": [
19719
- "ok",
19720
- "failed"
19454
+ "anyOf": [
19455
+ {
19456
+ "const": "ok"
19457
+ },
19458
+ {
19459
+ "const": "failed"
19460
+ }
19721
19461
  ],
19722
19462
  "description": "The livez information for the server."
19723
19463
  },
@@ -19729,21 +19469,42 @@
19729
19469
  "description": "The spec for the server."
19730
19470
  },
19731
19471
  "SortDirection": {
19472
+ "description": "The sort directions.",
19732
19473
  "anyOf": [
19733
19474
  {
19734
- "type": "string",
19735
19475
  "const": "asc",
19736
19476
  "description": "Ascending."
19737
19477
  },
19738
19478
  {
19739
- "type": "string",
19740
19479
  "const": "desc",
19741
19480
  "description": "Descending."
19742
19481
  }
19482
+ ]
19483
+ },
19484
+ "StartTransferResponse": {
19485
+ "oneOf": [
19486
+ {
19487
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferStartMessage"
19488
+ },
19489
+ {
19490
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
19491
+ }
19492
+ ],
19493
+ "description": "Transfer Start Message (DSP compliant) with dataAddress for PULL transfers, or error."
19494
+ },
19495
+ "SuspendTransferResponse": {
19496
+ "oneOf": [
19497
+ {
19498
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess"
19499
+ },
19500
+ {
19501
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
19502
+ }
19743
19503
  ],
19744
- "description": "The sort directions."
19504
+ "description": "Transfer Process (DSP compliant) with state SUSPENDED, or error."
19745
19505
  },
19746
19506
  "SyncChange": {
19507
+ "description": "The object definition for a sync change.",
19747
19508
  "type": "object",
19748
19509
  "properties": {
19749
19510
  "operation": {
@@ -19760,34 +19521,30 @@
19760
19521
  "required": [
19761
19522
  "operation",
19762
19523
  "id"
19763
- ],
19764
- "description": "The object definition for a sync change."
19524
+ ]
19765
19525
  },
19766
19526
  "SyncChangeOperation": {
19527
+ "description": "The operations for a change",
19767
19528
  "anyOf": [
19768
19529
  {
19769
- "type": "string",
19770
19530
  "const": "set",
19771
19531
  "description": "An item was set in the storage."
19772
19532
  },
19773
19533
  {
19774
- "type": "string",
19775
19534
  "const": "delete",
19776
19535
  "description": "An item was deleted from the storage."
19777
19536
  }
19778
- ],
19779
- "description": "The operations for a change. The operations for a change"
19537
+ ]
19780
19538
  },
19781
19539
  "SyncChangeSet": {
19540
+ "description": "The object definition for a sync change set.",
19782
19541
  "type": "object",
19783
19542
  "properties": {
19784
19543
  "@context": {
19785
- "type": "string",
19786
19544
  "const": "https://schema.twindev.org/synchronised-storage/",
19787
19545
  "description": "The LD Context for the change set."
19788
19546
  },
19789
19547
  "type": {
19790
- "type": "string",
19791
19548
  "const": "ChangeSet",
19792
19549
  "description": "The LD Type for the change set."
19793
19550
  },
@@ -19797,26 +19554,26 @@
19797
19554
  },
19798
19555
  "storageKey": {
19799
19556
  "type": "string",
19800
- "description": "The storage key of the change set. This is used to identify the entities being synchronised. json-ld type:schema:identifier"
19557
+ "description": "The storage key of the change set. This is used to identify the entities being synchronised."
19801
19558
  },
19802
19559
  "dateCreated": {
19803
19560
  "type": "string",
19804
- "description": "The date the change set was created. json-ld namespace:schema"
19561
+ "description": "The date the change set was created."
19805
19562
  },
19806
19563
  "dateModified": {
19807
19564
  "type": "string",
19808
- "description": "The date the change set was last modified. json-ld namespace:schema"
19565
+ "description": "The date the change set was last modified."
19809
19566
  },
19810
19567
  "nodeIdentity": {
19811
19568
  "type": "string",
19812
- "description": "The identity of the node that created the change set. json-ld namespace:twin-common"
19569
+ "description": "The identity of the node that created the change set."
19813
19570
  },
19814
19571
  "changes": {
19815
19572
  "type": "array",
19816
19573
  "items": {
19817
19574
  "$ref": "#/components/schemas/SyncChange"
19818
19575
  },
19819
- "description": "The changes to apply after a snapshot. json-ld type:json"
19576
+ "description": "The changes to apply after a snapshot."
19820
19577
  }
19821
19578
  },
19822
19579
  "required": [
@@ -19828,8 +19585,7 @@
19828
19585
  "dateModified",
19829
19586
  "nodeIdentity",
19830
19587
  "changes"
19831
- ],
19832
- "description": "The object definition for a sync change set."
19588
+ ]
19833
19589
  },
19834
19590
  "SyncDecryptionKeyResponse": {
19835
19591
  "type": "object",
@@ -19845,19 +19601,20 @@
19845
19601
  "description": "The body of the response."
19846
19602
  },
19847
19603
  "SynchronisedEntityCore": {
19604
+ "description": "The base definition for synchronised entries.",
19848
19605
  "type": "object",
19849
19606
  "properties": {
19850
19607
  "dateModified": {
19851
19608
  "type": "string",
19852
- "description": "The date the entry was modified. json-ld namespace:schema"
19609
+ "description": "The date the entry was modified."
19853
19610
  }
19854
19611
  },
19855
19612
  "required": [
19856
19613
  "dateModified"
19857
- ],
19858
- "description": "The base definition for synchronised entries."
19614
+ ]
19859
19615
  },
19860
19616
  "TaskApp": {
19617
+ "description": "Denotes a task associated with a Dataspace App",
19861
19618
  "type": "object",
19862
19619
  "properties": {
19863
19620
  "taskId": {
@@ -19872,8 +19629,7 @@
19872
19629
  "required": [
19873
19630
  "taskId",
19874
19631
  "dataspaceAppId"
19875
- ],
19876
- "description": "Denotes a task associated with a Dataspace App"
19632
+ ]
19877
19633
  },
19878
19634
  "TelemetryAddMetricValueRequest": {
19879
19635
  "type": "object",
@@ -19881,11 +19637,9 @@
19881
19637
  "value": {
19882
19638
  "anyOf": [
19883
19639
  {
19884
- "type": "string",
19885
19640
  "const": "inc"
19886
19641
  },
19887
19642
  {
19888
- "type": "string",
19889
19643
  "const": "dec"
19890
19644
  },
19891
19645
  {
@@ -19942,6 +19696,7 @@
19942
19696
  "description": "The response payload."
19943
19697
  },
19944
19698
  "TelemetryMetric": {
19699
+ "description": "Interface describing a telemetry metric.",
19945
19700
  "type": "object",
19946
19701
  "properties": {
19947
19702
  "id": {
@@ -19968,10 +19723,10 @@
19968
19723
  "id",
19969
19724
  "label",
19970
19725
  "type"
19971
- ],
19972
- "description": "Interface describing a telemetry metric."
19726
+ ]
19973
19727
  },
19974
19728
  "TelemetryMetricValue": {
19729
+ "description": "Interface describing a telemetry metric value.",
19975
19730
  "type": "object",
19976
19731
  "properties": {
19977
19732
  "id": {
@@ -19996,8 +19751,7 @@
19996
19751
  "id",
19997
19752
  "ts",
19998
19753
  "value"
19999
- ],
20000
- "description": "Interface describing a telemetry metric value."
19754
+ ]
20001
19755
  },
20002
19756
  "TelemetryUpdateMetricRequest": {
20003
19757
  "type": "object",
@@ -20044,7 +19798,19 @@
20044
19798
  ],
20045
19799
  "description": "The response payload."
20046
19800
  },
19801
+ "TerminateTransferResponse": {
19802
+ "oneOf": [
19803
+ {
19804
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess"
19805
+ },
19806
+ {
19807
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
19808
+ }
19809
+ ],
19810
+ "description": "Transfer Process (DSP compliant) with state TERMINATED, or error."
19811
+ },
20047
19812
  "TrustVerificationInfo": {
19813
+ "description": "Interface describing a trust verifier information.",
20048
19814
  "type": "object",
20049
19815
  "properties": {
20050
19816
  "identity": {
@@ -20061,8 +19827,7 @@
20061
19827
  },
20062
19828
  "required": [
20063
19829
  "identity"
20064
- ],
20065
- "description": "Interface describing a trust verifier information."
19830
+ ]
20066
19831
  },
20067
19832
  "UpdatePasswordRequest": {
20068
19833
  "type": "object",
@@ -20185,24 +19950,21 @@
20185
19950
  "description": "The data to be updated."
20186
19951
  },
20187
19952
  "VerifyDepth": {
19953
+ "description": "How deep to verify the signatures.",
20188
19954
  "anyOf": [
20189
19955
  {
20190
- "type": "string",
20191
19956
  "const": "none",
20192
19957
  "description": "Do not verify any signatures."
20193
19958
  },
20194
19959
  {
20195
- "type": "string",
20196
19960
  "const": "current",
20197
19961
  "description": "Verify only the most recent signature."
20198
19962
  },
20199
19963
  {
20200
- "type": "string",
20201
19964
  "const": "all",
20202
19965
  "description": "Verify all the signatures."
20203
19966
  }
20204
- ],
20205
- "description": "How deep to verify the signatures."
19967
+ ]
20206
19968
  }
20207
19969
  },
20208
19970
  "securitySchemes": {