@twin.org/node 0.0.3-next.23 → 0.0.3-next.25

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.
@@ -88,8 +88,12 @@
88
88
  "description": "Service providing Dataspace Protocol-compliant catalogue endpoints for dataset discovery and query."
89
89
  },
90
90
  {
91
- "name": "Data Space Connector",
92
- "description": "Endpoints to access a Data Space Connector."
91
+ "name": "Dataspace Data Plane",
92
+ "description": "Endpoints to access a Dataspace Data Plane."
93
+ },
94
+ {
95
+ "name": "Transfer Process",
96
+ "description": "DSP Transfer Process Protocol endpoints for initiating and managing data transfers."
93
97
  },
94
98
  {
95
99
  "name": "Policy Administration Point",
@@ -5162,8 +5166,9 @@
5162
5166
  "in": "query",
5163
5167
  "required": false,
5164
5168
  "schema": {
5165
- "$ref": "#/components/schemas/MetricType"
5166
- }
5169
+ "type": "string"
5170
+ },
5171
+ "example": "0"
5167
5172
  },
5168
5173
  {
5169
5174
  "name": "cursor",
@@ -5730,10 +5735,7 @@
5730
5735
  "in": "query",
5731
5736
  "required": false,
5732
5737
  "schema": {
5733
- "type": [
5734
- "number",
5735
- "string"
5736
- ]
5738
+ "type": "string"
5737
5739
  }
5738
5740
  },
5739
5741
  {
@@ -5742,10 +5744,7 @@
5742
5744
  "in": "query",
5743
5745
  "required": false,
5744
5746
  "schema": {
5745
- "type": [
5746
- "number",
5747
- "string"
5748
- ]
5747
+ "type": "string"
5749
5748
  }
5750
5749
  },
5751
5750
  {
@@ -6011,10 +6010,7 @@
6011
6010
  "in": "query",
6012
6011
  "required": false,
6013
6012
  "schema": {
6014
- "type": [
6015
- "number",
6016
- "string"
6017
- ]
6013
+ "type": "string"
6018
6014
  }
6019
6015
  },
6020
6016
  {
@@ -6023,10 +6019,7 @@
6023
6019
  "in": "query",
6024
6020
  "required": false,
6025
6021
  "schema": {
6026
- "type": [
6027
- "number",
6028
- "string"
6029
- ]
6022
+ "type": "string"
6030
6023
  }
6031
6024
  },
6032
6025
  {
@@ -13886,12 +13879,12 @@
13886
13879
  }
13887
13880
  }
13888
13881
  },
13889
- "/data-space-connector/notify": {
13882
+ "/dataspace-data-plane/notify": {
13890
13883
  "post": {
13891
13884
  "operationId": "activityStreamNotify",
13892
13885
  "summary": "Notify of a new Activity",
13893
13886
  "tags": [
13894
- "Data Space Connector"
13887
+ "Dataspace Data Plane"
13895
13888
  ],
13896
13889
  "security": [
13897
13890
  {
@@ -14008,17 +14001,17 @@
14008
14001
  }
14009
14002
  }
14010
14003
  },
14011
- "/data-space-connector/activity-logs/{id}": {
14004
+ "/dataspace-data-plane/activity-logs/{id}": {
14012
14005
  "get": {
14013
- "operationId": "dataSpaceConnectorGetActivityLogEntry",
14006
+ "operationId": "dataspaceDataPlaneGetActivityLogEntry",
14014
14007
  "summary": "Get a Activity Log Entry",
14015
14008
  "tags": [
14016
- "Data Space Connector"
14009
+ "Dataspace Data Plane"
14017
14010
  ],
14018
14011
  "parameters": [
14019
14012
  {
14020
14013
  "name": "id",
14021
- "description": "The ID of the entry to get.",
14014
+ "description": "",
14022
14015
  "in": "path",
14023
14016
  "required": true,
14024
14017
  "schema": {
@@ -14052,7 +14045,7 @@
14052
14045
  "pendingTasks": [
14053
14046
  {
14054
14047
  "taskId": "urn:x-task-id:45678",
14055
- "dataSpaceConnectorAppId": "https://my-app.example.org/app1"
14048
+ "dataspaceAppId": "https://my-app.example.org/app1"
14056
14049
  }
14057
14050
  ],
14058
14051
  "runningTasks": [],
@@ -14124,79 +14117,12 @@
14124
14117
  }
14125
14118
  }
14126
14119
  },
14127
- "/data-space-connector/entities": {
14120
+ "/dataspace-data-plane/entities": {
14128
14121
  "get": {
14129
- "operationId": "dataSpaceConnectorGetDataAssetEntities",
14122
+ "operationId": "dataspaceDataPlaneGetDataAssetEntities",
14130
14123
  "summary": "Get Data Asset Entities",
14131
14124
  "tags": [
14132
- "Data Space Connector"
14133
- ],
14134
- "parameters": [
14135
- {
14136
- "name": "id",
14137
- "description": "The ID of the entity(ies) to get. (comma separated list)",
14138
- "in": "query",
14139
- "required": false,
14140
- "schema": {
14141
- "type": "string"
14142
- },
14143
- "example": "urn:ucr:24PLP051219453I002610799053311"
14144
- },
14145
- {
14146
- "name": "type",
14147
- "description": "The type of the entity to get.",
14148
- "in": "query",
14149
- "required": false,
14150
- "schema": {
14151
- "type": "string"
14152
- },
14153
- "example": "https://vocabulary.uncefact.org/Consignment"
14154
- },
14155
- {
14156
- "name": "dataServiceId",
14157
- "description": "The Id of the data service that offers the data asset",
14158
- "in": "query",
14159
- "required": false,
14160
- "schema": {
14161
- "type": "string"
14162
- }
14163
- },
14164
- {
14165
- "name": "datasetId",
14166
- "description": "The Id of the datasets that describes the data asset (comma separated list)",
14167
- "in": "query",
14168
- "required": false,
14169
- "schema": {
14170
- "type": "string"
14171
- }
14172
- },
14173
- {
14174
- "name": "limit",
14175
- "description": "The maximum number of entities to retrieve.",
14176
- "in": "query",
14177
- "required": false,
14178
- "schema": {
14179
- "type": "string"
14180
- }
14181
- },
14182
- {
14183
- "name": "cursor",
14184
- "description": "Cursor to control pagination.",
14185
- "in": "query",
14186
- "required": false,
14187
- "schema": {
14188
- "type": "string"
14189
- }
14190
- },
14191
- {
14192
- "name": "authorization",
14193
- "in": "header",
14194
- "required": true,
14195
- "schema": {
14196
- "type": "string"
14197
- },
14198
- "style": "simple"
14199
- }
14125
+ "Dataspace Data Plane"
14200
14126
  ],
14201
14127
  "responses": {
14202
14128
  "200": {
@@ -14266,41 +14192,12 @@
14266
14192
  }
14267
14193
  }
14268
14194
  },
14269
- "/data-space-connector/entities/query": {
14195
+ "/dataspace-data-plane/entities/query": {
14270
14196
  "post": {
14271
- "operationId": "dataSpaceConnectorQueryDataAsset",
14197
+ "operationId": "dataspaceDataPlaneQueryDataAsset",
14272
14198
  "summary": "Query Data Asset",
14273
14199
  "tags": [
14274
- "Data Space Connector"
14275
- ],
14276
- "parameters": [
14277
- {
14278
- "name": "cursor",
14279
- "description": "Opaque cursor token for pagination.",
14280
- "in": "query",
14281
- "required": false,
14282
- "schema": {
14283
- "type": "string"
14284
- }
14285
- },
14286
- {
14287
- "name": "limit",
14288
- "description": "Maximum number of items to return.",
14289
- "in": "query",
14290
- "required": false,
14291
- "schema": {
14292
- "type": "string"
14293
- }
14294
- },
14295
- {
14296
- "name": "authorization",
14297
- "in": "header",
14298
- "required": true,
14299
- "schema": {
14300
- "type": "string"
14301
- },
14302
- "style": "simple"
14303
- }
14200
+ "Dataspace Data Plane"
14304
14201
  ],
14305
14202
  "requestBody": {
14306
14203
  "description": "Request to query data asset entities.",
@@ -14313,7 +14210,7 @@
14313
14210
  "examples": {
14314
14211
  "dataAssetQuery": {
14315
14212
  "value": {
14316
- "dataAsset": {},
14213
+ "consumerPid": "urn:uuid:consumer-pid-12345",
14317
14214
  "query": {
14318
14215
  "type": "Example",
14319
14216
  "q": "example query"
@@ -14392,52 +14289,26 @@
14392
14289
  }
14393
14290
  }
14394
14291
  },
14395
- "/rights-management/policy/admin": {
14292
+ "/dataspace-control-plane/transfers/request": {
14396
14293
  "post": {
14397
- "operationId": "papCreate",
14398
- "summary": "Create a policy",
14294
+ "operationId": "requestTransfer",
14295
+ "summary": "Request Transfer Process (DSP)",
14399
14296
  "tags": [
14400
- "Policy Administration Point"
14297
+ "Transfer Process"
14401
14298
  ],
14402
14299
  "security": [
14403
14300
  {
14404
14301
  "jwtBearerAuthScheme": []
14405
14302
  }
14406
14303
  ],
14407
- "requestBody": {
14408
- "description": "The request structure for creating a policy.",
14409
- "required": true,
14410
- "content": {
14411
- "application/json": {
14412
- "schema": {
14413
- "$ref": "#/components/schemas/PapCreateRequest"
14414
- },
14415
- "examples": {
14416
- "papCreateRequestExample": {
14417
- "value": {
14418
- "@context": "http://www.w3.org/ns/odrl.jsonld",
14419
- "@type": "Set",
14420
- "permission": [
14421
- {
14422
- "target": "http://example.com/asset/1",
14423
- "action": "use"
14424
- }
14425
- ]
14426
- }
14427
- }
14428
- }
14429
- }
14430
- }
14431
- },
14432
14304
  "responses": {
14433
- "201": {
14434
- "description": "The rest request ended in created response.",
14435
- "headers": {
14436
- "location": {
14305
+ "200": {
14306
+ "description": "The rest request ended in success with no data.",
14307
+ "content": {
14308
+ "text/plain": {
14437
14309
  "schema": {
14438
- "type": "string"
14439
- },
14440
- "description": "e.g. urn:rights-management:abc123def456"
14310
+ "$ref": "#/components/schemas/OkResponse"
14311
+ }
14441
14312
  }
14442
14313
  }
14443
14314
  },
@@ -14499,77 +14370,25 @@
14499
14370
  }
14500
14371
  }
14501
14372
  }
14502
- },
14373
+ }
14374
+ },
14375
+ "/dataspace-control-plane/transfers/{pid}": {
14503
14376
  "get": {
14504
- "operationId": "papQuery",
14505
- "summary": "Query policies",
14377
+ "operationId": "getTransferProcess",
14378
+ "summary": "Get Transfer Process state (DSP)",
14506
14379
  "tags": [
14507
- "Policy Administration Point"
14380
+ "Transfer Process"
14508
14381
  ],
14509
14382
  "parameters": [
14510
14383
  {
14511
- "name": "assigner",
14512
- "description": "The assigner to filter by.",
14513
- "in": "query",
14514
- "required": false,
14515
- "schema": {
14516
- "type": "string"
14517
- }
14518
- },
14519
- {
14520
- "name": "assignee",
14521
- "description": "The assignee to filter by.",
14522
- "in": "query",
14523
- "required": false,
14524
- "schema": {
14525
- "type": "string"
14526
- }
14527
- },
14528
- {
14529
- "name": "action",
14530
- "description": "The action to filter by.",
14531
- "in": "query",
14532
- "required": false,
14533
- "schema": {
14534
- "type": "string"
14535
- }
14536
- },
14537
- {
14538
- "name": "target",
14539
- "description": "The target to filter by.",
14540
- "in": "query",
14541
- "required": false,
14542
- "schema": {
14543
- "type": "string"
14544
- }
14545
- },
14546
- {
14547
- "name": "conditions",
14548
- "description": "The condition for the query.",
14549
- "in": "query",
14550
- "required": false,
14551
- "schema": {
14552
- "type": "string"
14553
- }
14554
- },
14555
- {
14556
- "name": "limit",
14557
- "description": "Limit the number of entities to return.",
14558
- "in": "query",
14559
- "required": false,
14560
- "schema": {
14561
- "type": "string"
14562
- }
14563
- },
14564
- {
14565
- "name": "cursor",
14566
- "description": "The cursor to get next chunk of data, returned in previous response.",
14567
- "in": "query",
14568
- "required": false,
14384
+ "name": "pid",
14385
+ "description": "",
14386
+ "in": "path",
14387
+ "required": true,
14569
14388
  "schema": {
14570
14389
  "type": "string"
14571
14390
  },
14572
- "example": "optional-pagination-cursor"
14391
+ "style": "simple"
14573
14392
  }
14574
14393
  ],
14575
14394
  "security": [
@@ -14579,28 +14398,11 @@
14579
14398
  ],
14580
14399
  "responses": {
14581
14400
  "200": {
14582
- "description": "The response structure for querying policies.",
14401
+ "description": "The rest request ended in success with no data.",
14583
14402
  "content": {
14584
- "application/json": {
14403
+ "text/plain": {
14585
14404
  "schema": {
14586
- "$ref": "#/components/schemas/PapQueryResponse"
14587
- },
14588
- "examples": {
14589
- "papQueryResponseExample": {
14590
- "value": [
14591
- {
14592
- "@context": "http://www.w3.org/ns/odrl.jsonld",
14593
- "@type": "Set",
14594
- "uid": "urn:rights-management:abc123def456",
14595
- "permission": [
14596
- {
14597
- "target": "http://example.com/asset/1",
14598
- "action": "use"
14599
- }
14600
- ]
14601
- }
14602
- ]
14603
- }
14405
+ "$ref": "#/components/schemas/OkResponse"
14604
14406
  }
14605
14407
  }
14606
14408
  }
@@ -14665,24 +14467,23 @@
14665
14467
  }
14666
14468
  }
14667
14469
  },
14668
- "/rights-management/policy/admin/{id}": {
14669
- "put": {
14670
- "operationId": "papUpdate",
14671
- "summary": "Update a policy",
14470
+ "/dataspace-control-plane/transfers/{pid}/start": {
14471
+ "post": {
14472
+ "operationId": "startTransfer",
14473
+ "summary": "Start Transfer Process (DSP)",
14672
14474
  "tags": [
14673
- "Policy Administration Point"
14475
+ "Transfer Process"
14674
14476
  ],
14675
14477
  "parameters": [
14676
14478
  {
14677
- "name": "id",
14678
- "description": "The ID of the policy to update.",
14479
+ "name": "pid",
14480
+ "description": "",
14679
14481
  "in": "path",
14680
14482
  "required": true,
14681
14483
  "schema": {
14682
14484
  "type": "string"
14683
14485
  },
14684
- "style": "simple",
14685
- "example": "urn:rights-management:abc123def456"
14486
+ "style": "simple"
14686
14487
  }
14687
14488
  ],
14688
14489
  "security": [
@@ -14690,20 +14491,674 @@
14690
14491
  "jwtBearerAuthScheme": []
14691
14492
  }
14692
14493
  ],
14693
- "requestBody": {
14694
- "description": "The request structure for updating a policy.",
14695
- "required": true,
14696
- "content": {
14697
- "application/json": {
14698
- "schema": {
14699
- "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
14700
- },
14701
- "examples": {
14702
- "papUpdateRequestExample": {
14703
- "value": {
14704
- "@context": "http://www.w3.org/ns/odrl.jsonld",
14705
- "@type": "Set",
14706
- "uid": "urn:rights-management:abc123def456",
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"
14501
+ }
14502
+ }
14503
+ }
14504
+ },
14505
+ "400": {
14506
+ "description": "The server cannot process the request, see the content for more details.",
14507
+ "content": {
14508
+ "application/json": {
14509
+ "schema": {
14510
+ "$ref": "#/components/schemas/Error"
14511
+ },
14512
+ "examples": {
14513
+ "exampleResponse": {
14514
+ "value": {
14515
+ "name": "GeneralError",
14516
+ "message": "errorMessage",
14517
+ "properties": {
14518
+ "foo": "bar"
14519
+ }
14520
+ }
14521
+ }
14522
+ }
14523
+ }
14524
+ }
14525
+ },
14526
+ "401": {
14527
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
14528
+ "content": {
14529
+ "application/json": {
14530
+ "schema": {
14531
+ "$ref": "#/components/schemas/Error"
14532
+ },
14533
+ "examples": {
14534
+ "exampleResponse": {
14535
+ "value": {
14536
+ "name": "UnauthorizedError",
14537
+ "message": "errorMessage"
14538
+ }
14539
+ }
14540
+ }
14541
+ }
14542
+ }
14543
+ },
14544
+ "500": {
14545
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
14546
+ "content": {
14547
+ "application/json": {
14548
+ "schema": {
14549
+ "$ref": "#/components/schemas/Error"
14550
+ },
14551
+ "examples": {
14552
+ "exampleResponse": {
14553
+ "value": {
14554
+ "name": "InternalServerError",
14555
+ "message": "errorMessage"
14556
+ }
14557
+ }
14558
+ }
14559
+ }
14560
+ }
14561
+ }
14562
+ }
14563
+ }
14564
+ },
14565
+ "/dataspace-control-plane/transfers/{pid}/complete": {
14566
+ "post": {
14567
+ "operationId": "completeTransfer",
14568
+ "summary": "Complete Transfer Process (DSP)",
14569
+ "tags": [
14570
+ "Transfer Process"
14571
+ ],
14572
+ "parameters": [
14573
+ {
14574
+ "name": "pid",
14575
+ "description": "",
14576
+ "in": "path",
14577
+ "required": true,
14578
+ "schema": {
14579
+ "type": "string"
14580
+ },
14581
+ "style": "simple"
14582
+ }
14583
+ ],
14584
+ "security": [
14585
+ {
14586
+ "jwtBearerAuthScheme": []
14587
+ }
14588
+ ],
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"
14596
+ }
14597
+ }
14598
+ }
14599
+ },
14600
+ "400": {
14601
+ "description": "The server cannot process the request, see the content for more details.",
14602
+ "content": {
14603
+ "application/json": {
14604
+ "schema": {
14605
+ "$ref": "#/components/schemas/Error"
14606
+ },
14607
+ "examples": {
14608
+ "exampleResponse": {
14609
+ "value": {
14610
+ "name": "GeneralError",
14611
+ "message": "errorMessage",
14612
+ "properties": {
14613
+ "foo": "bar"
14614
+ }
14615
+ }
14616
+ }
14617
+ }
14618
+ }
14619
+ }
14620
+ },
14621
+ "401": {
14622
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
14623
+ "content": {
14624
+ "application/json": {
14625
+ "schema": {
14626
+ "$ref": "#/components/schemas/Error"
14627
+ },
14628
+ "examples": {
14629
+ "exampleResponse": {
14630
+ "value": {
14631
+ "name": "UnauthorizedError",
14632
+ "message": "errorMessage"
14633
+ }
14634
+ }
14635
+ }
14636
+ }
14637
+ }
14638
+ },
14639
+ "500": {
14640
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
14641
+ "content": {
14642
+ "application/json": {
14643
+ "schema": {
14644
+ "$ref": "#/components/schemas/Error"
14645
+ },
14646
+ "examples": {
14647
+ "exampleResponse": {
14648
+ "value": {
14649
+ "name": "InternalServerError",
14650
+ "message": "errorMessage"
14651
+ }
14652
+ }
14653
+ }
14654
+ }
14655
+ }
14656
+ }
14657
+ }
14658
+ }
14659
+ },
14660
+ "/dataspace-control-plane/transfers/{pid}/suspend": {
14661
+ "post": {
14662
+ "operationId": "suspendTransfer",
14663
+ "summary": "Suspend Transfer Process (DSP)",
14664
+ "tags": [
14665
+ "Transfer Process"
14666
+ ],
14667
+ "parameters": [
14668
+ {
14669
+ "name": "pid",
14670
+ "description": "",
14671
+ "in": "path",
14672
+ "required": true,
14673
+ "schema": {
14674
+ "type": "string"
14675
+ },
14676
+ "style": "simple"
14677
+ }
14678
+ ],
14679
+ "security": [
14680
+ {
14681
+ "jwtBearerAuthScheme": []
14682
+ }
14683
+ ],
14684
+ "responses": {
14685
+ "200": {
14686
+ "description": "The rest request ended in success with no data.",
14687
+ "content": {
14688
+ "text/plain": {
14689
+ "schema": {
14690
+ "$ref": "#/components/schemas/OkResponse"
14691
+ }
14692
+ }
14693
+ }
14694
+ },
14695
+ "400": {
14696
+ "description": "The server cannot process the request, see the content for more details.",
14697
+ "content": {
14698
+ "application/json": {
14699
+ "schema": {
14700
+ "$ref": "#/components/schemas/Error"
14701
+ },
14702
+ "examples": {
14703
+ "exampleResponse": {
14704
+ "value": {
14705
+ "name": "GeneralError",
14706
+ "message": "errorMessage",
14707
+ "properties": {
14708
+ "foo": "bar"
14709
+ }
14710
+ }
14711
+ }
14712
+ }
14713
+ }
14714
+ }
14715
+ },
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
+ "500": {
14735
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
14736
+ "content": {
14737
+ "application/json": {
14738
+ "schema": {
14739
+ "$ref": "#/components/schemas/Error"
14740
+ },
14741
+ "examples": {
14742
+ "exampleResponse": {
14743
+ "value": {
14744
+ "name": "InternalServerError",
14745
+ "message": "errorMessage"
14746
+ }
14747
+ }
14748
+ }
14749
+ }
14750
+ }
14751
+ }
14752
+ }
14753
+ }
14754
+ },
14755
+ "/dataspace-control-plane/transfers/{pid}/terminate": {
14756
+ "post": {
14757
+ "operationId": "terminateTransfer",
14758
+ "summary": "Terminate Transfer Process (DSP)",
14759
+ "tags": [
14760
+ "Transfer Process"
14761
+ ],
14762
+ "parameters": [
14763
+ {
14764
+ "name": "pid",
14765
+ "description": "",
14766
+ "in": "path",
14767
+ "required": true,
14768
+ "schema": {
14769
+ "type": "string"
14770
+ },
14771
+ "style": "simple"
14772
+ }
14773
+ ],
14774
+ "security": [
14775
+ {
14776
+ "jwtBearerAuthScheme": []
14777
+ }
14778
+ ],
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"
14786
+ }
14787
+ }
14788
+ }
14789
+ },
14790
+ "400": {
14791
+ "description": "The server cannot process the request, see the content for more details.",
14792
+ "content": {
14793
+ "application/json": {
14794
+ "schema": {
14795
+ "$ref": "#/components/schemas/Error"
14796
+ },
14797
+ "examples": {
14798
+ "exampleResponse": {
14799
+ "value": {
14800
+ "name": "GeneralError",
14801
+ "message": "errorMessage",
14802
+ "properties": {
14803
+ "foo": "bar"
14804
+ }
14805
+ }
14806
+ }
14807
+ }
14808
+ }
14809
+ }
14810
+ },
14811
+ "401": {
14812
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
14813
+ "content": {
14814
+ "application/json": {
14815
+ "schema": {
14816
+ "$ref": "#/components/schemas/Error"
14817
+ },
14818
+ "examples": {
14819
+ "exampleResponse": {
14820
+ "value": {
14821
+ "name": "UnauthorizedError",
14822
+ "message": "errorMessage"
14823
+ }
14824
+ }
14825
+ }
14826
+ }
14827
+ }
14828
+ },
14829
+ "500": {
14830
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
14831
+ "content": {
14832
+ "application/json": {
14833
+ "schema": {
14834
+ "$ref": "#/components/schemas/Error"
14835
+ },
14836
+ "examples": {
14837
+ "exampleResponse": {
14838
+ "value": {
14839
+ "name": "InternalServerError",
14840
+ "message": "errorMessage"
14841
+ }
14842
+ }
14843
+ }
14844
+ }
14845
+ }
14846
+ }
14847
+ }
14848
+ }
14849
+ },
14850
+ "/rights-management/policy/admin": {
14851
+ "post": {
14852
+ "operationId": "papCreate",
14853
+ "summary": "Create a policy",
14854
+ "tags": [
14855
+ "Policy Administration Point"
14856
+ ],
14857
+ "security": [
14858
+ {
14859
+ "jwtBearerAuthScheme": []
14860
+ }
14861
+ ],
14862
+ "requestBody": {
14863
+ "description": "The request structure for creating a policy.",
14864
+ "required": true,
14865
+ "content": {
14866
+ "application/json": {
14867
+ "schema": {
14868
+ "$ref": "#/components/schemas/PapCreateRequest"
14869
+ },
14870
+ "examples": {
14871
+ "papCreateRequestExample": {
14872
+ "value": {
14873
+ "@context": "http://www.w3.org/ns/odrl.jsonld",
14874
+ "@type": "Set",
14875
+ "permission": [
14876
+ {
14877
+ "target": "http://example.com/asset/1",
14878
+ "action": "use"
14879
+ }
14880
+ ]
14881
+ }
14882
+ }
14883
+ }
14884
+ }
14885
+ }
14886
+ },
14887
+ "responses": {
14888
+ "201": {
14889
+ "description": "The rest request ended in created response.",
14890
+ "headers": {
14891
+ "location": {
14892
+ "schema": {
14893
+ "type": "string"
14894
+ },
14895
+ "description": "e.g. urn:rights-management:abc123def456"
14896
+ }
14897
+ }
14898
+ },
14899
+ "400": {
14900
+ "description": "The server cannot process the request, see the content for more details.",
14901
+ "content": {
14902
+ "application/json": {
14903
+ "schema": {
14904
+ "$ref": "#/components/schemas/Error"
14905
+ },
14906
+ "examples": {
14907
+ "exampleResponse": {
14908
+ "value": {
14909
+ "name": "GeneralError",
14910
+ "message": "errorMessage",
14911
+ "properties": {
14912
+ "foo": "bar"
14913
+ }
14914
+ }
14915
+ }
14916
+ }
14917
+ }
14918
+ }
14919
+ },
14920
+ "401": {
14921
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
14922
+ "content": {
14923
+ "application/json": {
14924
+ "schema": {
14925
+ "$ref": "#/components/schemas/Error"
14926
+ },
14927
+ "examples": {
14928
+ "exampleResponse": {
14929
+ "value": {
14930
+ "name": "UnauthorizedError",
14931
+ "message": "errorMessage"
14932
+ }
14933
+ }
14934
+ }
14935
+ }
14936
+ }
14937
+ },
14938
+ "500": {
14939
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
14940
+ "content": {
14941
+ "application/json": {
14942
+ "schema": {
14943
+ "$ref": "#/components/schemas/Error"
14944
+ },
14945
+ "examples": {
14946
+ "exampleResponse": {
14947
+ "value": {
14948
+ "name": "InternalServerError",
14949
+ "message": "errorMessage"
14950
+ }
14951
+ }
14952
+ }
14953
+ }
14954
+ }
14955
+ }
14956
+ }
14957
+ },
14958
+ "get": {
14959
+ "operationId": "papQuery",
14960
+ "summary": "Query policies",
14961
+ "tags": [
14962
+ "Policy Administration Point"
14963
+ ],
14964
+ "parameters": [
14965
+ {
14966
+ "name": "assigner",
14967
+ "description": "The assigner to filter by.",
14968
+ "in": "query",
14969
+ "required": false,
14970
+ "schema": {
14971
+ "type": "string"
14972
+ }
14973
+ },
14974
+ {
14975
+ "name": "assignee",
14976
+ "description": "The assignee to filter by.",
14977
+ "in": "query",
14978
+ "required": false,
14979
+ "schema": {
14980
+ "type": "string"
14981
+ }
14982
+ },
14983
+ {
14984
+ "name": "action",
14985
+ "description": "The action to filter by.",
14986
+ "in": "query",
14987
+ "required": false,
14988
+ "schema": {
14989
+ "type": "string"
14990
+ }
14991
+ },
14992
+ {
14993
+ "name": "target",
14994
+ "description": "The target to filter by.",
14995
+ "in": "query",
14996
+ "required": false,
14997
+ "schema": {
14998
+ "type": "string"
14999
+ }
15000
+ },
15001
+ {
15002
+ "name": "conditions",
15003
+ "description": "The condition for the query.",
15004
+ "in": "query",
15005
+ "required": false,
15006
+ "schema": {
15007
+ "type": "string"
15008
+ }
15009
+ },
15010
+ {
15011
+ "name": "limit",
15012
+ "description": "Limit the number of entities to return.",
15013
+ "in": "query",
15014
+ "required": false,
15015
+ "schema": {
15016
+ "type": "string"
15017
+ }
15018
+ },
15019
+ {
15020
+ "name": "cursor",
15021
+ "description": "The cursor to get next chunk of data, returned in previous response.",
15022
+ "in": "query",
15023
+ "required": false,
15024
+ "schema": {
15025
+ "type": "string"
15026
+ },
15027
+ "example": "optional-pagination-cursor"
15028
+ }
15029
+ ],
15030
+ "security": [
15031
+ {
15032
+ "jwtBearerAuthScheme": []
15033
+ }
15034
+ ],
15035
+ "responses": {
15036
+ "200": {
15037
+ "description": "The response structure for querying policies.",
15038
+ "content": {
15039
+ "application/json": {
15040
+ "schema": {
15041
+ "$ref": "#/components/schemas/PapQueryResponse"
15042
+ },
15043
+ "examples": {
15044
+ "papQueryResponseExample": {
15045
+ "value": [
15046
+ {
15047
+ "@context": "http://www.w3.org/ns/odrl.jsonld",
15048
+ "@type": "Set",
15049
+ "uid": "urn:rights-management:abc123def456",
15050
+ "permission": [
15051
+ {
15052
+ "target": "http://example.com/asset/1",
15053
+ "action": "use"
15054
+ }
15055
+ ]
15056
+ }
15057
+ ]
15058
+ }
15059
+ }
15060
+ }
15061
+ }
15062
+ },
15063
+ "400": {
15064
+ "description": "The server cannot process the request, see the content for more details.",
15065
+ "content": {
15066
+ "application/json": {
15067
+ "schema": {
15068
+ "$ref": "#/components/schemas/Error"
15069
+ },
15070
+ "examples": {
15071
+ "exampleResponse": {
15072
+ "value": {
15073
+ "name": "GeneralError",
15074
+ "message": "errorMessage",
15075
+ "properties": {
15076
+ "foo": "bar"
15077
+ }
15078
+ }
15079
+ }
15080
+ }
15081
+ }
15082
+ }
15083
+ },
15084
+ "401": {
15085
+ "description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
15086
+ "content": {
15087
+ "application/json": {
15088
+ "schema": {
15089
+ "$ref": "#/components/schemas/Error"
15090
+ },
15091
+ "examples": {
15092
+ "exampleResponse": {
15093
+ "value": {
15094
+ "name": "UnauthorizedError",
15095
+ "message": "errorMessage"
15096
+ }
15097
+ }
15098
+ }
15099
+ }
15100
+ }
15101
+ },
15102
+ "500": {
15103
+ "description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
15104
+ "content": {
15105
+ "application/json": {
15106
+ "schema": {
15107
+ "$ref": "#/components/schemas/Error"
15108
+ },
15109
+ "examples": {
15110
+ "exampleResponse": {
15111
+ "value": {
15112
+ "name": "InternalServerError",
15113
+ "message": "errorMessage"
15114
+ }
15115
+ }
15116
+ }
15117
+ }
15118
+ }
15119
+ }
15120
+ }
15121
+ }
15122
+ },
15123
+ "/rights-management/policy/admin/{id}": {
15124
+ "put": {
15125
+ "operationId": "papUpdate",
15126
+ "summary": "Update a policy",
15127
+ "tags": [
15128
+ "Policy Administration Point"
15129
+ ],
15130
+ "parameters": [
15131
+ {
15132
+ "name": "id",
15133
+ "description": "The ID of the policy to update.",
15134
+ "in": "path",
15135
+ "required": true,
15136
+ "schema": {
15137
+ "type": "string"
15138
+ },
15139
+ "style": "simple",
15140
+ "example": "urn:rights-management:abc123def456"
15141
+ }
15142
+ ],
15143
+ "security": [
15144
+ {
15145
+ "jwtBearerAuthScheme": []
15146
+ }
15147
+ ],
15148
+ "requestBody": {
15149
+ "description": "The request structure for updating a policy.",
15150
+ "required": true,
15151
+ "content": {
15152
+ "application/json": {
15153
+ "schema": {
15154
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
15155
+ },
15156
+ "examples": {
15157
+ "papUpdateRequestExample": {
15158
+ "value": {
15159
+ "@context": "http://www.w3.org/ns/odrl.jsonld",
15160
+ "@type": "Set",
15161
+ "uid": "urn:rights-management:abc123def456",
14707
15162
  "permission": [
14708
15163
  {
14709
15164
  "target": "http://example.com/asset/2",
@@ -16393,7 +16848,8 @@
16393
16848
  "id": "pid",
16394
16849
  "correlationId": "cid",
16395
16850
  "dateCreated": "2025-09-03T00:00:00.000Z",
16396
- "state": "REQUESTED"
16851
+ "state": "REQUESTED",
16852
+ "organizationIdentity": "did:iota:123456789abcdefghi"
16397
16853
  }
16398
16854
  }
16399
16855
  }
@@ -16497,7 +16953,8 @@
16497
16953
  "id": "pid",
16498
16954
  "correlationId": "cid",
16499
16955
  "dateCreated": "2025-09-03T00:00:00.000Z",
16500
- "state": "REQUESTED"
16956
+ "state": "REQUESTED",
16957
+ "organizationIdentity": "did:iota:123456789abcdefghi"
16501
16958
  }
16502
16959
  }
16503
16960
  }
@@ -16704,7 +17161,8 @@
16704
17161
  "id": "pid",
16705
17162
  "correlationId": "cid",
16706
17163
  "dateCreated": "2025-09-03T00:00:00.000Z",
16707
- "state": "REQUESTED"
17164
+ "state": "REQUESTED",
17165
+ "organizationIdentity": "did:iota:123456789abcdefghi"
16708
17166
  }
16709
17167
  ]
16710
17168
  }
@@ -16830,13 +17288,13 @@
16830
17288
  "type": "string",
16831
17289
  "description": "Task Id."
16832
17290
  },
16833
- "dataSpaceConnectorAppId": {
17291
+ "dataspaceAppId": {
16834
17292
  "type": "string",
16835
- "description": "Data Space Connector App Id."
17293
+ "description": "Dataspace App Id."
16836
17294
  }
16837
17295
  },
16838
17296
  "required": [
16839
- "dataSpaceConnectorAppId",
17297
+ "dataspaceAppId",
16840
17298
  "startDate",
16841
17299
  "taskId"
16842
17300
  ]
@@ -16865,13 +17323,13 @@
16865
17323
  "type": "string",
16866
17324
  "description": "Task Id."
16867
17325
  },
16868
- "dataSpaceConnectorAppId": {
17326
+ "dataspaceAppId": {
16869
17327
  "type": "string",
16870
- "description": "Data Space Connector App Id."
17328
+ "description": "Dataspace App Id."
16871
17329
  }
16872
17330
  },
16873
17331
  "required": [
16874
- "dataSpaceConnectorAppId",
17332
+ "dataspaceAppId",
16875
17333
  "result",
16876
17334
  "startDate",
16877
17335
  "taskId"
@@ -16892,13 +17350,13 @@
16892
17350
  "type": "string",
16893
17351
  "description": "Task Id."
16894
17352
  },
16895
- "dataSpaceConnectorAppId": {
17353
+ "dataspaceAppId": {
16896
17354
  "type": "string",
16897
- "description": "Data Space Connector App Id."
17355
+ "description": "Dataspace App Id."
16898
17356
  }
16899
17357
  },
16900
17358
  "required": [
16901
- "dataSpaceConnectorAppId",
17359
+ "dataspaceAppId",
16902
17360
  "error",
16903
17361
  "taskId"
16904
17362
  ]
@@ -18356,19 +18814,6 @@
18356
18814
  ],
18357
18815
  "description": "The body which contains the error."
18358
18816
  },
18359
- "DataAssetDescription": {
18360
- "type": "object",
18361
- "properties": {
18362
- "dataSetId": {
18363
- "type": "array",
18364
- "items": {
18365
- "type": "string"
18366
- },
18367
- "description": "The concerned datasets."
18368
- }
18369
- },
18370
- "description": "The description of a Data Asset"
18371
- },
18372
18817
  "DataAssetItemList": {
18373
18818
  "type": "object",
18374
18819
  "properties": {
@@ -18400,15 +18845,16 @@
18400
18845
  "DataAssetQueryRequest": {
18401
18846
  "type": "object",
18402
18847
  "properties": {
18403
- "dataAsset": {
18404
- "$ref": "#/components/schemas/DataAssetDescription"
18848
+ "consumerPid": {
18849
+ "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."
18405
18851
  },
18406
18852
  "query": {
18407
18853
  "$ref": "#/components/schemas/FilteringQuery"
18408
18854
  }
18409
18855
  },
18410
18856
  "required": [
18411
- "dataAsset",
18857
+ "consumerPid",
18412
18858
  "query"
18413
18859
  ],
18414
18860
  "description": "Request body containing the data asset and query criteria."
@@ -18656,7 +19102,7 @@
18656
19102
  "type",
18657
19103
  "q"
18658
19104
  ],
18659
- "description": "A query over a data asset that to be processed by a DS Connector App."
19105
+ "description": "A query over a data asset that to be processed by a Dataspace Data Plane App."
18660
19106
  },
18661
19107
  "GetDatasetResponse": {
18662
19108
  "anyOf": [
@@ -19597,6 +20043,10 @@
19597
20043
  "type": "string",
19598
20044
  "description": "The callback address to send updates to the requester."
19599
20045
  },
20046
+ "organizationIdentity": {
20047
+ "type": "string",
20048
+ "description": "Organization identity to be used when sending trust payloads."
20049
+ },
19600
20050
  "offer": {
19601
20051
  "$ref": "https://schema.twindev.org/w3c-odrl/OdrlOffer"
19602
20052
  },
@@ -19648,6 +20098,9 @@
19648
20098
  },
19649
20099
  "description": "A more detailed reason for the negotiation error."
19650
20100
  },
20101
+ "errorDetails": {
20102
+ "$ref": "#/components/schemas/Error"
20103
+ },
19651
20104
  "handlerId": {
19652
20105
  "type": "string",
19653
20106
  "description": "The id of the handler, on provider side this is the negotiator, on consumer side this is the requester."
@@ -19661,7 +20114,8 @@
19661
20114
  "id",
19662
20115
  "correlationId",
19663
20116
  "dateCreated",
19664
- "state"
20117
+ "state",
20118
+ "organizationIdentity"
19665
20119
  ],
19666
20120
  "description": "Interface describing a rights management policy negotiation."
19667
20121
  },
@@ -19898,16 +20352,16 @@
19898
20352
  "type": "string",
19899
20353
  "description": "Task Id."
19900
20354
  },
19901
- "dataSpaceConnectorAppId": {
20355
+ "dataspaceAppId": {
19902
20356
  "type": "string",
19903
- "description": "Data Space Connector App Id."
20357
+ "description": "Dataspace App Id."
19904
20358
  }
19905
20359
  },
19906
20360
  "required": [
19907
20361
  "taskId",
19908
- "dataSpaceConnectorAppId"
20362
+ "dataspaceAppId"
19909
20363
  ],
19910
- "description": "Denotes a task associated with a Data Space Connector App"
20364
+ "description": "Denotes a task associated with a Dataspace App"
19911
20365
  },
19912
20366
  "TelemetryAddMetricValueRequest": {
19913
20367
  "type": "object",