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

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.
@@ -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": {
@@ -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"
@@ -9768,11 +9767,16 @@
9768
9767
  "in": "query",
9769
9768
  "required": false,
9770
9769
  "schema": {
9771
- "type": "string",
9772
- "enum": [
9773
- "id",
9774
- "alias",
9775
- "both"
9770
+ "anyOf": [
9771
+ {
9772
+ "const": "id"
9773
+ },
9774
+ {
9775
+ "const": "alias"
9776
+ },
9777
+ {
9778
+ "const": "both"
9779
+ }
9776
9780
  ]
9777
9781
  }
9778
9782
  },
@@ -9809,7 +9813,6 @@
9809
9813
  "in": "query",
9810
9814
  "required": false,
9811
9815
  "schema": {
9812
- "type": "string",
9813
9816
  "enum": [
9814
9817
  "dateCreated",
9815
9818
  "dateModified"
@@ -11059,7 +11062,6 @@
11059
11062
  "in": "query",
11060
11063
  "required": false,
11061
11064
  "schema": {
11062
- "type": "string",
11063
11065
  "enum": [
11064
11066
  "dateCreated",
11065
11067
  "dateModified"
@@ -11315,7 +11317,7 @@
11315
11317
  },
11316
11318
  {
11317
11319
  "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.",
11320
+ "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
11321
  "in": "query",
11320
11322
  "required": false,
11321
11323
  "schema": {
@@ -13668,7 +13670,7 @@
13668
13670
  },
13669
13671
  "responses": {
13670
13672
  "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.",
13673
+ "description": "The response payload for the catalog request method.\nReturns a DS Protocol compliant Catalog with participantId, or CatalogError if no datasets found.",
13672
13674
  "content": {
13673
13675
  "application/json": {
13674
13676
  "schema": {
@@ -13689,21 +13691,25 @@
13689
13691
  "@type": "Dataset",
13690
13692
  "dcterms:title": "Energy Consumption Data",
13691
13693
  "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"
13694
+ "hasPolicy": [
13695
+ {
13696
+ "@id": "urn:uuid:policy-456",
13697
+ "@type": "Offer",
13698
+ "assigner": "did:example:data-provider-789"
13705
13699
  }
13706
- }
13700
+ ],
13701
+ "distribution": [
13702
+ {
13703
+ "@id": "urn:uuid:distribution-789",
13704
+ "@type": "Distribution",
13705
+ "format": "application/json",
13706
+ "accessService": {
13707
+ "@id": "urn:uuid:access-service-321",
13708
+ "@type": "DataService",
13709
+ "endpointURL": "https://example.com/data-access"
13710
+ }
13711
+ }
13712
+ ]
13707
13713
  }
13708
13714
  ]
13709
13715
  }
@@ -13897,10 +13903,10 @@
13897
13903
  "content": {
13898
13904
  "application/ld+json": {
13899
13905
  "schema": {
13900
- "$ref": "#/components/schemas/ActivityStreamsActivity"
13906
+ "$ref": "https://schema.twindev.org/w3c-activity-streams/ActivityStreamsActivity"
13901
13907
  },
13902
13908
  "examples": {
13903
- "activityStreamNotifyExample": {
13909
+ "activityStreamNotifyRequestExample": {
13904
13910
  "value": {
13905
13911
  "@context": "https://www.w3.org/ns/activitystreams",
13906
13912
  "type": "Add",
@@ -14035,7 +14041,7 @@
14035
14041
  "$ref": "#/components/schemas/ActivityLogEntry"
14036
14042
  },
14037
14043
  "examples": {
14038
- "activityLogEntryResponseExample": {
14044
+ "activityLogEntryGetResponseExample": {
14039
14045
  "value": {
14040
14046
  "id": "urn:x-activity-log:134567",
14041
14047
  "dateCreated": "2025-08-12T12:00:00Z",
@@ -14208,7 +14214,7 @@
14208
14214
  "$ref": "#/components/schemas/DataAssetQueryRequest"
14209
14215
  },
14210
14216
  "examples": {
14211
- "dataAssetQuery": {
14217
+ "dataAssetQueryRequestExample": {
14212
14218
  "value": {
14213
14219
  "consumerPid": "urn:uuid:consumer-pid-12345",
14214
14220
  "query": {
@@ -14230,7 +14236,7 @@
14230
14236
  "$ref": "#/components/schemas/DataAssetItemList"
14231
14237
  },
14232
14238
  "examples": {
14233
- "dataAssetEntitiesGetResponseExample": {
14239
+ "dataAssetQueryResponseExample": {
14234
14240
  "value": {
14235
14241
  "@context": "https://schema.org",
14236
14242
  "type": "ItemList",
@@ -14296,13 +14302,74 @@
14296
14302
  "tags": [
14297
14303
  "Transfer Process"
14298
14304
  ],
14305
+ "parameters": [
14306
+ {
14307
+ "name": "authorization",
14308
+ "in": "header",
14309
+ "required": true,
14310
+ "schema": {
14311
+ "type": "string"
14312
+ },
14313
+ "style": "simple",
14314
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14315
+ }
14316
+ ],
14317
+ "requestBody": {
14318
+ "description": "API request for requesting a transfer process.",
14319
+ "required": true,
14320
+ "content": {
14321
+ "application/ld+json": {
14322
+ "schema": {
14323
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferRequestMessage"
14324
+ },
14325
+ "examples": {
14326
+ "requestTransferRequestExample": {
14327
+ "value": {
14328
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14329
+ "@type": "TransferRequestMessage",
14330
+ "processId": "urn:uuid:consumer-process-12345",
14331
+ "consumerPid": "urn:uuid:consumer-process-12345",
14332
+ "providerPid": "urn:uuid:provider-process-12345",
14333
+ "agreementId": "urn:uuid:agreement-12345",
14334
+ "dataAddress": {
14335
+ "@type": "DataAddress",
14336
+ "@id": "https://provider.example.com/data",
14337
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14338
+ "baseUrl": "https://provider.example.com/data"
14339
+ },
14340
+ "callbackAddress": "https://consumer.example.com/transfer/webhook",
14341
+ "format": "urn:example:format"
14342
+ }
14343
+ }
14344
+ }
14345
+ }
14346
+ }
14347
+ },
14299
14348
  "responses": {
14300
14349
  "200": {
14301
- "description": "The rest request ended in success with no data.",
14350
+ "description": "API response for requesting a transfer process.",
14302
14351
  "content": {
14303
- "text/plain": {
14352
+ "application/json": {
14304
14353
  "schema": {
14305
- "$ref": "#/components/schemas/OkResponse"
14354
+ "$ref": "#/components/schemas/RequestTransferResponse"
14355
+ },
14356
+ "examples": {
14357
+ "requestTransferResponseExample": {
14358
+ "value": {
14359
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14360
+ "@type": "TransferProcess",
14361
+ "processId": "urn:uuid:provider-process-12345",
14362
+ "consumerPid": "urn:uuid:consumer-process-12345",
14363
+ "providerPid": "urn:uuid:provider-process-12345",
14364
+ "state": "STARTED",
14365
+ "dataAddress": {
14366
+ "@type": "DataAddress",
14367
+ "@id": "https://provider.example.com/data/transfer-12345",
14368
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14369
+ "baseUrl": "https://provider.example.com/data/transfer-12345"
14370
+ }
14371
+ }
14372
+ }
14306
14373
  }
14307
14374
  }
14308
14375
  }
@@ -14359,22 +14426,51 @@
14359
14426
  "parameters": [
14360
14427
  {
14361
14428
  "name": "pid",
14362
- "description": "",
14429
+ "description": "Process ID (consumerPid or providerPid).",
14363
14430
  "in": "path",
14364
14431
  "required": true,
14365
14432
  "schema": {
14366
14433
  "type": "string"
14367
14434
  },
14368
- "style": "simple"
14435
+ "style": "simple",
14436
+ "example": "urn:uuid:provider-process-12345"
14437
+ },
14438
+ {
14439
+ "name": "authorization",
14440
+ "in": "header",
14441
+ "required": true,
14442
+ "schema": {
14443
+ "type": "string"
14444
+ },
14445
+ "style": "simple",
14446
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14369
14447
  }
14370
14448
  ],
14371
14449
  "responses": {
14372
14450
  "200": {
14373
- "description": "The rest request ended in success with no data.",
14451
+ "description": "API response for getting a transfer process state.",
14374
14452
  "content": {
14375
- "text/plain": {
14453
+ "application/json": {
14376
14454
  "schema": {
14377
- "$ref": "#/components/schemas/OkResponse"
14455
+ "$ref": "#/components/schemas/GetTransferProcessResponse"
14456
+ },
14457
+ "examples": {
14458
+ "getTransferProcessResponseExample": {
14459
+ "value": {
14460
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14461
+ "@type": "TransferProcess",
14462
+ "processId": "urn:uuid:provider-process-12345",
14463
+ "consumerPid": "urn:uuid:consumer-process-12345",
14464
+ "providerPid": "urn:uuid:provider-process-12345",
14465
+ "state": "STARTED",
14466
+ "dataAddress": {
14467
+ "@type": "DataAddress",
14468
+ "@id": "https://provider.example.com/data/transfer-12345",
14469
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14470
+ "baseUrl": "https://provider.example.com/data/transfer-12345"
14471
+ }
14472
+ }
14473
+ }
14378
14474
  }
14379
14475
  }
14380
14476
  }
@@ -14431,22 +14527,64 @@
14431
14527
  "parameters": [
14432
14528
  {
14433
14529
  "name": "pid",
14434
- "description": "",
14530
+ "description": "Process ID (consumerPid).",
14435
14531
  "in": "path",
14436
14532
  "required": true,
14437
14533
  "schema": {
14438
14534
  "type": "string"
14439
14535
  },
14440
- "style": "simple"
14536
+ "style": "simple",
14537
+ "example": "urn:uuid:consumer-process-12345"
14538
+ },
14539
+ {
14540
+ "name": "authorization",
14541
+ "in": "header",
14542
+ "required": true,
14543
+ "schema": {
14544
+ "type": "string"
14545
+ },
14546
+ "style": "simple",
14547
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14441
14548
  }
14442
14549
  ],
14550
+ "requestBody": {
14551
+ "description": "API request for starting a transfer process.",
14552
+ "required": true,
14553
+ "content": {
14554
+ "application/ld+json": {
14555
+ "schema": {
14556
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferStartMessage"
14557
+ },
14558
+ "examples": {
14559
+ "startTransferRequestExample": {
14560
+ "value": {
14561
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14562
+ "@type": "TransferStartMessage",
14563
+ "consumerPid": "urn:uuid:consumer-process-12345",
14564
+ "providerPid": "urn:uuid:provider-process-12345"
14565
+ }
14566
+ }
14567
+ }
14568
+ }
14569
+ }
14570
+ },
14443
14571
  "responses": {
14444
14572
  "200": {
14445
- "description": "The rest request ended in success with no data.",
14573
+ "description": "API response for starting a transfer process.",
14446
14574
  "content": {
14447
- "text/plain": {
14575
+ "application/json": {
14448
14576
  "schema": {
14449
- "$ref": "#/components/schemas/OkResponse"
14577
+ "$ref": "#/components/schemas/StartTransferResponse"
14578
+ },
14579
+ "examples": {
14580
+ "startTransferResponseExample": {
14581
+ "value": {
14582
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14583
+ "@type": "TransferStartMessage",
14584
+ "consumerPid": "urn:uuid:consumer-process-12345",
14585
+ "providerPid": "urn:uuid:provider-process-12345"
14586
+ }
14587
+ }
14450
14588
  }
14451
14589
  }
14452
14590
  }
@@ -14503,22 +14641,72 @@
14503
14641
  "parameters": [
14504
14642
  {
14505
14643
  "name": "pid",
14506
- "description": "",
14644
+ "description": "Process ID (consumerPid).",
14507
14645
  "in": "path",
14508
14646
  "required": true,
14509
14647
  "schema": {
14510
14648
  "type": "string"
14511
14649
  },
14512
- "style": "simple"
14650
+ "style": "simple",
14651
+ "example": "urn:uuid:consumer-process-12345"
14652
+ },
14653
+ {
14654
+ "name": "authorization",
14655
+ "in": "header",
14656
+ "required": true,
14657
+ "schema": {
14658
+ "type": "string"
14659
+ },
14660
+ "style": "simple",
14661
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14513
14662
  }
14514
14663
  ],
14664
+ "requestBody": {
14665
+ "description": "API request for completing a transfer process.",
14666
+ "required": true,
14667
+ "content": {
14668
+ "application/ld+json": {
14669
+ "schema": {
14670
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferCompletionMessage"
14671
+ },
14672
+ "examples": {
14673
+ "completeTransferRequestExample": {
14674
+ "value": {
14675
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14676
+ "@type": "TransferCompletionMessage",
14677
+ "consumerPid": "urn:uuid:consumer-process-12345",
14678
+ "providerPid": "urn:uuid:provider-process-12345"
14679
+ }
14680
+ }
14681
+ }
14682
+ }
14683
+ }
14684
+ },
14515
14685
  "responses": {
14516
14686
  "200": {
14517
- "description": "The rest request ended in success with no data.",
14687
+ "description": "API response for completing a transfer process.",
14518
14688
  "content": {
14519
- "text/plain": {
14689
+ "application/json": {
14520
14690
  "schema": {
14521
- "$ref": "#/components/schemas/OkResponse"
14691
+ "$ref": "#/components/schemas/CompleteTransferResponse"
14692
+ },
14693
+ "examples": {
14694
+ "completeTransferResponseExample": {
14695
+ "value": {
14696
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14697
+ "@type": "TransferProcess",
14698
+ "processId": "urn:uuid:provider-process-12345",
14699
+ "consumerPid": "urn:uuid:consumer-process-12345",
14700
+ "providerPid": "urn:uuid:provider-process-12345",
14701
+ "state": "COMPLETED",
14702
+ "dataAddress": {
14703
+ "@type": "DataAddress",
14704
+ "@id": "https://provider.example.com/data/transfer-12345",
14705
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14706
+ "baseUrl": "https://provider.example.com/data/transfer-12345"
14707
+ }
14708
+ }
14709
+ }
14522
14710
  }
14523
14711
  }
14524
14712
  }
@@ -14575,22 +14763,72 @@
14575
14763
  "parameters": [
14576
14764
  {
14577
14765
  "name": "pid",
14578
- "description": "",
14766
+ "description": "Process ID (consumerPid).",
14579
14767
  "in": "path",
14580
14768
  "required": true,
14581
14769
  "schema": {
14582
14770
  "type": "string"
14583
14771
  },
14584
- "style": "simple"
14772
+ "style": "simple",
14773
+ "example": "urn:uuid:consumer-process-12345"
14774
+ },
14775
+ {
14776
+ "name": "authorization",
14777
+ "in": "header",
14778
+ "required": true,
14779
+ "schema": {
14780
+ "type": "string"
14781
+ },
14782
+ "style": "simple",
14783
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14585
14784
  }
14586
14785
  ],
14786
+ "requestBody": {
14787
+ "description": "API request for suspending a transfer process.",
14788
+ "required": true,
14789
+ "content": {
14790
+ "application/ld+json": {
14791
+ "schema": {
14792
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferSuspensionMessage"
14793
+ },
14794
+ "examples": {
14795
+ "suspendTransferRequestExample": {
14796
+ "value": {
14797
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14798
+ "@type": "TransferSuspensionMessage",
14799
+ "consumerPid": "urn:uuid:consumer-process-12345",
14800
+ "providerPid": "urn:uuid:provider-process-12345"
14801
+ }
14802
+ }
14803
+ }
14804
+ }
14805
+ }
14806
+ },
14587
14807
  "responses": {
14588
14808
  "200": {
14589
- "description": "The rest request ended in success with no data.",
14809
+ "description": "API response for suspending a transfer process.",
14590
14810
  "content": {
14591
- "text/plain": {
14811
+ "application/json": {
14592
14812
  "schema": {
14593
- "$ref": "#/components/schemas/OkResponse"
14813
+ "$ref": "#/components/schemas/SuspendTransferResponse"
14814
+ },
14815
+ "examples": {
14816
+ "suspendTransferResponseExample": {
14817
+ "value": {
14818
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14819
+ "@type": "TransferProcess",
14820
+ "processId": "urn:uuid:provider-process-12345",
14821
+ "consumerPid": "urn:uuid:consumer-process-12345",
14822
+ "providerPid": "urn:uuid:provider-process-12345",
14823
+ "state": "SUSPENDED",
14824
+ "dataAddress": {
14825
+ "@type": "DataAddress",
14826
+ "@id": "https://provider.example.com/data/transfer-12345",
14827
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14828
+ "baseUrl": "https://provider.example.com/data/transfer-12345"
14829
+ }
14830
+ }
14831
+ }
14594
14832
  }
14595
14833
  }
14596
14834
  }
@@ -14647,22 +14885,72 @@
14647
14885
  "parameters": [
14648
14886
  {
14649
14887
  "name": "pid",
14650
- "description": "",
14888
+ "description": "Process ID (consumerPid).",
14651
14889
  "in": "path",
14652
14890
  "required": true,
14653
14891
  "schema": {
14654
14892
  "type": "string"
14655
14893
  },
14656
- "style": "simple"
14894
+ "style": "simple",
14895
+ "example": "urn:uuid:consumer-process-12345"
14896
+ },
14897
+ {
14898
+ "name": "authorization",
14899
+ "in": "header",
14900
+ "required": true,
14901
+ "schema": {
14902
+ "type": "string"
14903
+ },
14904
+ "style": "simple",
14905
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14657
14906
  }
14658
14907
  ],
14908
+ "requestBody": {
14909
+ "description": "API request for terminating a transfer process.",
14910
+ "required": true,
14911
+ "content": {
14912
+ "application/ld+json": {
14913
+ "schema": {
14914
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferTerminationMessage"
14915
+ },
14916
+ "examples": {
14917
+ "terminateTransferRequestExample": {
14918
+ "value": {
14919
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14920
+ "@type": "TransferTerminationMessage",
14921
+ "consumerPid": "urn:uuid:consumer-process-12345",
14922
+ "providerPid": "urn:uuid:provider-process-12345"
14923
+ }
14924
+ }
14925
+ }
14926
+ }
14927
+ }
14928
+ },
14659
14929
  "responses": {
14660
14930
  "200": {
14661
- "description": "The rest request ended in success with no data.",
14931
+ "description": "API response for terminating a transfer process.",
14662
14932
  "content": {
14663
- "text/plain": {
14933
+ "application/json": {
14664
14934
  "schema": {
14665
- "$ref": "#/components/schemas/OkResponse"
14935
+ "$ref": "#/components/schemas/TerminateTransferResponse"
14936
+ },
14937
+ "examples": {
14938
+ "terminateTransferResponseExample": {
14939
+ "value": {
14940
+ "@context": "https://w3id.org/dspace/2025/1/context.jsonld",
14941
+ "@type": "TransferProcess",
14942
+ "processId": "urn:uuid:provider-process-12345",
14943
+ "consumerPid": "urn:uuid:consumer-process-12345",
14944
+ "providerPid": "urn:uuid:provider-process-12345",
14945
+ "state": "TERMINATED",
14946
+ "dataAddress": {
14947
+ "@type": "DataAddress",
14948
+ "@id": "https://provider.example.com/data/transfer-12345",
14949
+ "endpointType": "https://w3id.org/dspace/v1/HttpDataAddress",
14950
+ "baseUrl": "https://provider.example.com/data/transfer-12345"
14951
+ }
14952
+ }
14953
+ }
14666
14954
  }
14667
14955
  }
14668
14956
  }
@@ -14727,7 +15015,7 @@
14727
15015
  "content": {
14728
15016
  "application/json": {
14729
15017
  "schema": {
14730
- "$ref": "https://schema.twindev.org/json-ld/JsonLdObjectWithOptionalAtId<DataspaceProtocolPolicy>"
15018
+ "$ref": "#/components/schemas/PapCreateRequest"
14731
15019
  },
14732
15020
  "examples": {
14733
15021
  "papCreateRequestExample": {
@@ -17090,7 +17378,25 @@
17090
17378
  },
17091
17379
  "components": {
17092
17380
  "schemas": {
17093
- "ActivityLogEntry": {
17381
+ "ActivityLogDates": {
17382
+ "description": "Activity log dates.",
17383
+ "type": "object",
17384
+ "properties": {
17385
+ "startDate": {
17386
+ "type": "string",
17387
+ "description": "Task processing start timestamp"
17388
+ },
17389
+ "endDate": {
17390
+ "type": "string",
17391
+ "description": "Task processing end timestamp"
17392
+ }
17393
+ },
17394
+ "required": [
17395
+ "startDate"
17396
+ ]
17397
+ },
17398
+ "ActivityLogDetails": {
17399
+ "description": "The details related to the processing of an Activity",
17094
17400
  "type": "object",
17095
17401
  "properties": {
17096
17402
  "id": {
@@ -17116,7 +17422,19 @@
17116
17422
  "retryCount": {
17117
17423
  "type": "number",
17118
17424
  "description": "Number of times this activity has been retried."
17119
- },
17425
+ }
17426
+ },
17427
+ "required": [
17428
+ "id",
17429
+ "generator",
17430
+ "dateCreated",
17431
+ "dateModified"
17432
+ ]
17433
+ },
17434
+ "ActivityLogEntry": {
17435
+ "description": "The details related to the processing of an Activity",
17436
+ "type": "object",
17437
+ "properties": {
17120
17438
  "status": {
17121
17439
  "$ref": "#/components/schemas/ActivityProcessingStatus"
17122
17440
  },
@@ -17131,29 +17449,13 @@
17131
17449
  "type": "array",
17132
17450
  "items": {
17133
17451
  "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."
17452
+ "allOf": [
17453
+ {
17454
+ "$ref": "#/components/schemas/TaskApp"
17147
17455
  },
17148
- "dataspaceAppId": {
17149
- "type": "string",
17150
- "description": "Dataspace App Id."
17456
+ {
17457
+ "$ref": "#/components/schemas/ActivityLogDates"
17151
17458
  }
17152
- },
17153
- "required": [
17154
- "dataspaceAppId",
17155
- "startDate",
17156
- "taskId"
17157
17459
  ]
17158
17460
  },
17159
17461
  "description": "The running tasks that are processing the Activity."
@@ -17162,947 +17464,147 @@
17162
17464
  "type": "array",
17163
17465
  "items": {
17164
17466
  "type": "object",
17165
- "additionalProperties": false,
17166
17467
  "properties": {
17167
17468
  "result": {
17168
17469
  "type": "string",
17169
17470
  "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
17471
  }
17187
17472
  },
17188
17473
  "required": [
17189
- "dataspaceAppId",
17190
- "result",
17191
- "startDate",
17192
- "taskId"
17193
- ]
17194
- },
17195
- "description": "The tasks that have already finalized."
17196
- },
17197
- "inErrorTasks": {
17198
- "type": "array",
17199
- "items": {
17200
- "type": "object",
17201
- "additionalProperties": false,
17202
- "properties": {
17203
- "error": {
17204
- "$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
- }
17214
- },
17215
- "required": [
17216
- "dataspaceAppId",
17217
- "error",
17218
- "taskId"
17219
- ]
17220
- },
17221
- "description": "The tasks that are in error."
17222
- }
17223
- },
17224
- "required": [
17225
- "dateCreated",
17226
- "dateModified",
17227
- "generator",
17228
- "id",
17229
- "status"
17230
- ],
17231
- "description": "The details related to the processing of an Activity"
17232
- },
17233
- "ActivityProcessingStatus": {
17234
- "anyOf": [
17235
- {
17236
- "type": "string",
17237
- "const": "pending",
17238
- "description": "Pending: Activity Processing has not started yet."
17239
- },
17240
- {
17241
- "type": "string",
17242
- "const": "running",
17243
- "description": "Running Activity processing is running."
17244
- },
17245
- {
17246
- "type": "string",
17247
- "const": "completed",
17248
- "description": "Completed: Activity processing completed without error."
17249
- },
17250
- {
17251
- "type": "string",
17252
- "const": "error",
17253
- "description": "Error: Activity processing cannot be performed and marked as in error. (Depends on application)."
17254
- },
17255
- {
17256
- "type": "string",
17257
- "const": "registering",
17258
- "description": "Transient state. The background tasks associated with the activity are still being registered."
17259
- }
17260
- ],
17261
- "description": "Activity processing statuses. The type exported."
17262
- },
17263
- "ActivityStreamsActivity": {
17264
- "type": "object",
17265
- "properties": {
17266
- "@context": {
17267
- "$ref": "#/components/schemas/ActivityStreamsContextType"
17268
- },
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."
17292
- },
17293
- "id": {
17294
- "type": "string",
17295
- "description": "Global identifier.",
17296
- "format": "uri"
17297
- },
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."
17308
- },
17309
- "nameMap": {
17310
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17311
- },
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."
17322
- },
17323
- "summaryMap": {
17324
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17325
- },
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."
17336
- },
17337
- "contentMap": {
17338
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17339
- },
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
- ]
17363
- },
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
- ]
17474
+ "result"
17475
+ ],
17476
+ "allOf": [
17477
+ {
17478
+ "$ref": "#/components/schemas/TaskApp"
17479
+ },
17480
+ {
17481
+ "$ref": "#/components/schemas/ActivityLogDates"
17896
17482
  }
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"
17483
+ ]
17918
17484
  },
17919
- "minItems": 1,
17920
- "maxItems": 1
17485
+ "description": "The tasks that have already finalized."
17921
17486
  },
17922
- {
17487
+ "inErrorTasks": {
17923
17488
  "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
17489
  "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"
17490
+ "type": "object",
17491
+ "properties": {
17492
+ "error": {
17493
+ "$ref": "#/components/schemas/Error"
17494
+ }
17945
17495
  },
17946
- {
17947
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
17948
- }
17949
- ],
17950
- "items": {
17951
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
17952
- }
17496
+ "required": [
17497
+ "error"
17498
+ ],
17499
+ "allOf": [
17500
+ {
17501
+ "$ref": "#/components/schemas/TaskApp"
17502
+ }
17503
+ ]
17504
+ },
17505
+ "description": "The tasks that are in error."
17953
17506
  }
17507
+ },
17508
+ "required": [
17509
+ "status"
17954
17510
  ],
17955
- "description": "The Activity Streams JSON-LD context type."
17511
+ "allOf": [
17512
+ {
17513
+ "$ref": "#/components/schemas/ActivityLogDetails"
17514
+ }
17515
+ ]
17956
17516
  },
17957
- "ActivityStreamsTypes": {
17517
+ "ActivityProcessingStatus": {
17518
+ "description": "The type exported.",
17958
17519
  "anyOf": [
17959
17520
  {
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`."
17521
+ "const": "pending",
17522
+ "description": "Pending: Activity Processing has not started yet."
18048
17523
  },
18049
17524
  {
18050
- "type": "string",
18051
- "const": "Offer",
18052
- "description": "Offer.\n\nIndicates that the actor is offering the object (optionally to a target)."
17525
+ "const": "running",
17526
+ "description": "Running Activity processing is running."
18053
17527
  },
18054
17528
  {
18055
- "type": "string",
18056
- "const": "Question",
18057
- "description": "Question.\n\nIntransitive activity representing a question; can express options via `oneOf`/`anyOf`."
17529
+ "const": "completed",
17530
+ "description": "Completed: Activity processing completed without error."
18058
17531
  },
18059
17532
  {
18060
- "type": "string",
18061
- "const": "Reject",
18062
- "description": "Reject.\n\nIndicates that the actor is rejecting the object."
17533
+ "const": "error",
17534
+ "description": "Error: Activity processing cannot be performed and marked as in error. (Depends on application)."
18063
17535
  },
18064
17536
  {
17537
+ "const": "registering",
17538
+ "description": "Transient state. The background tasks associated with the activity are still being registered."
17539
+ }
17540
+ ]
17541
+ },
17542
+ "AdminUserCreateRequest": {
17543
+ "description": "The body of the request.",
17544
+ "type": "object",
17545
+ "properties": {
17546
+ "email": {
18065
17547
  "type": "string",
18066
- "const": "Read",
18067
- "description": "Read.\n\nIndicates that the actor has read the object."
17548
+ "description": "The user e-mail address."
18068
17549
  },
18069
- {
17550
+ "password": {
18070
17551
  "type": "string",
18071
- "const": "Remove",
18072
- "description": "Remove.\n\nIndicates that the actor is removing the object (optionally from an origin context)."
17552
+ "description": "The encrypted password for the user."
18073
17553
  },
18074
- {
17554
+ "userIdentity": {
18075
17555
  "type": "string",
18076
- "const": "TentativeReject",
18077
- "description": "TentativeReject.\n\nSpecialization of Reject indicating that the rejection is tentative."
17556
+ "description": "The user identity."
18078
17557
  },
18079
- {
17558
+ "organizationIdentity": {
18080
17559
  "type": "string",
18081
- "const": "TentativeAccept",
18082
- "description": "TentativeAccept.\n\nSpecialization of Accept indicating that the acceptance is tentative."
17560
+ "description": "The users organization."
18083
17561
  },
18084
- {
17562
+ "scope": {
17563
+ "type": "array",
17564
+ "items": {
17565
+ "type": "string"
17566
+ },
17567
+ "description": "The scope assigned to the user, comma separated."
17568
+ }
17569
+ },
17570
+ "required": [
17571
+ "email",
17572
+ "password",
17573
+ "userIdentity",
17574
+ "organizationIdentity",
17575
+ "scope"
17576
+ ]
17577
+ },
17578
+ "AdminUserGetResponse": {
17579
+ "description": "The body of the request.",
17580
+ "type": "object",
17581
+ "properties": {
17582
+ "email": {
18085
17583
  "type": "string",
18086
- "const": "Travel",
18087
- "description": "Travel.\n\nIntransitive activity indicating that the actor is travelling to `target` from `origin`."
17584
+ "description": "The user e-mail address."
18088
17585
  },
18089
- {
17586
+ "userIdentity": {
18090
17587
  "type": "string",
18091
- "const": "Undo",
18092
- "description": "Undo.\n\nIndicates that the actor is undoing a previous activity."
17588
+ "description": "The user identity."
18093
17589
  },
18094
- {
17590
+ "organizationIdentity": {
18095
17591
  "type": "string",
18096
- "const": "Update",
18097
- "description": "Update.\n\nIndicates that the actor has updated the object."
17592
+ "description": "The users organization."
18098
17593
  },
18099
- {
18100
- "type": "string",
18101
- "const": "View",
18102
- "description": "View.\n\nIndicates that the actor has viewed the object."
17594
+ "scope": {
17595
+ "type": "array",
17596
+ "items": {
17597
+ "type": "string"
17598
+ },
17599
+ "description": "The scope assigned to the user, comma separated."
18103
17600
  }
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"
17601
+ },
17602
+ "required": [
17603
+ "email",
17604
+ "userIdentity",
17605
+ "organizationIdentity",
17606
+ "scope"
17607
+ ]
18106
17608
  },
18107
17609
  "AdminUserUpdatePasswordRequest": {
18108
17610
  "type": "object",
@@ -18121,6 +17623,27 @@
18121
17623
  ],
18122
17624
  "description": "The body of the request."
18123
17625
  },
17626
+ "AdminUserUpdateRequest": {
17627
+ "description": "The body of the request.",
17628
+ "type": "object",
17629
+ "properties": {
17630
+ "userIdentity": {
17631
+ "type": "string",
17632
+ "description": "The user identity."
17633
+ },
17634
+ "organizationIdentity": {
17635
+ "type": "string",
17636
+ "description": "The users organization."
17637
+ },
17638
+ "scope": {
17639
+ "type": "array",
17640
+ "items": {
17641
+ "type": "string"
17642
+ },
17643
+ "description": "The scope assigned to the user, comma separated."
17644
+ }
17645
+ }
17646
+ },
18124
17647
  "AttestationCreateRequest": {
18125
17648
  "type": "object",
18126
17649
  "properties": {
@@ -18181,8 +17704,7 @@
18181
17704
  },
18182
17705
  "required": [
18183
17706
  "id"
18184
- ],
18185
- "additionalProperties": false
17707
+ ]
18186
17708
  },
18187
17709
  "description": "Alternative aliases that can be used to identify the vertex."
18188
17710
  },
@@ -18197,8 +17719,7 @@
18197
17719
  "resourceObject": {
18198
17720
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18199
17721
  }
18200
- },
18201
- "additionalProperties": false
17722
+ }
18202
17723
  },
18203
17724
  "description": "The resources attached to the vertex."
18204
17725
  },
@@ -18223,8 +17744,7 @@
18223
17744
  "required": [
18224
17745
  "targetId",
18225
17746
  "edgeRelationships"
18226
- ],
18227
- "additionalProperties": false
17747
+ ]
18228
17748
  },
18229
17749
  "description": "The edges connected to the vertex."
18230
17750
  }
@@ -18257,8 +17777,7 @@
18257
17777
  },
18258
17778
  "required": [
18259
17779
  "id"
18260
- ],
18261
- "additionalProperties": false
17780
+ ]
18262
17781
  },
18263
17782
  "description": "Alternative aliases that can be used to identify the vertex."
18264
17783
  },
@@ -18273,8 +17792,7 @@
18273
17792
  "resourceObject": {
18274
17793
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18275
17794
  }
18276
- },
18277
- "additionalProperties": false
17795
+ }
18278
17796
  },
18279
17797
  "description": "The resources attached to the vertex."
18280
17798
  },
@@ -18302,8 +17820,7 @@
18302
17820
  "required": [
18303
17821
  "targetId",
18304
17822
  "edgeRelationships"
18305
- ],
18306
- "additionalProperties": false
17823
+ ]
18307
17824
  },
18308
17825
  "description": "The edges connected to the vertex."
18309
17826
  }
@@ -18339,14 +17856,13 @@
18339
17856
  },
18340
17857
  "required": [
18341
17858
  "entryObject"
18342
- ],
18343
- "additionalProperties": false
17859
+ ]
18344
17860
  },
18345
17861
  "description": "The entries for the stream."
18346
17862
  },
18347
17863
  "immutableInterval": {
18348
17864
  "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."
17865
+ "description": "After how many entries do we add immutable checks, defaults to service configured value.\nA value of 0 will disable immutable checks, 1 will be every item, or any other integer for an interval."
18350
17866
  }
18351
17867
  },
18352
17868
  "description": "The data to be used in the stream."
@@ -18439,62 +17955,63 @@
18439
17955
  "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogError"
18440
17956
  }
18441
17957
  ],
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."
17958
+ "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
17959
  },
18444
17960
  "CoerceType": {
17961
+ "description": "The types the extracted data can be coerced to.",
18445
17962
  "anyOf": [
18446
17963
  {
18447
- "type": "string",
18448
17964
  "const": "string",
18449
17965
  "description": "String."
18450
17966
  },
18451
17967
  {
18452
- "type": "string",
18453
17968
  "const": "number",
18454
17969
  "description": "Number."
18455
17970
  },
18456
17971
  {
18457
- "type": "string",
18458
17972
  "const": "integer",
18459
17973
  "description": "Integer."
18460
17974
  },
18461
17975
  {
18462
- "type": "string",
18463
17976
  "const": "boolean",
18464
17977
  "description": "Boolean."
18465
17978
  },
18466
17979
  {
18467
- "type": "string",
18468
17980
  "const": "bigint",
18469
17981
  "description": "Big Integer."
18470
17982
  },
18471
17983
  {
18472
- "type": "string",
18473
17984
  "const": "date",
18474
17985
  "description": "Date."
18475
17986
  },
18476
17987
  {
18477
- "type": "string",
18478
17988
  "const": "datetime",
18479
17989
  "description": "Date Time."
18480
17990
  },
18481
17991
  {
18482
- "type": "string",
18483
17992
  "const": "time",
18484
17993
  "description": "Time."
18485
17994
  },
18486
17995
  {
18487
- "type": "string",
18488
17996
  "const": "object",
18489
17997
  "description": "Object."
18490
17998
  },
18491
17999
  {
18492
- "type": "string",
18493
18000
  "const": "uint8array",
18494
18001
  "description": "Uint8Array."
18495
18002
  }
18003
+ ]
18004
+ },
18005
+ "CompleteTransferResponse": {
18006
+ "oneOf": [
18007
+ {
18008
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess"
18009
+ },
18010
+ {
18011
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
18012
+ }
18496
18013
  ],
18497
- "description": "The types the extracted data can be coerced to."
18014
+ "description": "Transfer Process (DSP compliant) with state COMPLETED, or error."
18498
18015
  },
18499
18016
  "ConflictResponse": {
18500
18017
  "type": "object",
@@ -18505,49 +18022,27 @@
18505
18022
  "type": "string"
18506
18023
  },
18507
18024
  "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."
18529
- },
18530
- "cause": {
18531
- "$ref": "#/components/schemas/Error"
18532
18025
  }
18533
18026
  },
18534
18027
  "required": [
18535
- "conflicts",
18536
- "message",
18537
- "name"
18028
+ "conflicts"
18029
+ ],
18030
+ "allOf": [
18031
+ {
18032
+ "$ref": "#/components/schemas/Error"
18033
+ }
18538
18034
  ],
18539
18035
  "description": "The body which contains the error."
18540
18036
  },
18541
18037
  "DataAssetItemList": {
18038
+ "description": "Interface describing a list of entities that are within a Data Asset.\nPagination is handled via HTTP Link headers.",
18542
18039
  "type": "object",
18543
18040
  "properties": {
18544
18041
  "@context": {
18545
- "type": "string",
18546
18042
  "const": "https://schema.org",
18547
18043
  "description": "The LD Context."
18548
18044
  },
18549
18045
  "type": {
18550
- "type": "string",
18551
18046
  "const": "ItemList",
18552
18047
  "description": "The type"
18553
18048
  },
@@ -18563,15 +18058,14 @@
18563
18058
  "@context",
18564
18059
  "type",
18565
18060
  "itemListElement"
18566
- ],
18567
- "description": "Interface describing a list of entities that are within a Data Asset. Pagination is handled via HTTP Link headers."
18061
+ ]
18568
18062
  },
18569
18063
  "DataAssetQueryRequest": {
18570
18064
  "type": "object",
18571
18065
  "properties": {
18572
18066
  "consumerPid": {
18573
18067
  "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."
18068
+ "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
18069
  },
18576
18070
  "query": {
18577
18071
  "$ref": "#/components/schemas/FilteringQuery"
@@ -18630,7 +18124,7 @@
18630
18124
  "description": "The params for the extract."
18631
18125
  },
18632
18126
  "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."
18127
+ "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
18128
  },
18635
18129
  "DataProcessingRuleGroupListResponse": {
18636
18130
  "type": "object",
@@ -18711,8 +18205,7 @@
18711
18205
  },
18712
18206
  "required": [
18713
18207
  "targetId"
18714
- ],
18715
- "additionalProperties": false
18208
+ ]
18716
18209
  },
18717
18210
  "description": "The auditable item graph vertices to connect the document to."
18718
18211
  },
@@ -18730,6 +18223,7 @@
18730
18223
  },
18731
18224
  "required": [
18732
18225
  "documentId",
18226
+ "documentIdFormat",
18733
18227
  "documentCode",
18734
18228
  "blob"
18735
18229
  ],
@@ -18762,8 +18256,7 @@
18762
18256
  },
18763
18257
  "required": [
18764
18258
  "targetId"
18765
- ],
18766
- "additionalProperties": false
18259
+ ]
18767
18260
  },
18768
18261
  "description": "The auditable item graph vertices to connect the document to."
18769
18262
  }
@@ -18771,6 +18264,7 @@
18771
18264
  "description": "The body parameters."
18772
18265
  },
18773
18266
  "Error": {
18267
+ "description": "Model to describe serialized error.",
18774
18268
  "type": "object",
18775
18269
  "properties": {
18776
18270
  "name": {
@@ -18801,10 +18295,10 @@
18801
18295
  "required": [
18802
18296
  "name",
18803
18297
  "message"
18804
- ],
18805
- "description": "Model to describe serialized error."
18298
+ ]
18806
18299
  },
18807
18300
  "FilteringQuery": {
18301
+ "description": "A query over a data asset that to be processed by a Dataspace Data Plane App.",
18808
18302
  "type": "object",
18809
18303
  "properties": {
18810
18304
  "type": {
@@ -18825,8 +18319,7 @@
18825
18319
  "required": [
18826
18320
  "type",
18827
18321
  "q"
18828
- ],
18829
- "description": "A query over a data asset that to be processed by a Dataspace Data Plane App."
18322
+ ]
18830
18323
  },
18831
18324
  "GetDatasetResponse": {
18832
18325
  "anyOf": [
@@ -18839,7 +18332,19 @@
18839
18332
  ],
18840
18333
  "description": "The response payload containing the dataset or error."
18841
18334
  },
18335
+ "GetTransferProcessResponse": {
18336
+ "oneOf": [
18337
+ {
18338
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess"
18339
+ },
18340
+ {
18341
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
18342
+ }
18343
+ ],
18344
+ "description": "Transfer Process (DSP compliant) with current state, or error."
18345
+ },
18842
18346
  "HealthComponentInfo": {
18347
+ "description": "The health component information.",
18843
18348
  "type": "object",
18844
18349
  "properties": {
18845
18350
  "name": {
@@ -18857,10 +18362,10 @@
18857
18362
  "required": [
18858
18363
  "name",
18859
18364
  "status"
18860
- ],
18861
- "description": "The health component information."
18365
+ ]
18862
18366
  },
18863
18367
  "HealthInfo": {
18368
+ "description": "The status of the server.",
18864
18369
  "type": "object",
18865
18370
  "properties": {
18866
18371
  "status": {
@@ -18876,28 +18381,24 @@
18876
18381
  },
18877
18382
  "required": [
18878
18383
  "status"
18879
- ],
18880
- "description": "The status of the server."
18384
+ ]
18881
18385
  },
18882
18386
  "HealthStatus": {
18387
+ "description": "The health status of the component.",
18883
18388
  "anyOf": [
18884
18389
  {
18885
- "type": "string",
18886
18390
  "const": "ok",
18887
18391
  "description": "OK."
18888
18392
  },
18889
18393
  {
18890
- "type": "string",
18891
18394
  "const": "warning",
18892
18395
  "description": "Warning."
18893
18396
  },
18894
18397
  {
18895
- "type": "string",
18896
18398
  "const": "error",
18897
18399
  "description": "Error."
18898
18400
  }
18899
- ],
18900
- "description": "The health status of the component."
18401
+ ]
18901
18402
  },
18902
18403
  "IdentityCreateRequest": {
18903
18404
  "type": "object",
@@ -18921,18 +18422,13 @@
18921
18422
  },
18922
18423
  "description": "The data for the request."
18923
18424
  },
18425
+ "IdentityProfileGetPublicResponse": {},
18924
18426
  "IdentityProfileGetResponse": {
18925
18427
  "type": "object",
18926
18428
  "properties": {
18927
18429
  "identity": {
18928
18430
  "type": "string",
18929
18431
  "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
18432
  }
18937
18433
  },
18938
18434
  "required": [
@@ -18951,15 +18447,11 @@
18951
18447
  "identity": {
18952
18448
  "type": "string",
18953
18449
  "description": "The identity."
18954
- },
18955
- "publicProfile": {
18956
- "$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
18957
18450
  }
18958
18451
  },
18959
18452
  "required": [
18960
18453
  "identity"
18961
- ],
18962
- "additionalProperties": false
18454
+ ]
18963
18455
  },
18964
18456
  "description": "The identities."
18965
18457
  },
@@ -19246,6 +18738,7 @@
19246
18738
  "description": "The parameters from the body."
19247
18739
  },
19248
18740
  "LogEntry": {
18741
+ "description": "Interface describing a log entry.",
19249
18742
  "type": "object",
19250
18743
  "properties": {
19251
18744
  "level": {
@@ -19276,38 +18769,32 @@
19276
18769
  "level",
19277
18770
  "source",
19278
18771
  "message"
19279
- ],
19280
- "description": "Interface describing a log entry."
18772
+ ]
19281
18773
  },
19282
18774
  "LogLevel": {
18775
+ "description": "The log levels.",
19283
18776
  "anyOf": [
19284
18777
  {
19285
- "type": "string",
19286
18778
  "const": "info",
19287
18779
  "description": "Info."
19288
18780
  },
19289
18781
  {
19290
- "type": "string",
19291
18782
  "const": "error",
19292
18783
  "description": "Error."
19293
18784
  },
19294
18785
  {
19295
- "type": "string",
19296
18786
  "const": "warn",
19297
18787
  "description": "Warn."
19298
18788
  },
19299
18789
  {
19300
- "type": "string",
19301
18790
  "const": "trace",
19302
18791
  "description": "Trace."
19303
18792
  },
19304
18793
  {
19305
- "type": "string",
19306
18794
  "const": "debug",
19307
18795
  "description": "Debug."
19308
18796
  }
19309
- ],
19310
- "description": "The log levels."
18797
+ ]
19311
18798
  },
19312
18799
  "LoggingListResponse": {
19313
18800
  "type": "object",
@@ -19361,24 +18848,21 @@
19361
18848
  "description": "The login response details."
19362
18849
  },
19363
18850
  "MetricType": {
18851
+ "description": "The types of metrics.",
19364
18852
  "anyOf": [
19365
18853
  {
19366
- "type": "number",
19367
18854
  "const": 0,
19368
18855
  "description": "Counter."
19369
18856
  },
19370
18857
  {
19371
- "type": "number",
19372
18858
  "const": 1,
19373
18859
  "description": "Increment Decrement Counter."
19374
18860
  },
19375
18861
  {
19376
- "type": "number",
19377
18862
  "const": 2,
19378
18863
  "description": "Gauge."
19379
18864
  }
19380
- ],
19381
- "description": "The types of metrics."
18865
+ ]
19382
18866
  },
19383
18867
  "NftMintRequest": {
19384
18868
  "type": "object",
@@ -19468,37 +18952,227 @@
19468
18952
  "notFoundId": {
19469
18953
  "type": "string",
19470
18954
  "description": "The id if the item that was not found."
18955
+ }
18956
+ },
18957
+ "allOf": [
18958
+ {
18959
+ "$ref": "#/components/schemas/Error"
18960
+ }
18961
+ ],
18962
+ "description": "The body which contains the error."
18963
+ },
18964
+ "PapCreateRequest": {
18965
+ "description": "The body of the request - the policy to create (id will be auto-generated if not provided).",
18966
+ "type": "object",
18967
+ "properties": {
18968
+ "@context": {
18969
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlContextType"
19471
18970
  },
19472
- "name": {
19473
- "type": "string",
19474
- "description": "The name for the error."
18971
+ "@type": {
18972
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicyType"
19475
18973
  },
19476
- "message": {
19477
- "type": "string",
19478
- "description": "The message for the error."
18974
+ "profile": {
18975
+ "anyOf": [
18976
+ {
18977
+ "type": "string"
18978
+ },
18979
+ {
18980
+ "type": "array",
18981
+ "items": {
18982
+ "type": "string"
18983
+ }
18984
+ }
18985
+ ],
18986
+ "description": "The profile(s) this policy conforms to.\nIRIs identifying the ODRL Profile(s)."
19479
18987
  },
19480
- "source": {
19481
- "type": "string",
19482
- "description": "The source of the error."
18988
+ "assigner": {
18989
+ "anyOf": [
18990
+ {
18991
+ "type": "string"
18992
+ },
18993
+ {
18994
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
18995
+ },
18996
+ {
18997
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
18998
+ },
18999
+ {
19000
+ "type": "array",
19001
+ "items": {
19002
+ "anyOf": [
19003
+ {
19004
+ "type": "string"
19005
+ },
19006
+ {
19007
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
19008
+ },
19009
+ {
19010
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
19011
+ }
19012
+ ]
19013
+ }
19014
+ }
19015
+ ],
19016
+ "description": "The assigner of the policy.\nApplies to all rules unless overridden at rule level."
19483
19017
  },
19484
- "properties": {
19485
- "type": "object",
19486
- "additionalProperties": {},
19487
- "description": "Any additional information for the error."
19018
+ "assignee": {
19019
+ "anyOf": [
19020
+ {
19021
+ "type": "string"
19022
+ },
19023
+ {
19024
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
19025
+ },
19026
+ {
19027
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
19028
+ },
19029
+ {
19030
+ "type": "array",
19031
+ "items": {
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
+ }
19044
+ }
19045
+ ],
19046
+ "description": "The assignee of the policy.\nApplies to all rules unless overridden at rule level."
19488
19047
  },
19489
- "stack": {
19490
- "type": "string",
19491
- "description": "The stack trace for the error."
19048
+ "target": {
19049
+ "anyOf": [
19050
+ {
19051
+ "type": "string"
19052
+ },
19053
+ {
19054
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
19055
+ },
19056
+ {
19057
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
19058
+ },
19059
+ {
19060
+ "type": "array",
19061
+ "items": {
19062
+ "anyOf": [
19063
+ {
19064
+ "type": "string"
19065
+ },
19066
+ {
19067
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
19068
+ },
19069
+ {
19070
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
19071
+ }
19072
+ ]
19073
+ }
19074
+ }
19075
+ ],
19076
+ "description": "The target asset for the rule."
19492
19077
  },
19493
- "cause": {
19494
- "$ref": "#/components/schemas/Error"
19078
+ "action": {
19079
+ "anyOf": [
19080
+ {
19081
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
19082
+ },
19083
+ {
19084
+ "type": "string"
19085
+ },
19086
+ {
19087
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
19088
+ },
19089
+ {
19090
+ "type": "array",
19091
+ "items": {
19092
+ "anyOf": [
19093
+ {
19094
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
19095
+ },
19096
+ {
19097
+ "type": "string"
19098
+ },
19099
+ {
19100
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
19101
+ }
19102
+ ]
19103
+ }
19104
+ }
19105
+ ],
19106
+ "description": "The action associated with the rule."
19107
+ },
19108
+ "inheritFrom": {
19109
+ "anyOf": [
19110
+ {
19111
+ "type": "string"
19112
+ },
19113
+ {
19114
+ "type": "array",
19115
+ "items": {
19116
+ "type": "string"
19117
+ }
19118
+ }
19119
+ ],
19120
+ "description": "The parent policy(ies) this policy inherits from.\nIRIs identifying the parent Policy(ies)."
19121
+ },
19122
+ "conflict": {
19123
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlConflictStrategyType"
19124
+ },
19125
+ "permission": {
19126
+ "anyOf": [
19127
+ {
19128
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
19129
+ },
19130
+ {
19131
+ "type": "array",
19132
+ "items": {
19133
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
19134
+ }
19135
+ }
19136
+ ],
19137
+ "description": "The permissions in the policy.\nAt least one of permission, prohibition, or obligation must be present."
19138
+ },
19139
+ "prohibition": {
19140
+ "anyOf": [
19141
+ {
19142
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
19143
+ },
19144
+ {
19145
+ "type": "array",
19146
+ "items": {
19147
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
19148
+ }
19149
+ }
19150
+ ],
19151
+ "description": "The prohibitions in the policy.\nAt least one of permission, prohibition, or obligation must be present."
19152
+ },
19153
+ "obligation": {
19154
+ "anyOf": [
19155
+ {
19156
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
19157
+ },
19158
+ {
19159
+ "type": "array",
19160
+ "items": {
19161
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
19162
+ }
19163
+ }
19164
+ ],
19165
+ "description": "The obligations in the policy.\nAt least one of permission, prohibition, or obligation must be present."
19166
+ },
19167
+ "@id": {
19168
+ "type": "string",
19169
+ "description": "Unique identifier for the policy."
19495
19170
  }
19496
19171
  },
19497
19172
  "required": [
19498
- "message",
19499
- "name"
19500
- ],
19501
- "description": "The body which contains the error."
19173
+ "@context",
19174
+ "@type"
19175
+ ]
19502
19176
  },
19503
19177
  "PapQueryResponse": {
19504
19178
  "type": "array",
@@ -19515,7 +19189,7 @@
19515
19189
  "description": "The body of the response."
19516
19190
  },
19517
19191
  "PnpContractNegotiationResponse": {
19518
- "anyOf": [
19192
+ "oneOf": [
19519
19193
  {
19520
19194
  "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiation"
19521
19195
  },
@@ -19526,6 +19200,7 @@
19526
19200
  "description": "The state of the policy or an error."
19527
19201
  },
19528
19202
  "PolicyNegotiation": {
19203
+ "description": "Interface describing a rights management policy negotiation.",
19529
19204
  "type": "object",
19530
19205
  "properties": {
19531
19206
  "id": {
@@ -19555,6 +19230,10 @@
19555
19230
  "type": "string",
19556
19231
  "description": "The callback address to send updates to the requester."
19557
19232
  },
19233
+ "publicOrigin": {
19234
+ "type": "string",
19235
+ "description": "The public origin of the server that initiated or received this negotiation.\nUsed to construct callback URLs in subsequent async messages."
19236
+ },
19558
19237
  "organizationIdentity": {
19559
19238
  "type": "string",
19560
19239
  "description": "Organization identity to be used when sending trust payloads."
@@ -19586,8 +19265,7 @@
19586
19265
  },
19587
19266
  "required": [
19588
19267
  "@value"
19589
- ],
19590
- "additionalProperties": false
19268
+ ]
19591
19269
  },
19592
19270
  "description": "A more detailed reason for the negotiation error."
19593
19271
  },
@@ -19605,8 +19283,7 @@
19605
19283
  },
19606
19284
  "required": [
19607
19285
  "@value"
19608
- ],
19609
- "additionalProperties": false
19286
+ ]
19610
19287
  },
19611
19288
  "description": "A more detailed reason for the negotiation error."
19612
19289
  },
@@ -19628,8 +19305,7 @@
19628
19305
  "dateCreated",
19629
19306
  "state",
19630
19307
  "organizationIdentity"
19631
- ],
19632
- "description": "Interface describing a rights management policy negotiation."
19308
+ ]
19633
19309
  },
19634
19310
  "RefreshTokenResponse": {
19635
19311
  "type": "object",
@@ -19644,16 +19320,28 @@
19644
19320
  ],
19645
19321
  "description": "The refresh token details."
19646
19322
  },
19323
+ "RequestTransferResponse": {
19324
+ "oneOf": [
19325
+ {
19326
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess"
19327
+ },
19328
+ {
19329
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
19330
+ }
19331
+ ],
19332
+ "description": "Transfer Process (DSP compliant) with state REQUESTED, or error."
19333
+ },
19647
19334
  "Rule": {
19335
+ "description": "Rule defining how to extract data from an object.",
19648
19336
  "type": "object",
19649
19337
  "properties": {
19650
19338
  "source": {
19651
19339
  "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."
19340
+ "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
19341
  },
19654
19342
  "target": {
19655
19343
  "type": "string",
19656
- "description": "The target path of where to store the extracted data. Supports simple dotted path notation, and numeric index notation."
19344
+ "description": "The target path of where to store the extracted data.\nSupports simple dotted path notation, and numeric index notation."
19657
19345
  },
19658
19346
  "retainPathDepth": {
19659
19347
  "type": "number",
@@ -19666,10 +19354,10 @@
19666
19354
  "required": [
19667
19355
  "source",
19668
19356
  "target"
19669
- ],
19670
- "description": "Rule defining how to extract data from an object."
19357
+ ]
19671
19358
  },
19672
19359
  "RuleGroup": {
19360
+ "description": "Group of rules for extraction.",
19673
19361
  "type": "object",
19674
19362
  "properties": {
19675
19363
  "id": {
@@ -19692,10 +19380,17 @@
19692
19380
  "id",
19693
19381
  "label",
19694
19382
  "rules"
19695
- ],
19696
- "description": "Group of rules for extraction."
19383
+ ]
19384
+ },
19385
+ "ServerFavIconResponse": {
19386
+ "type": "array",
19387
+ "items": {
19388
+ "type": "number"
19389
+ },
19390
+ "description": "The favicon for the server."
19697
19391
  },
19698
19392
  "ServerInfo": {
19393
+ "description": "The information about the server.",
19699
19394
  "type": "object",
19700
19395
  "properties": {
19701
19396
  "name": {
@@ -19710,14 +19405,16 @@
19710
19405
  "required": [
19711
19406
  "name",
19712
19407
  "version"
19713
- ],
19714
- "description": "The information about the server."
19408
+ ]
19715
19409
  },
19716
19410
  "ServerLivezResponse": {
19717
- "type": "string",
19718
- "enum": [
19719
- "ok",
19720
- "failed"
19411
+ "anyOf": [
19412
+ {
19413
+ "const": "ok"
19414
+ },
19415
+ {
19416
+ "const": "failed"
19417
+ }
19721
19418
  ],
19722
19419
  "description": "The livez information for the server."
19723
19420
  },
@@ -19729,21 +19426,42 @@
19729
19426
  "description": "The spec for the server."
19730
19427
  },
19731
19428
  "SortDirection": {
19429
+ "description": "The sort directions.",
19732
19430
  "anyOf": [
19733
19431
  {
19734
- "type": "string",
19735
19432
  "const": "asc",
19736
19433
  "description": "Ascending."
19737
19434
  },
19738
19435
  {
19739
- "type": "string",
19740
19436
  "const": "desc",
19741
19437
  "description": "Descending."
19742
19438
  }
19439
+ ]
19440
+ },
19441
+ "StartTransferResponse": {
19442
+ "oneOf": [
19443
+ {
19444
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferStartMessage"
19445
+ },
19446
+ {
19447
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
19448
+ }
19449
+ ],
19450
+ "description": "Transfer Start Message (DSP compliant) with dataAddress for PULL transfers, or error."
19451
+ },
19452
+ "SuspendTransferResponse": {
19453
+ "oneOf": [
19454
+ {
19455
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess"
19456
+ },
19457
+ {
19458
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
19459
+ }
19743
19460
  ],
19744
- "description": "The sort directions."
19461
+ "description": "Transfer Process (DSP compliant) with state SUSPENDED, or error."
19745
19462
  },
19746
19463
  "SyncChange": {
19464
+ "description": "The object definition for a sync change.",
19747
19465
  "type": "object",
19748
19466
  "properties": {
19749
19467
  "operation": {
@@ -19760,34 +19478,30 @@
19760
19478
  "required": [
19761
19479
  "operation",
19762
19480
  "id"
19763
- ],
19764
- "description": "The object definition for a sync change."
19481
+ ]
19765
19482
  },
19766
19483
  "SyncChangeOperation": {
19484
+ "description": "The operations for a change",
19767
19485
  "anyOf": [
19768
19486
  {
19769
- "type": "string",
19770
19487
  "const": "set",
19771
19488
  "description": "An item was set in the storage."
19772
19489
  },
19773
19490
  {
19774
- "type": "string",
19775
19491
  "const": "delete",
19776
19492
  "description": "An item was deleted from the storage."
19777
19493
  }
19778
- ],
19779
- "description": "The operations for a change. The operations for a change"
19494
+ ]
19780
19495
  },
19781
19496
  "SyncChangeSet": {
19497
+ "description": "The object definition for a sync change set.",
19782
19498
  "type": "object",
19783
19499
  "properties": {
19784
19500
  "@context": {
19785
- "type": "string",
19786
19501
  "const": "https://schema.twindev.org/synchronised-storage/",
19787
19502
  "description": "The LD Context for the change set."
19788
19503
  },
19789
19504
  "type": {
19790
- "type": "string",
19791
19505
  "const": "ChangeSet",
19792
19506
  "description": "The LD Type for the change set."
19793
19507
  },
@@ -19797,26 +19511,26 @@
19797
19511
  },
19798
19512
  "storageKey": {
19799
19513
  "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"
19514
+ "description": "The storage key of the change set. This is used to identify the entities being synchronised."
19801
19515
  },
19802
19516
  "dateCreated": {
19803
19517
  "type": "string",
19804
- "description": "The date the change set was created. json-ld namespace:schema"
19518
+ "description": "The date the change set was created."
19805
19519
  },
19806
19520
  "dateModified": {
19807
19521
  "type": "string",
19808
- "description": "The date the change set was last modified. json-ld namespace:schema"
19522
+ "description": "The date the change set was last modified."
19809
19523
  },
19810
19524
  "nodeIdentity": {
19811
19525
  "type": "string",
19812
- "description": "The identity of the node that created the change set. json-ld namespace:twin-common"
19526
+ "description": "The identity of the node that created the change set."
19813
19527
  },
19814
19528
  "changes": {
19815
19529
  "type": "array",
19816
19530
  "items": {
19817
19531
  "$ref": "#/components/schemas/SyncChange"
19818
19532
  },
19819
- "description": "The changes to apply after a snapshot. json-ld type:json"
19533
+ "description": "The changes to apply after a snapshot."
19820
19534
  }
19821
19535
  },
19822
19536
  "required": [
@@ -19828,8 +19542,7 @@
19828
19542
  "dateModified",
19829
19543
  "nodeIdentity",
19830
19544
  "changes"
19831
- ],
19832
- "description": "The object definition for a sync change set."
19545
+ ]
19833
19546
  },
19834
19547
  "SyncDecryptionKeyResponse": {
19835
19548
  "type": "object",
@@ -19845,19 +19558,20 @@
19845
19558
  "description": "The body of the response."
19846
19559
  },
19847
19560
  "SynchronisedEntityCore": {
19561
+ "description": "The base definition for synchronised entries.",
19848
19562
  "type": "object",
19849
19563
  "properties": {
19850
19564
  "dateModified": {
19851
19565
  "type": "string",
19852
- "description": "The date the entry was modified. json-ld namespace:schema"
19566
+ "description": "The date the entry was modified."
19853
19567
  }
19854
19568
  },
19855
19569
  "required": [
19856
19570
  "dateModified"
19857
- ],
19858
- "description": "The base definition for synchronised entries."
19571
+ ]
19859
19572
  },
19860
19573
  "TaskApp": {
19574
+ "description": "Denotes a task associated with a Dataspace App",
19861
19575
  "type": "object",
19862
19576
  "properties": {
19863
19577
  "taskId": {
@@ -19872,8 +19586,7 @@
19872
19586
  "required": [
19873
19587
  "taskId",
19874
19588
  "dataspaceAppId"
19875
- ],
19876
- "description": "Denotes a task associated with a Dataspace App"
19589
+ ]
19877
19590
  },
19878
19591
  "TelemetryAddMetricValueRequest": {
19879
19592
  "type": "object",
@@ -19881,11 +19594,9 @@
19881
19594
  "value": {
19882
19595
  "anyOf": [
19883
19596
  {
19884
- "type": "string",
19885
19597
  "const": "inc"
19886
19598
  },
19887
19599
  {
19888
- "type": "string",
19889
19600
  "const": "dec"
19890
19601
  },
19891
19602
  {
@@ -19942,6 +19653,7 @@
19942
19653
  "description": "The response payload."
19943
19654
  },
19944
19655
  "TelemetryMetric": {
19656
+ "description": "Interface describing a telemetry metric.",
19945
19657
  "type": "object",
19946
19658
  "properties": {
19947
19659
  "id": {
@@ -19968,10 +19680,10 @@
19968
19680
  "id",
19969
19681
  "label",
19970
19682
  "type"
19971
- ],
19972
- "description": "Interface describing a telemetry metric."
19683
+ ]
19973
19684
  },
19974
19685
  "TelemetryMetricValue": {
19686
+ "description": "Interface describing a telemetry metric value.",
19975
19687
  "type": "object",
19976
19688
  "properties": {
19977
19689
  "id": {
@@ -19996,8 +19708,7 @@
19996
19708
  "id",
19997
19709
  "ts",
19998
19710
  "value"
19999
- ],
20000
- "description": "Interface describing a telemetry metric value."
19711
+ ]
20001
19712
  },
20002
19713
  "TelemetryUpdateMetricRequest": {
20003
19714
  "type": "object",
@@ -20044,7 +19755,19 @@
20044
19755
  ],
20045
19756
  "description": "The response payload."
20046
19757
  },
19758
+ "TerminateTransferResponse": {
19759
+ "oneOf": [
19760
+ {
19761
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess"
19762
+ },
19763
+ {
19764
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError"
19765
+ }
19766
+ ],
19767
+ "description": "Transfer Process (DSP compliant) with state TERMINATED, or error."
19768
+ },
20047
19769
  "TrustVerificationInfo": {
19770
+ "description": "Interface describing a trust verifier information.",
20048
19771
  "type": "object",
20049
19772
  "properties": {
20050
19773
  "identity": {
@@ -20061,8 +19784,7 @@
20061
19784
  },
20062
19785
  "required": [
20063
19786
  "identity"
20064
- ],
20065
- "description": "Interface describing a trust verifier information."
19787
+ ]
20066
19788
  },
20067
19789
  "UpdatePasswordRequest": {
20068
19790
  "type": "object",
@@ -20185,24 +19907,21 @@
20185
19907
  "description": "The data to be updated."
20186
19908
  },
20187
19909
  "VerifyDepth": {
19910
+ "description": "How deep to verify the signatures.",
20188
19911
  "anyOf": [
20189
19912
  {
20190
- "type": "string",
20191
19913
  "const": "none",
20192
19914
  "description": "Do not verify any signatures."
20193
19915
  },
20194
19916
  {
20195
- "type": "string",
20196
19917
  "const": "current",
20197
19918
  "description": "Verify only the most recent signature."
20198
19919
  },
20199
19920
  {
20200
- "type": "string",
20201
19921
  "const": "all",
20202
19922
  "description": "Verify all the signatures."
20203
19923
  }
20204
- ],
20205
- "description": "How deep to verify the signatures."
19924
+ ]
20206
19925
  }
20207
19926
  },
20208
19927
  "securitySchemes": {