@twin.org/node 0.0.3-next.27 → 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
- "@type": "Offer",
13694
- "uid": "urn:uuid:policy-456",
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,36 +14302,71 @@
14296
14302
  "tags": [
14297
14303
  "Transfer Process"
14298
14304
  ],
14299
- "security": [
14305
+ "parameters": [
14300
14306
  {
14301
- "jwtBearerAuthScheme": []
14307
+ "name": "authorization",
14308
+ "in": "header",
14309
+ "required": true,
14310
+ "schema": {
14311
+ "type": "string"
14312
+ },
14313
+ "style": "simple",
14314
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14302
14315
  }
14303
14316
  ],
14304
- "responses": {
14305
- "200": {
14306
- "description": "The rest request ended in success with no data.",
14307
- "content": {
14308
- "text/plain": {
14309
- "schema": {
14310
- "$ref": "#/components/schemas/OkResponse"
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
+ }
14311
14343
  }
14312
14344
  }
14313
14345
  }
14314
- },
14315
- "400": {
14316
- "description": "The server cannot process the request, see the content for more details.",
14346
+ }
14347
+ },
14348
+ "responses": {
14349
+ "200": {
14350
+ "description": "API response for requesting a transfer process.",
14317
14351
  "content": {
14318
14352
  "application/json": {
14319
14353
  "schema": {
14320
- "$ref": "#/components/schemas/Error"
14354
+ "$ref": "#/components/schemas/RequestTransferResponse"
14321
14355
  },
14322
14356
  "examples": {
14323
- "exampleResponse": {
14357
+ "requestTransferResponseExample": {
14324
14358
  "value": {
14325
- "name": "GeneralError",
14326
- "message": "errorMessage",
14327
- "properties": {
14328
- "foo": "bar"
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"
14329
14370
  }
14330
14371
  }
14331
14372
  }
@@ -14333,8 +14374,8 @@
14333
14374
  }
14334
14375
  }
14335
14376
  },
14336
- "401": {
14337
- "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
14377
+ "400": {
14378
+ "description": "The server cannot process the request, see the content for more details.",
14338
14379
  "content": {
14339
14380
  "application/json": {
14340
14381
  "schema": {
@@ -14343,8 +14384,11 @@
14343
14384
  "examples": {
14344
14385
  "exampleResponse": {
14345
14386
  "value": {
14346
- "name": "UnauthorizedError",
14347
- "message": "errorMessage"
14387
+ "name": "GeneralError",
14388
+ "message": "errorMessage",
14389
+ "properties": {
14390
+ "foo": "bar"
14391
+ }
14348
14392
  }
14349
14393
  }
14350
14394
  }
@@ -14382,45 +14426,48 @@
14382
14426
  "parameters": [
14383
14427
  {
14384
14428
  "name": "pid",
14385
- "description": "",
14429
+ "description": "Process ID (consumerPid or providerPid).",
14386
14430
  "in": "path",
14387
14431
  "required": true,
14388
14432
  "schema": {
14389
14433
  "type": "string"
14390
14434
  },
14391
- "style": "simple"
14392
- }
14393
- ],
14394
- "security": [
14435
+ "style": "simple",
14436
+ "example": "urn:uuid:provider-process-12345"
14437
+ },
14395
14438
  {
14396
- "jwtBearerAuthScheme": []
14439
+ "name": "authorization",
14440
+ "in": "header",
14441
+ "required": true,
14442
+ "schema": {
14443
+ "type": "string"
14444
+ },
14445
+ "style": "simple",
14446
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14397
14447
  }
14398
14448
  ],
14399
14449
  "responses": {
14400
14450
  "200": {
14401
- "description": "The rest request ended in success with no data.",
14402
- "content": {
14403
- "text/plain": {
14404
- "schema": {
14405
- "$ref": "#/components/schemas/OkResponse"
14406
- }
14407
- }
14408
- }
14409
- },
14410
- "400": {
14411
- "description": "The server cannot process the request, see the content for more details.",
14451
+ "description": "API response for getting a transfer process state.",
14412
14452
  "content": {
14413
14453
  "application/json": {
14414
14454
  "schema": {
14415
- "$ref": "#/components/schemas/Error"
14455
+ "$ref": "#/components/schemas/GetTransferProcessResponse"
14416
14456
  },
14417
14457
  "examples": {
14418
- "exampleResponse": {
14458
+ "getTransferProcessResponseExample": {
14419
14459
  "value": {
14420
- "name": "GeneralError",
14421
- "message": "errorMessage",
14422
- "properties": {
14423
- "foo": "bar"
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"
14424
14471
  }
14425
14472
  }
14426
14473
  }
@@ -14428,8 +14475,8 @@
14428
14475
  }
14429
14476
  }
14430
14477
  },
14431
- "401": {
14432
- "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
14478
+ "400": {
14479
+ "description": "The server cannot process the request, see the content for more details.",
14433
14480
  "content": {
14434
14481
  "application/json": {
14435
14482
  "schema": {
@@ -14438,8 +14485,11 @@
14438
14485
  "examples": {
14439
14486
  "exampleResponse": {
14440
14487
  "value": {
14441
- "name": "UnauthorizedError",
14442
- "message": "errorMessage"
14488
+ "name": "GeneralError",
14489
+ "message": "errorMessage",
14490
+ "properties": {
14491
+ "foo": "bar"
14492
+ }
14443
14493
  }
14444
14494
  }
14445
14495
  }
@@ -14477,54 +14527,70 @@
14477
14527
  "parameters": [
14478
14528
  {
14479
14529
  "name": "pid",
14480
- "description": "",
14530
+ "description": "Process ID (consumerPid).",
14481
14531
  "in": "path",
14482
14532
  "required": true,
14483
14533
  "schema": {
14484
14534
  "type": "string"
14485
14535
  },
14486
- "style": "simple"
14487
- }
14488
- ],
14489
- "security": [
14536
+ "style": "simple",
14537
+ "example": "urn:uuid:consumer-process-12345"
14538
+ },
14490
14539
  {
14491
- "jwtBearerAuthScheme": []
14540
+ "name": "authorization",
14541
+ "in": "header",
14542
+ "required": true,
14543
+ "schema": {
14544
+ "type": "string"
14545
+ },
14546
+ "style": "simple",
14547
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14492
14548
  }
14493
14549
  ],
14494
- "responses": {
14495
- "200": {
14496
- "description": "The rest request ended in success with no data.",
14497
- "content": {
14498
- "text/plain": {
14499
- "schema": {
14500
- "$ref": "#/components/schemas/OkResponse"
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
+ }
14501
14566
  }
14502
14567
  }
14503
14568
  }
14504
- },
14505
- "400": {
14506
- "description": "The server cannot process the request, see the content for more details.",
14569
+ }
14570
+ },
14571
+ "responses": {
14572
+ "200": {
14573
+ "description": "API response for starting a transfer process.",
14507
14574
  "content": {
14508
14575
  "application/json": {
14509
14576
  "schema": {
14510
- "$ref": "#/components/schemas/Error"
14577
+ "$ref": "#/components/schemas/StartTransferResponse"
14511
14578
  },
14512
14579
  "examples": {
14513
- "exampleResponse": {
14580
+ "startTransferResponseExample": {
14514
14581
  "value": {
14515
- "name": "GeneralError",
14516
- "message": "errorMessage",
14517
- "properties": {
14518
- "foo": "bar"
14519
- }
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"
14520
14586
  }
14521
14587
  }
14522
14588
  }
14523
14589
  }
14524
14590
  }
14525
14591
  },
14526
- "401": {
14527
- "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
14592
+ "400": {
14593
+ "description": "The server cannot process the request, see the content for more details.",
14528
14594
  "content": {
14529
14595
  "application/json": {
14530
14596
  "schema": {
@@ -14533,8 +14599,11 @@
14533
14599
  "examples": {
14534
14600
  "exampleResponse": {
14535
14601
  "value": {
14536
- "name": "UnauthorizedError",
14537
- "message": "errorMessage"
14602
+ "name": "GeneralError",
14603
+ "message": "errorMessage",
14604
+ "properties": {
14605
+ "foo": "bar"
14606
+ }
14538
14607
  }
14539
14608
  }
14540
14609
  }
@@ -14572,45 +14641,69 @@
14572
14641
  "parameters": [
14573
14642
  {
14574
14643
  "name": "pid",
14575
- "description": "",
14644
+ "description": "Process ID (consumerPid).",
14576
14645
  "in": "path",
14577
14646
  "required": true,
14578
14647
  "schema": {
14579
14648
  "type": "string"
14580
14649
  },
14581
- "style": "simple"
14582
- }
14583
- ],
14584
- "security": [
14650
+ "style": "simple",
14651
+ "example": "urn:uuid:consumer-process-12345"
14652
+ },
14585
14653
  {
14586
- "jwtBearerAuthScheme": []
14654
+ "name": "authorization",
14655
+ "in": "header",
14656
+ "required": true,
14657
+ "schema": {
14658
+ "type": "string"
14659
+ },
14660
+ "style": "simple",
14661
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14587
14662
  }
14588
14663
  ],
14589
- "responses": {
14590
- "200": {
14591
- "description": "The rest request ended in success with no data.",
14592
- "content": {
14593
- "text/plain": {
14594
- "schema": {
14595
- "$ref": "#/components/schemas/OkResponse"
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
+ }
14596
14680
  }
14597
14681
  }
14598
14682
  }
14599
- },
14600
- "400": {
14601
- "description": "The server cannot process the request, see the content for more details.",
14683
+ }
14684
+ },
14685
+ "responses": {
14686
+ "200": {
14687
+ "description": "API response for completing a transfer process.",
14602
14688
  "content": {
14603
14689
  "application/json": {
14604
14690
  "schema": {
14605
- "$ref": "#/components/schemas/Error"
14691
+ "$ref": "#/components/schemas/CompleteTransferResponse"
14606
14692
  },
14607
14693
  "examples": {
14608
- "exampleResponse": {
14694
+ "completeTransferResponseExample": {
14609
14695
  "value": {
14610
- "name": "GeneralError",
14611
- "message": "errorMessage",
14612
- "properties": {
14613
- "foo": "bar"
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"
14614
14707
  }
14615
14708
  }
14616
14709
  }
@@ -14618,8 +14711,8 @@
14618
14711
  }
14619
14712
  }
14620
14713
  },
14621
- "401": {
14622
- "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
14714
+ "400": {
14715
+ "description": "The server cannot process the request, see the content for more details.",
14623
14716
  "content": {
14624
14717
  "application/json": {
14625
14718
  "schema": {
@@ -14628,8 +14721,11 @@
14628
14721
  "examples": {
14629
14722
  "exampleResponse": {
14630
14723
  "value": {
14631
- "name": "UnauthorizedError",
14632
- "message": "errorMessage"
14724
+ "name": "GeneralError",
14725
+ "message": "errorMessage",
14726
+ "properties": {
14727
+ "foo": "bar"
14728
+ }
14633
14729
  }
14634
14730
  }
14635
14731
  }
@@ -14667,27 +14763,72 @@
14667
14763
  "parameters": [
14668
14764
  {
14669
14765
  "name": "pid",
14670
- "description": "",
14766
+ "description": "Process ID (consumerPid).",
14671
14767
  "in": "path",
14672
14768
  "required": true,
14673
14769
  "schema": {
14674
14770
  "type": "string"
14675
14771
  },
14676
- "style": "simple"
14677
- }
14678
- ],
14679
- "security": [
14772
+ "style": "simple",
14773
+ "example": "urn:uuid:consumer-process-12345"
14774
+ },
14680
14775
  {
14681
- "jwtBearerAuthScheme": []
14776
+ "name": "authorization",
14777
+ "in": "header",
14778
+ "required": true,
14779
+ "schema": {
14780
+ "type": "string"
14781
+ },
14782
+ "style": "simple",
14783
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14682
14784
  }
14683
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
+ },
14684
14807
  "responses": {
14685
14808
  "200": {
14686
- "description": "The rest request ended in success with no data.",
14809
+ "description": "API response for suspending a transfer process.",
14687
14810
  "content": {
14688
- "text/plain": {
14811
+ "application/json": {
14689
14812
  "schema": {
14690
- "$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
+ }
14691
14832
  }
14692
14833
  }
14693
14834
  }
@@ -14713,24 +14854,6 @@
14713
14854
  }
14714
14855
  }
14715
14856
  },
14716
- "401": {
14717
- "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
14718
- "content": {
14719
- "application/json": {
14720
- "schema": {
14721
- "$ref": "#/components/schemas/Error"
14722
- },
14723
- "examples": {
14724
- "exampleResponse": {
14725
- "value": {
14726
- "name": "UnauthorizedError",
14727
- "message": "errorMessage"
14728
- }
14729
- }
14730
- }
14731
- }
14732
- }
14733
- },
14734
14857
  "500": {
14735
14858
  "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
14736
14859
  "content": {
@@ -14762,45 +14885,69 @@
14762
14885
  "parameters": [
14763
14886
  {
14764
14887
  "name": "pid",
14765
- "description": "",
14888
+ "description": "Process ID (consumerPid).",
14766
14889
  "in": "path",
14767
14890
  "required": true,
14768
14891
  "schema": {
14769
14892
  "type": "string"
14770
14893
  },
14771
- "style": "simple"
14772
- }
14773
- ],
14774
- "security": [
14894
+ "style": "simple",
14895
+ "example": "urn:uuid:consumer-process-12345"
14896
+ },
14775
14897
  {
14776
- "jwtBearerAuthScheme": []
14898
+ "name": "authorization",
14899
+ "in": "header",
14900
+ "required": true,
14901
+ "schema": {
14902
+ "type": "string"
14903
+ },
14904
+ "style": "simple",
14905
+ "example": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
14777
14906
  }
14778
14907
  ],
14779
- "responses": {
14780
- "200": {
14781
- "description": "The rest request ended in success with no data.",
14782
- "content": {
14783
- "text/plain": {
14784
- "schema": {
14785
- "$ref": "#/components/schemas/OkResponse"
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
+ }
14786
14924
  }
14787
14925
  }
14788
14926
  }
14789
- },
14790
- "400": {
14791
- "description": "The server cannot process the request, see the content for more details.",
14927
+ }
14928
+ },
14929
+ "responses": {
14930
+ "200": {
14931
+ "description": "API response for terminating a transfer process.",
14792
14932
  "content": {
14793
14933
  "application/json": {
14794
14934
  "schema": {
14795
- "$ref": "#/components/schemas/Error"
14935
+ "$ref": "#/components/schemas/TerminateTransferResponse"
14796
14936
  },
14797
14937
  "examples": {
14798
- "exampleResponse": {
14938
+ "terminateTransferResponseExample": {
14799
14939
  "value": {
14800
- "name": "GeneralError",
14801
- "message": "errorMessage",
14802
- "properties": {
14803
- "foo": "bar"
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"
14804
14951
  }
14805
14952
  }
14806
14953
  }
@@ -14808,8 +14955,8 @@
14808
14955
  }
14809
14956
  }
14810
14957
  },
14811
- "401": {
14812
- "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
14958
+ "400": {
14959
+ "description": "The server cannot process the request, see the content for more details.",
14813
14960
  "content": {
14814
14961
  "application/json": {
14815
14962
  "schema": {
@@ -14818,8 +14965,11 @@
14818
14965
  "examples": {
14819
14966
  "exampleResponse": {
14820
14967
  "value": {
14821
- "name": "UnauthorizedError",
14822
- "message": "errorMessage"
14968
+ "name": "GeneralError",
14969
+ "message": "errorMessage",
14970
+ "properties": {
14971
+ "foo": "bar"
14972
+ }
14823
14973
  }
14824
14974
  }
14825
14975
  }
@@ -15046,7 +15196,7 @@
15046
15196
  {
15047
15197
  "@context": "http://www.w3.org/ns/odrl.jsonld",
15048
15198
  "@type": "Set",
15049
- "uid": "urn:rights-management:abc123def456",
15199
+ "@id": "urn:rights-management:abc123def456",
15050
15200
  "permission": [
15051
15201
  {
15052
15202
  "target": "http://example.com/asset/1",
@@ -15151,14 +15301,14 @@
15151
15301
  "content": {
15152
15302
  "application/json": {
15153
15303
  "schema": {
15154
- "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
15304
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolPolicy"
15155
15305
  },
15156
15306
  "examples": {
15157
15307
  "papUpdateRequestExample": {
15158
15308
  "value": {
15159
15309
  "@context": "http://www.w3.org/ns/odrl.jsonld",
15160
15310
  "@type": "Set",
15161
- "uid": "urn:rights-management:abc123def456",
15311
+ "@id": "urn:rights-management:abc123def456",
15162
15312
  "permission": [
15163
15313
  {
15164
15314
  "target": "http://example.com/asset/2",
@@ -15264,14 +15414,14 @@
15264
15414
  "content": {
15265
15415
  "application/json": {
15266
15416
  "schema": {
15267
- "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
15417
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolPolicy"
15268
15418
  },
15269
15419
  "examples": {
15270
15420
  "papGetResponseExample": {
15271
15421
  "value": {
15272
15422
  "@context": "http://www.w3.org/ns/odrl.jsonld",
15273
15423
  "@type": "Set",
15274
- "uid": "urn:rights-management:abc123def456",
15424
+ "@id": "urn:rights-management:abc123def456",
15275
15425
  "permission": [
15276
15426
  {
15277
15427
  "target": "http://example.com/asset/1",
@@ -15462,14 +15612,14 @@
15462
15612
  "content": {
15463
15613
  "application/json": {
15464
15614
  "schema": {
15465
- "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAgreement"
15615
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolAgreement"
15466
15616
  },
15467
15617
  "examples": {
15468
15618
  "papGetResponseExample": {
15469
15619
  "value": {
15470
15620
  "@context": "http://www.w3.org/ns/odrl.jsonld",
15471
15621
  "@type": "Agreement",
15472
- "uid": "urn:rights-management:abc123def456",
15622
+ "@id": "urn:rights-management:abc123def456",
15473
15623
  "permission": [
15474
15624
  {
15475
15625
  "target": "http://example.com/asset/1",
@@ -15575,14 +15725,14 @@
15575
15725
  "content": {
15576
15726
  "application/json": {
15577
15727
  "schema": {
15578
- "$ref": "https://schema.twindev.org/w3c-odrl/OdrlOffer"
15728
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolOffer"
15579
15729
  },
15580
15730
  "examples": {
15581
15731
  "papGetResponseExample": {
15582
15732
  "value": {
15583
15733
  "@context": "http://www.w3.org/ns/odrl.jsonld",
15584
15734
  "@type": "Offer",
15585
- "uid": "urn:rights-management:abc123def456",
15735
+ "@id": "urn:rights-management:abc123def456",
15586
15736
  "permission": [
15587
15737
  {
15588
15738
  "target": "http://example.com/asset/1",
@@ -15688,14 +15838,14 @@
15688
15838
  "content": {
15689
15839
  "application/json": {
15690
15840
  "schema": {
15691
- "$ref": "https://schema.twindev.org/w3c-odrl/OdrlSet"
15841
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolSet"
15692
15842
  },
15693
15843
  "examples": {
15694
15844
  "papGetResponseExample": {
15695
15845
  "value": {
15696
15846
  "@context": "http://www.w3.org/ns/odrl.jsonld",
15697
15847
  "@type": "Set",
15698
- "uid": "urn:rights-management:abc123def456",
15848
+ "@id": "urn:rights-management:abc123def456",
15699
15849
  "permission": [
15700
15850
  {
15701
15851
  "target": "http://example.com/asset/1",
@@ -15922,9 +16072,8 @@
15922
16072
  "@type": "ContractRequestMessage",
15923
16073
  "consumerPid": "urn:contract-negotiation:22aa11bb.......ffff",
15924
16074
  "offer": {
15925
- "@context": "http://www.w3.org/ns/odrl.jsonld",
15926
16075
  "@type": "Offer",
15927
- "uid": "urn:offer-1",
16076
+ "@id": "urn:offer-1",
15928
16077
  "assigner": "urn:provider:node:1"
15929
16078
  }
15930
16079
  }
@@ -16036,9 +16185,8 @@
16036
16185
  "@type": "ContractRequestMessage",
16037
16186
  "consumerPid": "urn:contract-negotiation:22aa11bb.......ffff",
16038
16187
  "offer": {
16039
- "@context": "http://www.w3.org/ns/odrl.jsonld",
16040
16188
  "@type": "Offer",
16041
- "uid": "urn:offer-1",
16189
+ "@id": "urn:offer-1",
16042
16190
  "assigner": "urn:provider:node:1"
16043
16191
  }
16044
16192
  }
@@ -16496,9 +16644,8 @@
16496
16644
  "providerPid": "urn:contract-negotiation:00aa11bb.......ffff",
16497
16645
  "consumerPid": "urn:contract-negotiation:22aa11bb.......ffff",
16498
16646
  "offer": {
16499
- "@context": "http://www.w3.org/ns/odrl.jsonld",
16500
16647
  "@type": "Offer",
16501
- "uid": "urn:offer-1",
16648
+ "@id": "urn:offer-1",
16502
16649
  "assigner": "urn:provider:node:1"
16503
16650
  }
16504
16651
  }
@@ -16610,9 +16757,8 @@
16610
16757
  "providerPid": "urn:contract-negotiation:00aa11bb.......ffff",
16611
16758
  "consumerPid": "urn:contract-negotiation:22aa11bb.......ffff",
16612
16759
  "offer": {
16613
- "@context": "http://www.w3.org/ns/odrl.jsonld",
16614
16760
  "@type": "Offer",
16615
- "uid": "urn:offer-1",
16761
+ "@id": "urn:offer-1",
16616
16762
  "assigner": "urn:provider:node:1"
16617
16763
  }
16618
16764
  }
@@ -16744,9 +16890,8 @@
16744
16890
  "providerPid": "urn:contract-negotiation:00aa11bb.......ffff",
16745
16891
  "consumerPid": "urn:contract-negotiation:22aa11bb.......ffff",
16746
16892
  "agreement": {
16747
- "@context": "http://www.w3.org/ns/odrl.jsonld",
16748
16893
  "@type": "Agreement",
16749
- "uid": "urn:offer-1",
16894
+ "@id": "urn:offer-1",
16750
16895
  "assigner": "urn:provider:node:1",
16751
16896
  "assignee": "urn:consumer:node:1"
16752
16897
  }
@@ -17233,7 +17378,25 @@
17233
17378
  },
17234
17379
  "components": {
17235
17380
  "schemas": {
17236
- "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",
17237
17400
  "type": "object",
17238
17401
  "properties": {
17239
17402
  "id": {
@@ -17259,7 +17422,19 @@
17259
17422
  "retryCount": {
17260
17423
  "type": "number",
17261
17424
  "description": "Number of times this activity has been retried."
17262
- },
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": {
17263
17438
  "status": {
17264
17439
  "$ref": "#/components/schemas/ActivityProcessingStatus"
17265
17440
  },
@@ -17274,29 +17449,13 @@
17274
17449
  "type": "array",
17275
17450
  "items": {
17276
17451
  "type": "object",
17277
- "additionalProperties": false,
17278
- "properties": {
17279
- "startDate": {
17280
- "type": "string",
17281
- "description": "Task processing start timestamp"
17282
- },
17283
- "endDate": {
17284
- "type": "string",
17285
- "description": "Task processing end timestamp"
17286
- },
17287
- "taskId": {
17288
- "type": "string",
17289
- "description": "Task Id."
17452
+ "allOf": [
17453
+ {
17454
+ "$ref": "#/components/schemas/TaskApp"
17290
17455
  },
17291
- "dataspaceAppId": {
17292
- "type": "string",
17293
- "description": "Dataspace App Id."
17456
+ {
17457
+ "$ref": "#/components/schemas/ActivityLogDates"
17294
17458
  }
17295
- },
17296
- "required": [
17297
- "dataspaceAppId",
17298
- "startDate",
17299
- "taskId"
17300
17459
  ]
17301
17460
  },
17302
17461
  "description": "The running tasks that are processing the Activity."
@@ -17305,34 +17464,22 @@
17305
17464
  "type": "array",
17306
17465
  "items": {
17307
17466
  "type": "object",
17308
- "additionalProperties": false,
17309
17467
  "properties": {
17310
17468
  "result": {
17311
17469
  "type": "string",
17312
17470
  "description": "The task result."
17313
- },
17314
- "startDate": {
17315
- "type": "string",
17316
- "description": "Task processing start timestamp"
17317
- },
17318
- "endDate": {
17319
- "type": "string",
17320
- "description": "Task processing end timestamp"
17321
- },
17322
- "taskId": {
17323
- "type": "string",
17324
- "description": "Task Id."
17325
- },
17326
- "dataspaceAppId": {
17327
- "type": "string",
17328
- "description": "Dataspace App Id."
17329
17471
  }
17330
17472
  },
17331
17473
  "required": [
17332
- "dataspaceAppId",
17333
- "result",
17334
- "startDate",
17335
- "taskId"
17474
+ "result"
17475
+ ],
17476
+ "allOf": [
17477
+ {
17478
+ "$ref": "#/components/schemas/TaskApp"
17479
+ },
17480
+ {
17481
+ "$ref": "#/components/schemas/ActivityLogDates"
17482
+ }
17336
17483
  ]
17337
17484
  },
17338
17485
  "description": "The tasks that have already finalized."
@@ -17341,1061 +17488,161 @@
17341
17488
  "type": "array",
17342
17489
  "items": {
17343
17490
  "type": "object",
17344
- "additionalProperties": false,
17345
17491
  "properties": {
17346
17492
  "error": {
17347
17493
  "$ref": "#/components/schemas/Error"
17348
- },
17349
- "taskId": {
17350
- "type": "string",
17351
- "description": "Task Id."
17352
- },
17353
- "dataspaceAppId": {
17354
- "type": "string",
17355
- "description": "Dataspace App Id."
17356
17494
  }
17357
17495
  },
17358
17496
  "required": [
17359
- "dataspaceAppId",
17360
- "error",
17361
- "taskId"
17497
+ "error"
17498
+ ],
17499
+ "allOf": [
17500
+ {
17501
+ "$ref": "#/components/schemas/TaskApp"
17502
+ }
17362
17503
  ]
17363
17504
  },
17364
17505
  "description": "The tasks that are in error."
17365
17506
  }
17366
17507
  },
17367
17508
  "required": [
17368
- "dateCreated",
17369
- "dateModified",
17370
- "generator",
17371
- "id",
17372
17509
  "status"
17373
17510
  ],
17374
- "description": "The details related to the processing of an Activity"
17511
+ "allOf": [
17512
+ {
17513
+ "$ref": "#/components/schemas/ActivityLogDetails"
17514
+ }
17515
+ ]
17375
17516
  },
17376
17517
  "ActivityProcessingStatus": {
17518
+ "description": "The type exported.",
17377
17519
  "anyOf": [
17378
17520
  {
17379
- "type": "string",
17380
17521
  "const": "pending",
17381
17522
  "description": "Pending: Activity Processing has not started yet."
17382
17523
  },
17383
17524
  {
17384
- "type": "string",
17385
17525
  "const": "running",
17386
17526
  "description": "Running Activity processing is running."
17387
17527
  },
17388
17528
  {
17389
- "type": "string",
17390
17529
  "const": "completed",
17391
17530
  "description": "Completed: Activity processing completed without error."
17392
17531
  },
17393
17532
  {
17394
- "type": "string",
17395
17533
  "const": "error",
17396
17534
  "description": "Error: Activity processing cannot be performed and marked as in error. (Depends on application)."
17397
17535
  },
17398
17536
  {
17399
- "type": "string",
17400
17537
  "const": "registering",
17401
17538
  "description": "Transient state. The background tasks associated with the activity are still being registered."
17402
17539
  }
17403
- ],
17404
- "description": "Activity processing statuses. The type exported."
17540
+ ]
17405
17541
  },
17406
- "ActivityStreamsActivity": {
17542
+ "AdminUserCreateRequest": {
17543
+ "description": "The body of the request.",
17407
17544
  "type": "object",
17408
17545
  "properties": {
17409
- "@context": {
17410
- "$ref": "#/components/schemas/ActivityStreamsContextType"
17546
+ "email": {
17547
+ "type": "string",
17548
+ "description": "The user e-mail address."
17411
17549
  },
17412
- "type": {
17413
- "description": "Object or array data type",
17414
- "anyOf": [
17415
- {
17416
- "$ref": "#/components/schemas/ActivityStreamsTypes"
17417
- },
17418
- {
17419
- "type": "string"
17420
- },
17421
- {
17422
- "type": "array",
17423
- "items": {
17424
- "anyOf": [
17425
- {
17426
- "$ref": "#/components/schemas/ActivityStreamsTypes"
17427
- },
17428
- {
17429
- "type": "string"
17430
- }
17431
- ]
17432
- }
17433
- }
17434
- ]
17550
+ "password": {
17551
+ "type": "string",
17552
+ "description": "The encrypted password for the user."
17435
17553
  },
17436
- "id": {
17554
+ "userIdentity": {
17437
17555
  "type": "string",
17438
- "description": "Global identifier."
17556
+ "description": "The user identity."
17439
17557
  },
17440
- "name": {
17441
- "anyOf": [
17442
- {
17443
- "type": "string"
17444
- },
17445
- {
17446
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17447
- }
17448
- ],
17449
- "description": "Natural language name."
17558
+ "organizationIdentity": {
17559
+ "type": "string",
17560
+ "description": "The users organization."
17450
17561
  },
17451
- "nameMap": {
17452
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
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": {
17583
+ "type": "string",
17584
+ "description": "The user e-mail address."
17453
17585
  },
17454
- "summary": {
17455
- "anyOf": [
17456
- {
17457
- "type": "string"
17458
- },
17459
- {
17460
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17461
- }
17462
- ],
17463
- "description": "Summary of the Activity."
17586
+ "userIdentity": {
17587
+ "type": "string",
17588
+ "description": "The user identity."
17464
17589
  },
17465
- "summaryMap": {
17466
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17590
+ "organizationIdentity": {
17591
+ "type": "string",
17592
+ "description": "The users organization."
17467
17593
  },
17468
- "content": {
17469
- "anyOf": [
17470
- {
17471
- "type": "string"
17472
- },
17473
- {
17474
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17475
- }
17476
- ],
17477
- "description": "Natural language content."
17594
+ "scope": {
17595
+ "type": "array",
17596
+ "items": {
17597
+ "type": "string"
17598
+ },
17599
+ "description": "The scope assigned to the user, comma separated."
17600
+ }
17601
+ },
17602
+ "required": [
17603
+ "email",
17604
+ "userIdentity",
17605
+ "organizationIdentity",
17606
+ "scope"
17607
+ ]
17608
+ },
17609
+ "AdminUserUpdatePasswordRequest": {
17610
+ "type": "object",
17611
+ "properties": {
17612
+ "newPassword": {
17613
+ "type": "string",
17614
+ "description": "The new password for the user."
17478
17615
  },
17479
- "contentMap": {
17480
- "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
17616
+ "currentPassword": {
17617
+ "type": "string",
17618
+ "description": "The current password for the user."
17619
+ }
17620
+ },
17621
+ "required": [
17622
+ "newPassword"
17623
+ ],
17624
+ "description": "The body of the request."
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."
17481
17633
  },
17482
- "url": {
17483
- "description": "Object or array data type",
17484
- "anyOf": [
17485
- {
17486
- "type": "string"
17487
- },
17488
- {
17489
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17490
- },
17491
- {
17492
- "type": "array",
17493
- "items": {
17494
- "anyOf": [
17495
- {
17496
- "type": "string"
17497
- },
17498
- {
17499
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17500
- }
17501
- ]
17502
- }
17503
- }
17504
- ]
17634
+ "organizationIdentity": {
17635
+ "type": "string",
17636
+ "description": "The users organization."
17505
17637
  },
17506
- "image": {
17507
- "description": "Object or array data type",
17508
- "anyOf": [
17509
- {
17510
- "type": "string"
17511
- },
17512
- {
17513
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17514
- },
17515
- {
17516
- "type": "array",
17517
- "items": {
17518
- "anyOf": [
17519
- {
17520
- "type": "string"
17521
- },
17522
- {
17523
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17524
- }
17525
- ]
17526
- }
17527
- }
17528
- ]
17529
- },
17530
- "icon": {
17531
- "description": "Object or array data type",
17532
- "anyOf": [
17533
- {
17534
- "type": "string"
17535
- },
17536
- {
17537
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17538
- },
17539
- {
17540
- "type": "array",
17541
- "items": {
17542
- "anyOf": [
17543
- {
17544
- "type": "string"
17545
- },
17546
- {
17547
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17548
- }
17549
- ]
17550
- }
17551
- }
17552
- ]
17553
- },
17554
- "published": {
17555
- "type": "string",
17556
- "description": "Published date-time."
17557
- },
17558
- "updated": {
17559
- "type": "string",
17560
- "description": "The date and time at which the object was updated."
17561
- },
17562
- "startTime": {
17563
- "type": "string",
17564
- "description": "Start time."
17565
- },
17566
- "endTime": {
17567
- "type": "string",
17568
- "description": "End time."
17569
- },
17570
- "duration": {
17571
- "type": "string",
17572
- "description": "Duration."
17573
- },
17574
- "generator": {
17575
- "description": "Object or array data type",
17576
- "anyOf": [
17577
- {
17578
- "type": "string"
17579
- },
17580
- {
17581
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17582
- },
17583
- {
17584
- "type": "array",
17585
- "items": {
17586
- "anyOf": [
17587
- {
17588
- "type": "string"
17589
- },
17590
- {
17591
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17592
- }
17593
- ]
17594
- }
17595
- }
17596
- ]
17597
- },
17598
- "attachment": {
17599
- "description": "Object or array data type",
17600
- "anyOf": [
17601
- {
17602
- "type": "string"
17603
- },
17604
- {
17605
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17606
- },
17607
- {
17608
- "type": "array",
17609
- "items": {
17610
- "anyOf": [
17611
- {
17612
- "type": "string"
17613
- },
17614
- {
17615
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17616
- }
17617
- ]
17618
- }
17619
- }
17620
- ]
17621
- },
17622
- "attributedTo": {
17623
- "description": "Object or array data type",
17624
- "anyOf": [
17625
- {
17626
- "type": "string"
17627
- },
17628
- {
17629
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17630
- },
17631
- {
17632
- "type": "array",
17633
- "items": {
17634
- "anyOf": [
17635
- {
17636
- "type": "string"
17637
- },
17638
- {
17639
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17640
- }
17641
- ]
17642
- }
17643
- }
17644
- ]
17645
- },
17646
- "audience": {
17647
- "description": "Object or array data type",
17648
- "anyOf": [
17649
- {
17650
- "type": "string"
17651
- },
17652
- {
17653
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17654
- },
17655
- {
17656
- "type": "array",
17657
- "items": {
17658
- "anyOf": [
17659
- {
17660
- "type": "string"
17661
- },
17662
- {
17663
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17664
- }
17665
- ]
17666
- }
17667
- }
17668
- ]
17669
- },
17670
- "context": {
17671
- "description": "Object or array data type",
17672
- "anyOf": [
17673
- {
17674
- "type": "string"
17675
- },
17676
- {
17677
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17678
- },
17679
- {
17680
- "type": "array",
17681
- "items": {
17682
- "anyOf": [
17683
- {
17684
- "type": "string"
17685
- },
17686
- {
17687
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17688
- }
17689
- ]
17690
- }
17691
- }
17692
- ]
17693
- },
17694
- "location": {
17695
- "description": "Object or array data type",
17696
- "anyOf": [
17697
- {
17698
- "type": "string"
17699
- },
17700
- {
17701
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17702
- },
17703
- {
17704
- "type": "array",
17705
- "items": {
17706
- "anyOf": [
17707
- {
17708
- "type": "string"
17709
- },
17710
- {
17711
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17712
- }
17713
- ]
17714
- }
17715
- }
17716
- ]
17717
- },
17718
- "tag": {
17719
- "description": "Object or array data type",
17720
- "anyOf": [
17721
- {
17722
- "type": "string"
17723
- },
17724
- {
17725
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17726
- },
17727
- {
17728
- "type": "array",
17729
- "items": {
17730
- "anyOf": [
17731
- {
17732
- "type": "string"
17733
- },
17734
- {
17735
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17736
- }
17737
- ]
17738
- }
17739
- }
17740
- ]
17741
- },
17742
- "inReplyTo": {
17743
- "description": "Object or array data type",
17744
- "anyOf": [
17745
- {
17746
- "type": "string"
17747
- },
17748
- {
17749
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17750
- },
17751
- {
17752
- "type": "array",
17753
- "items": {
17754
- "anyOf": [
17755
- {
17756
- "type": "string"
17757
- },
17758
- {
17759
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17760
- }
17761
- ]
17762
- }
17763
- }
17764
- ]
17765
- },
17766
- "replies": {
17767
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17768
- },
17769
- "preview": {
17770
- "description": "Object or array data type",
17771
- "anyOf": [
17772
- {
17773
- "type": "string"
17774
- },
17775
- {
17776
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17777
- },
17778
- {
17779
- "type": "array",
17780
- "items": {
17781
- "anyOf": [
17782
- {
17783
- "type": "string"
17784
- },
17785
- {
17786
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17787
- }
17788
- ]
17789
- }
17790
- }
17791
- ]
17792
- },
17793
- "to": {
17794
- "description": "Object or array data type",
17795
- "anyOf": [
17796
- {
17797
- "type": "string"
17798
- },
17799
- {
17800
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17801
- },
17802
- {
17803
- "type": "array",
17804
- "items": {
17805
- "anyOf": [
17806
- {
17807
- "type": "string"
17808
- },
17809
- {
17810
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17811
- }
17812
- ]
17813
- }
17814
- }
17815
- ]
17816
- },
17817
- "bto": {
17818
- "description": "Object or array data type",
17819
- "anyOf": [
17820
- {
17821
- "type": "string"
17822
- },
17823
- {
17824
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17825
- },
17826
- {
17827
- "type": "array",
17828
- "items": {
17829
- "anyOf": [
17830
- {
17831
- "type": "string"
17832
- },
17833
- {
17834
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17835
- }
17836
- ]
17837
- }
17838
- }
17839
- ]
17840
- },
17841
- "cc": {
17842
- "description": "Object or array data type",
17843
- "anyOf": [
17844
- {
17845
- "type": "string"
17846
- },
17847
- {
17848
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17849
- },
17850
- {
17851
- "type": "array",
17852
- "items": {
17853
- "anyOf": [
17854
- {
17855
- "type": "string"
17856
- },
17857
- {
17858
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17859
- }
17860
- ]
17861
- }
17862
- }
17863
- ]
17864
- },
17865
- "bcc": {
17866
- "description": "Object or array data type",
17867
- "anyOf": [
17868
- {
17869
- "type": "string"
17870
- },
17871
- {
17872
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17873
- },
17874
- {
17875
- "type": "array",
17876
- "items": {
17877
- "anyOf": [
17878
- {
17879
- "type": "string"
17880
- },
17881
- {
17882
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17883
- }
17884
- ]
17885
- }
17886
- }
17887
- ]
17888
- },
17889
- "mediaType": {
17890
- "type": "string",
17891
- "description": "MIME media type of the referenced resource."
17892
- },
17893
- "actor": {
17894
- "description": "Object or array data type",
17895
- "anyOf": [
17896
- {
17897
- "type": "string"
17898
- },
17899
- {
17900
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17901
- },
17902
- {
17903
- "type": "array",
17904
- "items": {
17905
- "anyOf": [
17906
- {
17907
- "type": "string"
17908
- },
17909
- {
17910
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17911
- }
17912
- ]
17913
- }
17914
- }
17915
- ]
17916
- },
17917
- "object": {
17918
- "description": "Object or array data type",
17919
- "anyOf": [
17920
- {
17921
- "type": "string"
17922
- },
17923
- {
17924
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17925
- },
17926
- {
17927
- "type": "array",
17928
- "items": {
17929
- "anyOf": [
17930
- {
17931
- "type": "string"
17932
- },
17933
- {
17934
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17935
- }
17936
- ]
17937
- }
17938
- }
17939
- ]
17940
- },
17941
- "target": {
17942
- "description": "Object or array data type",
17943
- "anyOf": [
17944
- {
17945
- "type": "string"
17946
- },
17947
- {
17948
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17949
- },
17950
- {
17951
- "type": "array",
17952
- "items": {
17953
- "anyOf": [
17954
- {
17955
- "type": "string"
17956
- },
17957
- {
17958
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17959
- }
17960
- ]
17961
- }
17962
- }
17963
- ]
17964
- },
17965
- "result": {
17966
- "description": "Object or array data type",
17967
- "anyOf": [
17968
- {
17969
- "type": "string"
17970
- },
17971
- {
17972
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17973
- },
17974
- {
17975
- "type": "array",
17976
- "items": {
17977
- "anyOf": [
17978
- {
17979
- "type": "string"
17980
- },
17981
- {
17982
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17983
- }
17984
- ]
17985
- }
17986
- }
17987
- ]
17988
- },
17989
- "origin": {
17990
- "description": "Object or array data type",
17991
- "anyOf": [
17992
- {
17993
- "type": "string"
17994
- },
17995
- {
17996
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
17997
- },
17998
- {
17999
- "type": "array",
18000
- "items": {
18001
- "anyOf": [
18002
- {
18003
- "type": "string"
18004
- },
18005
- {
18006
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18007
- }
18008
- ]
18009
- }
18010
- }
18011
- ]
18012
- },
18013
- "instrument": {
18014
- "description": "Object or array data type",
18015
- "anyOf": [
18016
- {
18017
- "type": "string"
18018
- },
18019
- {
18020
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18021
- },
18022
- {
18023
- "type": "array",
18024
- "items": {
18025
- "anyOf": [
18026
- {
18027
- "type": "string"
18028
- },
18029
- {
18030
- "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18031
- }
18032
- ]
18033
- }
18034
- }
18035
- ]
18036
- }
18037
- },
18038
- "required": [
18039
- "@context",
18040
- "type"
18041
- ],
18042
- "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`."
18043
- },
18044
- "ActivityStreamsContextType": {
18045
- "anyOf": [
18046
- {
18047
- "type": "string",
18048
- "const": "https://www.w3.org/ns/activitystreams"
18049
- },
18050
- {
18051
- "type": "array",
18052
- "items": {
18053
- "type": "string",
18054
- "const": "https://www.w3.org/ns/activitystreams"
18055
- },
18056
- "minItems": 1,
18057
- "maxItems": 1
18058
- },
18059
- {
18060
- "type": "array",
18061
- "minItems": 1,
18062
- "prefixItems": [
18063
- {
18064
- "type": "string",
18065
- "const": "https://www.w3.org/ns/activitystreams"
18066
- }
18067
- ],
18068
- "items": {
18069
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
18070
- }
18071
- },
18072
- {
18073
- "type": "array",
18074
- "minItems": 1,
18075
- "prefixItems": [
18076
- {
18077
- "type": "string",
18078
- "const": "https://www.w3.org/ns/activitystreams"
18079
- }
18080
- ],
18081
- "items": {
18082
- "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
18083
- }
18084
- }
18085
- ],
18086
- "description": "The Activity Streams JSON-LD context type."
18087
- },
18088
- "ActivityStreamsLinkTypes": {
18089
- "anyOf": [
18090
- {
18091
- "type": "string",
18092
- "const": "Link",
18093
- "description": "Link"
18094
- },
18095
- {
18096
- "type": "string",
18097
- "const": "Mention",
18098
- "description": "Mention"
18099
- }
18100
- ],
18101
- "description": "The link types concerning Activity Streams."
18102
- },
18103
- "ActivityStreamsObjectTypes": {
18104
- "anyOf": [
18105
- {
18106
- "type": "string",
18107
- "const": "Object",
18108
- "description": "Object"
18109
- },
18110
- {
18111
- "type": "string",
18112
- "const": "Activity",
18113
- "description": "Activity"
18114
- },
18115
- {
18116
- "type": "string",
18117
- "const": "IntransitiveActivity",
18118
- "description": "IntransitiveActivity"
18119
- },
18120
- {
18121
- "type": "string",
18122
- "const": "Collection",
18123
- "description": "Collection"
18124
- },
18125
- {
18126
- "type": "string",
18127
- "const": "OrderedCollection",
18128
- "description": "OrderedCollection"
18129
- },
18130
- {
18131
- "type": "string",
18132
- "const": "CollectionPage",
18133
- "description": "CollectionPage"
18134
- },
18135
- {
18136
- "type": "string",
18137
- "const": "OrderedCollectionPage",
18138
- "description": "OrderedCollectionPage"
18139
- },
18140
- {
18141
- "type": "string",
18142
- "const": "Actor",
18143
- "description": "Actor"
18144
- },
18145
- {
18146
- "type": "string",
18147
- "const": "Application",
18148
- "description": "Application"
18149
- },
18150
- {
18151
- "type": "string",
18152
- "const": "Group",
18153
- "description": "Group"
18154
- },
18155
- {
18156
- "type": "string",
18157
- "const": "Organization",
18158
- "description": "Organization"
18159
- },
18160
- {
18161
- "type": "string",
18162
- "const": "Person",
18163
- "description": "Person"
18164
- },
18165
- {
18166
- "type": "string",
18167
- "const": "Service",
18168
- "description": "Service"
18169
- },
18170
- {
18171
- "type": "string",
18172
- "const": "Article",
18173
- "description": "Article"
18174
- },
18175
- {
18176
- "type": "string",
18177
- "const": "Audio",
18178
- "description": "Audio"
18179
- },
18180
- {
18181
- "type": "string",
18182
- "const": "Document",
18183
- "description": "Document"
18184
- },
18185
- {
18186
- "type": "string",
18187
- "const": "Event",
18188
- "description": "Event"
18189
- },
18190
- {
18191
- "type": "string",
18192
- "const": "Image",
18193
- "description": "Image"
18194
- },
18195
- {
18196
- "type": "string",
18197
- "const": "Note",
18198
- "description": "Note"
18199
- },
18200
- {
18201
- "type": "string",
18202
- "const": "Page",
18203
- "description": "Page"
18204
- },
18205
- {
18206
- "type": "string",
18207
- "const": "Place",
18208
- "description": "Place"
18209
- },
18210
- {
18211
- "type": "string",
18212
- "const": "Profile",
18213
- "description": "Profile"
18214
- },
18215
- {
18216
- "type": "string",
18217
- "const": "Relationship",
18218
- "description": "Relationship"
18219
- },
18220
- {
18221
- "type": "string",
18222
- "const": "Tombstone",
18223
- "description": "Tombstone"
18224
- },
18225
- {
18226
- "type": "string",
18227
- "const": "Video",
18228
- "description": "Video"
18229
- }
18230
- ],
18231
- "description": "The object types concerning Activity Streams."
18232
- },
18233
- "ActivityStreamsTypes": {
18234
- "anyOf": [
18235
- {
18236
- "type": "string",
18237
- "const": "Activity",
18238
- "description": "Activity.\n\nGeneric base type for activities (actions) in Activity Streams."
18239
- },
18240
- {
18241
- "type": "string",
18242
- "const": "Accept",
18243
- "description": "Accept.\n\nIndicates that the actor accepts the object."
18244
- },
18245
- {
18246
- "type": "string",
18247
- "const": "Add",
18248
- "description": "Add.\n\nIndicates that the actor added the object to the target."
18249
- },
18250
- {
18251
- "type": "string",
18252
- "const": "Announce",
18253
- "description": "Announce.\n\nIndicates that the actor is calling attention to the object."
18254
- },
18255
- {
18256
- "type": "string",
18257
- "const": "Arrive",
18258
- "description": "Arrive.\n\nIntransitive activity indicating that the actor arrived at a location."
18259
- },
18260
- {
18261
- "type": "string",
18262
- "const": "Block",
18263
- "description": "Block.\n\nIndicates that the actor is blocking the object (a stronger form of Ignore)."
18264
- },
18265
- {
18266
- "type": "string",
18267
- "const": "Create",
18268
- "description": "Create.\n\nIndicates that the actor has created the object."
18269
- },
18270
- {
18271
- "type": "string",
18272
- "const": "Delete",
18273
- "description": "Delete.\n\nIndicates that the actor has deleted the object."
18274
- },
18275
- {
18276
- "type": "string",
18277
- "const": "Dislike",
18278
- "description": "Dislike.\n\nIndicates that the actor dislikes the object."
18279
- },
18280
- {
18281
- "type": "string",
18282
- "const": "Flag",
18283
- "description": "Flag.\n\nIndicates that the actor is flagging the object (e.g., reporting it)."
18284
- },
18285
- {
18286
- "type": "string",
18287
- "const": "Follow",
18288
- "description": "Follow.\n\nIndicates that the actor is following the object."
18289
- },
18290
- {
18291
- "type": "string",
18292
- "const": "Ignore",
18293
- "description": "Ignore.\n\nIndicates that the actor is ignoring the object."
18294
- },
18295
- {
18296
- "type": "string",
18297
- "const": "Invite",
18298
- "description": "Invite.\n\nSpecialization of Offer in which the actor is extending an invitation."
18299
- },
18300
- {
18301
- "type": "string",
18302
- "const": "Join",
18303
- "description": "Join.\n\nIndicates that the actor has joined the object."
18304
- },
18305
- {
18306
- "type": "string",
18307
- "const": "Leave",
18308
- "description": "Leave.\n\nIndicates that the actor has left the object."
18309
- },
18310
- {
18311
- "type": "string",
18312
- "const": "Like",
18313
- "description": "Like.\n\nIndicates that the actor likes, recommends, or endorses the object."
18314
- },
18315
- {
18316
- "type": "string",
18317
- "const": "Listen",
18318
- "description": "Listen.\n\nIndicates that the actor has listened to the object."
18319
- },
18320
- {
18321
- "type": "string",
18322
- "const": "Move",
18323
- "description": "Move.\n\nIndicates that the actor has moved the object from `origin` to `target`."
18324
- },
18325
- {
18326
- "type": "string",
18327
- "const": "Offer",
18328
- "description": "Offer.\n\nIndicates that the actor is offering the object (optionally to a target)."
18329
- },
18330
- {
18331
- "type": "string",
18332
- "const": "Question",
18333
- "description": "Question.\n\nIntransitive activity representing a question; can express options via `oneOf`/`anyOf`."
18334
- },
18335
- {
18336
- "type": "string",
18337
- "const": "Reject",
18338
- "description": "Reject.\n\nIndicates that the actor is rejecting the object."
18339
- },
18340
- {
18341
- "type": "string",
18342
- "const": "Read",
18343
- "description": "Read.\n\nIndicates that the actor has read the object."
18344
- },
18345
- {
18346
- "type": "string",
18347
- "const": "Remove",
18348
- "description": "Remove.\n\nIndicates that the actor is removing the object (optionally from an origin context)."
18349
- },
18350
- {
18351
- "type": "string",
18352
- "const": "TentativeReject",
18353
- "description": "TentativeReject.\n\nSpecialization of Reject indicating that the rejection is tentative."
18354
- },
18355
- {
18356
- "type": "string",
18357
- "const": "TentativeAccept",
18358
- "description": "TentativeAccept.\n\nSpecialization of Accept indicating that the acceptance is tentative."
18359
- },
18360
- {
18361
- "type": "string",
18362
- "const": "Travel",
18363
- "description": "Travel.\n\nIntransitive activity indicating that the actor is travelling to `target` from `origin`."
18364
- },
18365
- {
18366
- "type": "string",
18367
- "const": "Undo",
18368
- "description": "Undo.\n\nIndicates that the actor is undoing a previous activity."
18369
- },
18370
- {
18371
- "type": "string",
18372
- "const": "Update",
18373
- "description": "Update.\n\nIndicates that the actor has updated the object."
18374
- },
18375
- {
18376
- "type": "string",
18377
- "const": "View",
18378
- "description": "View.\n\nIndicates that the actor has viewed the object."
18379
- }
18380
- ],
18381
- "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"
18382
- },
18383
- "AdminUserUpdatePasswordRequest": {
18384
- "type": "object",
18385
- "properties": {
18386
- "newPassword": {
18387
- "type": "string",
18388
- "description": "The new password for the user."
18389
- },
18390
- "currentPassword": {
18391
- "type": "string",
18392
- "description": "The current password for the user."
17638
+ "scope": {
17639
+ "type": "array",
17640
+ "items": {
17641
+ "type": "string"
17642
+ },
17643
+ "description": "The scope assigned to the user, comma separated."
18393
17644
  }
18394
- },
18395
- "required": [
18396
- "newPassword"
18397
- ],
18398
- "description": "The body of the request."
17645
+ }
18399
17646
  },
18400
17647
  "AttestationCreateRequest": {
18401
17648
  "type": "object",
@@ -18457,8 +17704,7 @@
18457
17704
  },
18458
17705
  "required": [
18459
17706
  "id"
18460
- ],
18461
- "additionalProperties": false
17707
+ ]
18462
17708
  },
18463
17709
  "description": "Alternative aliases that can be used to identify the vertex."
18464
17710
  },
@@ -18473,8 +17719,7 @@
18473
17719
  "resourceObject": {
18474
17720
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18475
17721
  }
18476
- },
18477
- "additionalProperties": false
17722
+ }
18478
17723
  },
18479
17724
  "description": "The resources attached to the vertex."
18480
17725
  },
@@ -18499,8 +17744,7 @@
18499
17744
  "required": [
18500
17745
  "targetId",
18501
17746
  "edgeRelationships"
18502
- ],
18503
- "additionalProperties": false
17747
+ ]
18504
17748
  },
18505
17749
  "description": "The edges connected to the vertex."
18506
17750
  }
@@ -18533,8 +17777,7 @@
18533
17777
  },
18534
17778
  "required": [
18535
17779
  "id"
18536
- ],
18537
- "additionalProperties": false
17780
+ ]
18538
17781
  },
18539
17782
  "description": "Alternative aliases that can be used to identify the vertex."
18540
17783
  },
@@ -18549,8 +17792,7 @@
18549
17792
  "resourceObject": {
18550
17793
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
18551
17794
  }
18552
- },
18553
- "additionalProperties": false
17795
+ }
18554
17796
  },
18555
17797
  "description": "The resources attached to the vertex."
18556
17798
  },
@@ -18578,8 +17820,7 @@
18578
17820
  "required": [
18579
17821
  "targetId",
18580
17822
  "edgeRelationships"
18581
- ],
18582
- "additionalProperties": false
17823
+ ]
18583
17824
  },
18584
17825
  "description": "The edges connected to the vertex."
18585
17826
  }
@@ -18615,14 +17856,13 @@
18615
17856
  },
18616
17857
  "required": [
18617
17858
  "entryObject"
18618
- ],
18619
- "additionalProperties": false
17859
+ ]
18620
17860
  },
18621
17861
  "description": "The entries for the stream."
18622
17862
  },
18623
17863
  "immutableInterval": {
18624
17864
  "type": "number",
18625
- "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."
18626
17866
  }
18627
17867
  },
18628
17868
  "description": "The data to be used in the stream."
@@ -18715,62 +17955,63 @@
18715
17955
  "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogError"
18716
17956
  }
18717
17957
  ],
18718
- "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."
18719
17959
  },
18720
17960
  "CoerceType": {
17961
+ "description": "The types the extracted data can be coerced to.",
18721
17962
  "anyOf": [
18722
17963
  {
18723
- "type": "string",
18724
17964
  "const": "string",
18725
17965
  "description": "String."
18726
17966
  },
18727
17967
  {
18728
- "type": "string",
18729
17968
  "const": "number",
18730
17969
  "description": "Number."
18731
17970
  },
18732
17971
  {
18733
- "type": "string",
18734
17972
  "const": "integer",
18735
17973
  "description": "Integer."
18736
17974
  },
18737
17975
  {
18738
- "type": "string",
18739
17976
  "const": "boolean",
18740
17977
  "description": "Boolean."
18741
17978
  },
18742
17979
  {
18743
- "type": "string",
18744
17980
  "const": "bigint",
18745
17981
  "description": "Big Integer."
18746
17982
  },
18747
17983
  {
18748
- "type": "string",
18749
17984
  "const": "date",
18750
17985
  "description": "Date."
18751
17986
  },
18752
17987
  {
18753
- "type": "string",
18754
17988
  "const": "datetime",
18755
17989
  "description": "Date Time."
18756
17990
  },
18757
17991
  {
18758
- "type": "string",
18759
17992
  "const": "time",
18760
17993
  "description": "Time."
18761
17994
  },
18762
17995
  {
18763
- "type": "string",
18764
17996
  "const": "object",
18765
17997
  "description": "Object."
18766
17998
  },
18767
17999
  {
18768
- "type": "string",
18769
18000
  "const": "uint8array",
18770
18001
  "description": "Uint8Array."
18771
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
+ }
18772
18013
  ],
18773
- "description": "The types the extracted data can be coerced to."
18014
+ "description": "Transfer Process (DSP compliant) with state COMPLETED, or error."
18774
18015
  },
18775
18016
  "ConflictResponse": {
18776
18017
  "type": "object",
@@ -18781,49 +18022,27 @@
18781
18022
  "type": "string"
18782
18023
  },
18783
18024
  "description": "The conflicting items."
18784
- },
18785
- "name": {
18786
- "type": "string",
18787
- "description": "The name for the error."
18788
- },
18789
- "message": {
18790
- "type": "string",
18791
- "description": "The message for the error."
18792
- },
18793
- "source": {
18794
- "type": "string",
18795
- "description": "The source of the error."
18796
- },
18797
- "properties": {
18798
- "type": "object",
18799
- "additionalProperties": {},
18800
- "description": "Any additional information for the error."
18801
- },
18802
- "stack": {
18803
- "type": "string",
18804
- "description": "The stack trace for the error."
18805
- },
18806
- "cause": {
18807
- "$ref": "#/components/schemas/Error"
18808
18025
  }
18809
18026
  },
18810
18027
  "required": [
18811
- "conflicts",
18812
- "message",
18813
- "name"
18028
+ "conflicts"
18029
+ ],
18030
+ "allOf": [
18031
+ {
18032
+ "$ref": "#/components/schemas/Error"
18033
+ }
18814
18034
  ],
18815
18035
  "description": "The body which contains the error."
18816
18036
  },
18817
18037
  "DataAssetItemList": {
18038
+ "description": "Interface describing a list of entities that are within a Data Asset.\nPagination is handled via HTTP Link headers.",
18818
18039
  "type": "object",
18819
18040
  "properties": {
18820
18041
  "@context": {
18821
- "type": "string",
18822
18042
  "const": "https://schema.org",
18823
18043
  "description": "The LD Context."
18824
18044
  },
18825
18045
  "type": {
18826
- "type": "string",
18827
18046
  "const": "ItemList",
18828
18047
  "description": "The type"
18829
18048
  },
@@ -18839,15 +18058,14 @@
18839
18058
  "@context",
18840
18059
  "type",
18841
18060
  "itemListElement"
18842
- ],
18843
- "description": "Interface describing a list of entities that are within a Data Asset. Pagination is handled via HTTP Link headers."
18061
+ ]
18844
18062
  },
18845
18063
  "DataAssetQueryRequest": {
18846
18064
  "type": "object",
18847
18065
  "properties": {
18848
18066
  "consumerPid": {
18849
18067
  "type": "string",
18850
- "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."
18851
18069
  },
18852
18070
  "query": {
18853
18071
  "$ref": "#/components/schemas/FilteringQuery"
@@ -18906,7 +18124,7 @@
18906
18124
  "description": "The params for the extract."
18907
18125
  },
18908
18126
  "DataProcessingExtractResponse": {
18909
- "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."
18910
18128
  },
18911
18129
  "DataProcessingRuleGroupListResponse": {
18912
18130
  "type": "object",
@@ -18987,8 +18205,7 @@
18987
18205
  },
18988
18206
  "required": [
18989
18207
  "targetId"
18990
- ],
18991
- "additionalProperties": false
18208
+ ]
18992
18209
  },
18993
18210
  "description": "The auditable item graph vertices to connect the document to."
18994
18211
  },
@@ -19006,6 +18223,7 @@
19006
18223
  },
19007
18224
  "required": [
19008
18225
  "documentId",
18226
+ "documentIdFormat",
19009
18227
  "documentCode",
19010
18228
  "blob"
19011
18229
  ],
@@ -19038,8 +18256,7 @@
19038
18256
  },
19039
18257
  "required": [
19040
18258
  "targetId"
19041
- ],
19042
- "additionalProperties": false
18259
+ ]
19043
18260
  },
19044
18261
  "description": "The auditable item graph vertices to connect the document to."
19045
18262
  }
@@ -19047,6 +18264,7 @@
19047
18264
  "description": "The body parameters."
19048
18265
  },
19049
18266
  "Error": {
18267
+ "description": "Model to describe serialized error.",
19050
18268
  "type": "object",
19051
18269
  "properties": {
19052
18270
  "name": {
@@ -19077,10 +18295,10 @@
19077
18295
  "required": [
19078
18296
  "name",
19079
18297
  "message"
19080
- ],
19081
- "description": "Model to describe serialized error."
18298
+ ]
19082
18299
  },
19083
18300
  "FilteringQuery": {
18301
+ "description": "A query over a data asset that to be processed by a Dataspace Data Plane App.",
19084
18302
  "type": "object",
19085
18303
  "properties": {
19086
18304
  "type": {
@@ -19101,8 +18319,7 @@
19101
18319
  "required": [
19102
18320
  "type",
19103
18321
  "q"
19104
- ],
19105
- "description": "A query over a data asset that to be processed by a Dataspace Data Plane App."
18322
+ ]
19106
18323
  },
19107
18324
  "GetDatasetResponse": {
19108
18325
  "anyOf": [
@@ -19115,7 +18332,19 @@
19115
18332
  ],
19116
18333
  "description": "The response payload containing the dataset or error."
19117
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
+ },
19118
18346
  "HealthComponentInfo": {
18347
+ "description": "The health component information.",
19119
18348
  "type": "object",
19120
18349
  "properties": {
19121
18350
  "name": {
@@ -19133,10 +18362,10 @@
19133
18362
  "required": [
19134
18363
  "name",
19135
18364
  "status"
19136
- ],
19137
- "description": "The health component information."
18365
+ ]
19138
18366
  },
19139
18367
  "HealthInfo": {
18368
+ "description": "The status of the server.",
19140
18369
  "type": "object",
19141
18370
  "properties": {
19142
18371
  "status": {
@@ -19152,28 +18381,24 @@
19152
18381
  },
19153
18382
  "required": [
19154
18383
  "status"
19155
- ],
19156
- "description": "The status of the server."
18384
+ ]
19157
18385
  },
19158
18386
  "HealthStatus": {
18387
+ "description": "The health status of the component.",
19159
18388
  "anyOf": [
19160
18389
  {
19161
- "type": "string",
19162
18390
  "const": "ok",
19163
18391
  "description": "OK."
19164
18392
  },
19165
18393
  {
19166
- "type": "string",
19167
18394
  "const": "warning",
19168
18395
  "description": "Warning."
19169
18396
  },
19170
18397
  {
19171
- "type": "string",
19172
18398
  "const": "error",
19173
18399
  "description": "Error."
19174
18400
  }
19175
- ],
19176
- "description": "The health status of the component."
18401
+ ]
19177
18402
  },
19178
18403
  "IdentityCreateRequest": {
19179
18404
  "type": "object",
@@ -19197,18 +18422,13 @@
19197
18422
  },
19198
18423
  "description": "The data for the request."
19199
18424
  },
18425
+ "IdentityProfileGetPublicResponse": {},
19200
18426
  "IdentityProfileGetResponse": {
19201
18427
  "type": "object",
19202
18428
  "properties": {
19203
18429
  "identity": {
19204
18430
  "type": "string",
19205
18431
  "description": "The identity of the profile, this is the authenticated user identity."
19206
- },
19207
- "publicProfile": {
19208
- "$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
19209
- },
19210
- "privateProfile": {
19211
- "$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
19212
18432
  }
19213
18433
  },
19214
18434
  "required": [
@@ -19227,15 +18447,11 @@
19227
18447
  "identity": {
19228
18448
  "type": "string",
19229
18449
  "description": "The identity."
19230
- },
19231
- "publicProfile": {
19232
- "$ref": "https://schema.twindev.org/json-ld/JsonLdDocument"
19233
18450
  }
19234
18451
  },
19235
18452
  "required": [
19236
18453
  "identity"
19237
- ],
19238
- "additionalProperties": false
18454
+ ]
19239
18455
  },
19240
18456
  "description": "The identities."
19241
18457
  },
@@ -19522,6 +18738,7 @@
19522
18738
  "description": "The parameters from the body."
19523
18739
  },
19524
18740
  "LogEntry": {
18741
+ "description": "Interface describing a log entry.",
19525
18742
  "type": "object",
19526
18743
  "properties": {
19527
18744
  "level": {
@@ -19552,38 +18769,32 @@
19552
18769
  "level",
19553
18770
  "source",
19554
18771
  "message"
19555
- ],
19556
- "description": "Interface describing a log entry."
18772
+ ]
19557
18773
  },
19558
18774
  "LogLevel": {
18775
+ "description": "The log levels.",
19559
18776
  "anyOf": [
19560
18777
  {
19561
- "type": "string",
19562
18778
  "const": "info",
19563
18779
  "description": "Info."
19564
18780
  },
19565
18781
  {
19566
- "type": "string",
19567
18782
  "const": "error",
19568
18783
  "description": "Error."
19569
18784
  },
19570
18785
  {
19571
- "type": "string",
19572
18786
  "const": "warn",
19573
18787
  "description": "Warn."
19574
18788
  },
19575
18789
  {
19576
- "type": "string",
19577
18790
  "const": "trace",
19578
18791
  "description": "Trace."
19579
18792
  },
19580
18793
  {
19581
- "type": "string",
19582
18794
  "const": "debug",
19583
18795
  "description": "Debug."
19584
18796
  }
19585
- ],
19586
- "description": "The log levels."
18797
+ ]
19587
18798
  },
19588
18799
  "LoggingListResponse": {
19589
18800
  "type": "object",
@@ -19637,24 +18848,21 @@
19637
18848
  "description": "The login response details."
19638
18849
  },
19639
18850
  "MetricType": {
18851
+ "description": "The types of metrics.",
19640
18852
  "anyOf": [
19641
18853
  {
19642
- "type": "number",
19643
18854
  "const": 0,
19644
18855
  "description": "Counter."
19645
18856
  },
19646
18857
  {
19647
- "type": "number",
19648
18858
  "const": 1,
19649
18859
  "description": "Increment Decrement Counter."
19650
18860
  },
19651
18861
  {
19652
- "type": "number",
19653
18862
  "const": 2,
19654
18863
  "description": "Gauge."
19655
18864
  }
19656
- ],
19657
- "description": "The types of metrics."
18865
+ ]
19658
18866
  },
19659
18867
  "NftMintRequest": {
19660
18868
  "type": "object",
@@ -19744,49 +18952,24 @@
19744
18952
  "notFoundId": {
19745
18953
  "type": "string",
19746
18954
  "description": "The id if the item that was not found."
19747
- },
19748
- "name": {
19749
- "type": "string",
19750
- "description": "The name for the error."
19751
- },
19752
- "message": {
19753
- "type": "string",
19754
- "description": "The message for the error."
19755
- },
19756
- "source": {
19757
- "type": "string",
19758
- "description": "The source of the error."
19759
- },
19760
- "properties": {
19761
- "type": "object",
19762
- "additionalProperties": {},
19763
- "description": "Any additional information for the error."
19764
- },
19765
- "stack": {
19766
- "type": "string",
19767
- "description": "The stack trace for the error."
19768
- },
19769
- "cause": {
19770
- "$ref": "#/components/schemas/Error"
19771
18955
  }
19772
18956
  },
19773
- "required": [
19774
- "message",
19775
- "name"
18957
+ "allOf": [
18958
+ {
18959
+ "$ref": "#/components/schemas/Error"
18960
+ }
19776
18961
  ],
19777
18962
  "description": "The body which contains the error."
19778
18963
  },
19779
18964
  "PapCreateRequest": {
18965
+ "description": "The body of the request - the policy to create (id will be auto-generated if not provided).",
19780
18966
  "type": "object",
19781
18967
  "properties": {
19782
- "uid": {
19783
- "type": "string"
19784
- },
19785
18968
  "@context": {
19786
18969
  "$ref": "https://schema.twindev.org/w3c-odrl/OdrlContextType"
19787
18970
  },
19788
18971
  "@type": {
19789
- "$ref": "https://schema.twindev.org/w3c-odrl/PolicyType"
18972
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicyType"
19790
18973
  },
19791
18974
  "profile": {
19792
18975
  "anyOf": [
@@ -19800,7 +18983,7 @@
19800
18983
  }
19801
18984
  }
19802
18985
  ],
19803
- "description": "The profile(s) this policy conforms to. IRIs identifying the ODRL Profile(s)."
18986
+ "description": "The profile(s) this policy conforms to.\nIRIs identifying the ODRL Profile(s)."
19804
18987
  },
19805
18988
  "assigner": {
19806
18989
  "anyOf": [
@@ -19830,7 +19013,7 @@
19830
19013
  }
19831
19014
  }
19832
19015
  ],
19833
- "description": "The assigner of the policy. Applies to all rules unless overridden at rule level."
19016
+ "description": "The assigner of the policy.\nApplies to all rules unless overridden at rule level."
19834
19017
  },
19835
19018
  "assignee": {
19836
19019
  "anyOf": [
@@ -19860,7 +19043,7 @@
19860
19043
  }
19861
19044
  }
19862
19045
  ],
19863
- "description": "The assignee of the policy. Applies to all rules unless overridden at rule level."
19046
+ "description": "The assignee of the policy.\nApplies to all rules unless overridden at rule level."
19864
19047
  },
19865
19048
  "target": {
19866
19049
  "anyOf": [
@@ -19895,7 +19078,7 @@
19895
19078
  "action": {
19896
19079
  "anyOf": [
19897
19080
  {
19898
- "$ref": "https://schema.twindev.org/w3c-odrl/ActionType"
19081
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
19899
19082
  },
19900
19083
  {
19901
19084
  "type": "string"
@@ -19908,7 +19091,7 @@
19908
19091
  "items": {
19909
19092
  "anyOf": [
19910
19093
  {
19911
- "$ref": "https://schema.twindev.org/w3c-odrl/ActionType"
19094
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
19912
19095
  },
19913
19096
  {
19914
19097
  "type": "string"
@@ -19934,10 +19117,10 @@
19934
19117
  }
19935
19118
  }
19936
19119
  ],
19937
- "description": "The parent policy(ies) this policy inherits from. IRIs identifying the parent Policy(ies)."
19120
+ "description": "The parent policy(ies) this policy inherits from.\nIRIs identifying the parent Policy(ies)."
19938
19121
  },
19939
19122
  "conflict": {
19940
- "$ref": "https://schema.twindev.org/w3c-odrl/ConflictStrategyType"
19123
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlConflictStrategyType"
19941
19124
  },
19942
19125
  "permission": {
19943
19126
  "anyOf": [
@@ -19951,7 +19134,7 @@
19951
19134
  }
19952
19135
  }
19953
19136
  ],
19954
- "description": "The permissions in the policy. At least one of permission, prohibition, or obligation must be present."
19137
+ "description": "The permissions in the policy.\nAt least one of permission, prohibition, or obligation must be present."
19955
19138
  },
19956
19139
  "prohibition": {
19957
19140
  "anyOf": [
@@ -19965,7 +19148,7 @@
19965
19148
  }
19966
19149
  }
19967
19150
  ],
19968
- "description": "The prohibitions in the policy. At least one of permission, prohibition, or obligation must be present."
19151
+ "description": "The prohibitions in the policy.\nAt least one of permission, prohibition, or obligation must be present."
19969
19152
  },
19970
19153
  "obligation": {
19971
19154
  "anyOf": [
@@ -19979,19 +19162,22 @@
19979
19162
  }
19980
19163
  }
19981
19164
  ],
19982
- "description": "The obligations in the policy. At least one of permission, prohibition, or obligation must be present."
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."
19983
19170
  }
19984
19171
  },
19985
19172
  "required": [
19986
19173
  "@context",
19987
19174
  "@type"
19988
- ],
19989
- "description": "The body of the request - the policy to create (uid will be auto-generated)."
19175
+ ]
19990
19176
  },
19991
19177
  "PapQueryResponse": {
19992
19178
  "type": "array",
19993
19179
  "items": {
19994
- "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
19180
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolPolicy"
19995
19181
  },
19996
19182
  "description": "The body of the response."
19997
19183
  },
@@ -20003,7 +19189,7 @@
20003
19189
  "description": "The body of the response."
20004
19190
  },
20005
19191
  "PnpContractNegotiationResponse": {
20006
- "anyOf": [
19192
+ "oneOf": [
20007
19193
  {
20008
19194
  "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiation"
20009
19195
  },
@@ -20014,6 +19200,7 @@
20014
19200
  "description": "The state of the policy or an error."
20015
19201
  },
20016
19202
  "PolicyNegotiation": {
19203
+ "description": "Interface describing a rights management policy negotiation.",
20017
19204
  "type": "object",
20018
19205
  "properties": {
20019
19206
  "id": {
@@ -20043,15 +19230,19 @@
20043
19230
  "type": "string",
20044
19231
  "description": "The callback address to send updates to the requester."
20045
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
+ },
20046
19237
  "organizationIdentity": {
20047
19238
  "type": "string",
20048
19239
  "description": "Organization identity to be used when sending trust payloads."
20049
19240
  },
20050
19241
  "offer": {
20051
- "$ref": "https://schema.twindev.org/w3c-odrl/OdrlOffer"
19242
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolOffer"
20052
19243
  },
20053
19244
  "agreement": {
20054
- "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAgreement"
19245
+ "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolAgreement"
20055
19246
  },
20056
19247
  "trustVerificationInfo": {
20057
19248
  "$ref": "#/components/schemas/TrustVerificationInfo"
@@ -20074,8 +19265,7 @@
20074
19265
  },
20075
19266
  "required": [
20076
19267
  "@value"
20077
- ],
20078
- "additionalProperties": false
19268
+ ]
20079
19269
  },
20080
19270
  "description": "A more detailed reason for the negotiation error."
20081
19271
  },
@@ -20093,8 +19283,7 @@
20093
19283
  },
20094
19284
  "required": [
20095
19285
  "@value"
20096
- ],
20097
- "additionalProperties": false
19286
+ ]
20098
19287
  },
20099
19288
  "description": "A more detailed reason for the negotiation error."
20100
19289
  },
@@ -20116,8 +19305,7 @@
20116
19305
  "dateCreated",
20117
19306
  "state",
20118
19307
  "organizationIdentity"
20119
- ],
20120
- "description": "Interface describing a rights management policy negotiation."
19308
+ ]
20121
19309
  },
20122
19310
  "RefreshTokenResponse": {
20123
19311
  "type": "object",
@@ -20132,16 +19320,28 @@
20132
19320
  ],
20133
19321
  "description": "The refresh token details."
20134
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
+ },
20135
19334
  "Rule": {
19335
+ "description": "Rule defining how to extract data from an object.",
20136
19336
  "type": "object",
20137
19337
  "properties": {
20138
19338
  "source": {
20139
19339
  "type": "string",
20140
- "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."
20141
19341
  },
20142
19342
  "target": {
20143
19343
  "type": "string",
20144
- "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."
20145
19345
  },
20146
19346
  "retainPathDepth": {
20147
19347
  "type": "number",
@@ -20154,10 +19354,10 @@
20154
19354
  "required": [
20155
19355
  "source",
20156
19356
  "target"
20157
- ],
20158
- "description": "Rule defining how to extract data from an object."
19357
+ ]
20159
19358
  },
20160
19359
  "RuleGroup": {
19360
+ "description": "Group of rules for extraction.",
20161
19361
  "type": "object",
20162
19362
  "properties": {
20163
19363
  "id": {
@@ -20180,10 +19380,17 @@
20180
19380
  "id",
20181
19381
  "label",
20182
19382
  "rules"
20183
- ],
20184
- "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."
20185
19391
  },
20186
19392
  "ServerInfo": {
19393
+ "description": "The information about the server.",
20187
19394
  "type": "object",
20188
19395
  "properties": {
20189
19396
  "name": {
@@ -20198,14 +19405,16 @@
20198
19405
  "required": [
20199
19406
  "name",
20200
19407
  "version"
20201
- ],
20202
- "description": "The information about the server."
19408
+ ]
20203
19409
  },
20204
19410
  "ServerLivezResponse": {
20205
- "type": "string",
20206
- "enum": [
20207
- "ok",
20208
- "failed"
19411
+ "anyOf": [
19412
+ {
19413
+ "const": "ok"
19414
+ },
19415
+ {
19416
+ "const": "failed"
19417
+ }
20209
19418
  ],
20210
19419
  "description": "The livez information for the server."
20211
19420
  },
@@ -20217,21 +19426,42 @@
20217
19426
  "description": "The spec for the server."
20218
19427
  },
20219
19428
  "SortDirection": {
19429
+ "description": "The sort directions.",
20220
19430
  "anyOf": [
20221
19431
  {
20222
- "type": "string",
20223
19432
  "const": "asc",
20224
19433
  "description": "Ascending."
20225
19434
  },
20226
19435
  {
20227
- "type": "string",
20228
19436
  "const": "desc",
20229
19437
  "description": "Descending."
20230
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
+ }
20231
19460
  ],
20232
- "description": "The sort directions."
19461
+ "description": "Transfer Process (DSP compliant) with state SUSPENDED, or error."
20233
19462
  },
20234
19463
  "SyncChange": {
19464
+ "description": "The object definition for a sync change.",
20235
19465
  "type": "object",
20236
19466
  "properties": {
20237
19467
  "operation": {
@@ -20248,34 +19478,30 @@
20248
19478
  "required": [
20249
19479
  "operation",
20250
19480
  "id"
20251
- ],
20252
- "description": "The object definition for a sync change."
19481
+ ]
20253
19482
  },
20254
19483
  "SyncChangeOperation": {
19484
+ "description": "The operations for a change",
20255
19485
  "anyOf": [
20256
19486
  {
20257
- "type": "string",
20258
19487
  "const": "set",
20259
19488
  "description": "An item was set in the storage."
20260
19489
  },
20261
19490
  {
20262
- "type": "string",
20263
19491
  "const": "delete",
20264
19492
  "description": "An item was deleted from the storage."
20265
19493
  }
20266
- ],
20267
- "description": "The operations for a change. The operations for a change"
19494
+ ]
20268
19495
  },
20269
19496
  "SyncChangeSet": {
19497
+ "description": "The object definition for a sync change set.",
20270
19498
  "type": "object",
20271
19499
  "properties": {
20272
19500
  "@context": {
20273
- "type": "string",
20274
19501
  "const": "https://schema.twindev.org/synchronised-storage/",
20275
19502
  "description": "The LD Context for the change set."
20276
19503
  },
20277
19504
  "type": {
20278
- "type": "string",
20279
19505
  "const": "ChangeSet",
20280
19506
  "description": "The LD Type for the change set."
20281
19507
  },
@@ -20285,26 +19511,26 @@
20285
19511
  },
20286
19512
  "storageKey": {
20287
19513
  "type": "string",
20288
- "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."
20289
19515
  },
20290
19516
  "dateCreated": {
20291
19517
  "type": "string",
20292
- "description": "The date the change set was created. json-ld namespace:schema"
19518
+ "description": "The date the change set was created."
20293
19519
  },
20294
19520
  "dateModified": {
20295
19521
  "type": "string",
20296
- "description": "The date the change set was last modified. json-ld namespace:schema"
19522
+ "description": "The date the change set was last modified."
20297
19523
  },
20298
19524
  "nodeIdentity": {
20299
19525
  "type": "string",
20300
- "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."
20301
19527
  },
20302
19528
  "changes": {
20303
19529
  "type": "array",
20304
19530
  "items": {
20305
19531
  "$ref": "#/components/schemas/SyncChange"
20306
19532
  },
20307
- "description": "The changes to apply after a snapshot. json-ld type:json"
19533
+ "description": "The changes to apply after a snapshot."
20308
19534
  }
20309
19535
  },
20310
19536
  "required": [
@@ -20316,8 +19542,7 @@
20316
19542
  "dateModified",
20317
19543
  "nodeIdentity",
20318
19544
  "changes"
20319
- ],
20320
- "description": "The object definition for a sync change set."
19545
+ ]
20321
19546
  },
20322
19547
  "SyncDecryptionKeyResponse": {
20323
19548
  "type": "object",
@@ -20333,19 +19558,20 @@
20333
19558
  "description": "The body of the response."
20334
19559
  },
20335
19560
  "SynchronisedEntityCore": {
19561
+ "description": "The base definition for synchronised entries.",
20336
19562
  "type": "object",
20337
19563
  "properties": {
20338
19564
  "dateModified": {
20339
19565
  "type": "string",
20340
- "description": "The date the entry was modified. json-ld namespace:schema"
19566
+ "description": "The date the entry was modified."
20341
19567
  }
20342
19568
  },
20343
19569
  "required": [
20344
19570
  "dateModified"
20345
- ],
20346
- "description": "The base definition for synchronised entries."
19571
+ ]
20347
19572
  },
20348
19573
  "TaskApp": {
19574
+ "description": "Denotes a task associated with a Dataspace App",
20349
19575
  "type": "object",
20350
19576
  "properties": {
20351
19577
  "taskId": {
@@ -20360,8 +19586,7 @@
20360
19586
  "required": [
20361
19587
  "taskId",
20362
19588
  "dataspaceAppId"
20363
- ],
20364
- "description": "Denotes a task associated with a Dataspace App"
19589
+ ]
20365
19590
  },
20366
19591
  "TelemetryAddMetricValueRequest": {
20367
19592
  "type": "object",
@@ -20369,11 +19594,9 @@
20369
19594
  "value": {
20370
19595
  "anyOf": [
20371
19596
  {
20372
- "type": "string",
20373
19597
  "const": "inc"
20374
19598
  },
20375
19599
  {
20376
- "type": "string",
20377
19600
  "const": "dec"
20378
19601
  },
20379
19602
  {
@@ -20430,6 +19653,7 @@
20430
19653
  "description": "The response payload."
20431
19654
  },
20432
19655
  "TelemetryMetric": {
19656
+ "description": "Interface describing a telemetry metric.",
20433
19657
  "type": "object",
20434
19658
  "properties": {
20435
19659
  "id": {
@@ -20456,10 +19680,10 @@
20456
19680
  "id",
20457
19681
  "label",
20458
19682
  "type"
20459
- ],
20460
- "description": "Interface describing a telemetry metric."
19683
+ ]
20461
19684
  },
20462
19685
  "TelemetryMetricValue": {
19686
+ "description": "Interface describing a telemetry metric value.",
20463
19687
  "type": "object",
20464
19688
  "properties": {
20465
19689
  "id": {
@@ -20484,8 +19708,7 @@
20484
19708
  "id",
20485
19709
  "ts",
20486
19710
  "value"
20487
- ],
20488
- "description": "Interface describing a telemetry metric value."
19711
+ ]
20489
19712
  },
20490
19713
  "TelemetryUpdateMetricRequest": {
20491
19714
  "type": "object",
@@ -20532,7 +19755,19 @@
20532
19755
  ],
20533
19756
  "description": "The response payload."
20534
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
+ },
20535
19769
  "TrustVerificationInfo": {
19770
+ "description": "Interface describing a trust verifier information.",
20536
19771
  "type": "object",
20537
19772
  "properties": {
20538
19773
  "identity": {
@@ -20549,8 +19784,7 @@
20549
19784
  },
20550
19785
  "required": [
20551
19786
  "identity"
20552
- ],
20553
- "description": "Interface describing a trust verifier information."
19787
+ ]
20554
19788
  },
20555
19789
  "UpdatePasswordRequest": {
20556
19790
  "type": "object",
@@ -20673,24 +19907,21 @@
20673
19907
  "description": "The data to be updated."
20674
19908
  },
20675
19909
  "VerifyDepth": {
19910
+ "description": "How deep to verify the signatures.",
20676
19911
  "anyOf": [
20677
19912
  {
20678
- "type": "string",
20679
19913
  "const": "none",
20680
19914
  "description": "Do not verify any signatures."
20681
19915
  },
20682
19916
  {
20683
- "type": "string",
20684
19917
  "const": "current",
20685
19918
  "description": "Verify only the most recent signature."
20686
19919
  },
20687
19920
  {
20688
- "type": "string",
20689
19921
  "const": "all",
20690
19922
  "description": "Verify all the signatures."
20691
19923
  }
20692
- ],
20693
- "description": "How deep to verify the signatures."
19924
+ ]
20694
19925
  }
20695
19926
  },
20696
19927
  "securitySchemes": {