Replace providerId/consumerId with odrl:assigner / odrl:assignee (#213)

* replace providerId/consumerId with odrl:assigner / odrl:assignee * replace providerId/consumerId in contract.negotiation.protocol * fix the ToC in contract.negotiation.binding.https
International-Data-Spaces-Association · Feb 15, 2024 · cf7d3b7 · cf7d3b7
1 parent 2276b45
commit cf7d3b7
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 83 deletions.
diff --git a/common/schema/context.json b/common/schema/context.json
@@ -32,8 +32,6 @@
     "dspace:dataset": { "@type": "@id" },
     "dspace:transportType": { "@type": "@id" },
     "dspace:state": { "@type": "@id" },
-    "dspace:providerId": { "@type": "@id" },
-    "dspace:consumerId": { "@type": "@id" },
     "dspace:reason": { "@container": "@set" },
     "dspace:catalog": { "@container": "@set" },
     "dspace:filter": { "@container": "@set" },
@@ -54,6 +52,8 @@
     "odrl:leftOperand": { "@type": "@id" },
     "odrl:operator": { "@type": "@id" },
     "odrl:rightOperandReference": { "@type": "@id" },
-    "odrl:profile": { "@type": "@id", "@container": "@set" }
+    "odrl:profile": { "@container": "@set" }
+    "odrl:assigner": { "@type": "@id" },
+    "odrl:assignee": { "@type": "@id" }
   }
 }
diff --git a/common/shape/odrl-shapes.ttl b/common/shape/odrl-shapes.ttl
@@ -60,20 +60,20 @@ dspace_shapes:AgreementShape
 	] ;
     sh:property [
 		a sh:PropertyShape ;
-        sh:path dspace:providerId ;
+        sh:path odrl:assigner ;
         sh:nodeKind sh:IRI ;
 		sh:maxCount 1 ;
 		sh:minCount 1 ;
 		sh:severity sh:Violation ;
-		sh:message "<https://raw.githubusercontent.com/International-Data-Spaces-Association/ids-specification/master/schemas/odrl-shape.ttl> (AgreementShape): An dspace:providerId property must point to exactly one Provider Node."@en ;
+		sh:message "<https://raw.githubusercontent.com/International-Data-Spaces-Association/ids-specification/master/schemas/odrl-shape.ttl> (AgreementShape): An odrl:assigner property must point to exactly one Provider Node."@en ;
 	] ;
     sh:property [
 		a sh:PropertyShape ;
-        sh:path dspace:consumerId ;
+        sh:path odrl:assignee ;
         sh:nodeKind sh:IRI ;
 		sh:maxCount 1 ;
 		sh:minCount 1 ;
 		sh:severity sh:Violation ;
-		sh:message "<https://raw.githubusercontent.com/International-Data-Spaces-Association/ids-specification/master/schemas/odrl-shape.ttl> (AgreementShape): An dspace:consumerId property must point to exactly one Consumer Node."@en ;
+		sh:message "<https://raw.githubusercontent.com/International-Data-Spaces-Association/ids-specification/master/schemas/odrl-shape.ttl> (AgreementShape): An odrl:assignee property must point to exactly one Consumer Node."@en ;
 	] ;
 .
diff --git a/negotiation/contract.negotiation.binding.https.md b/negotiation/contract.negotiation.binding.https.md
@@ -2,61 +2,28 @@
 
 This specification defines a RESTful API over HTTPS for the [Contract Negotiation Protocol](./contract.negotiation.protocol.md).
 
-- [Contract Negotiation HTTPS Binding](#contract-negotiation-https-binding)
-  - [1 Introduction](#1-introduction)
-    - [1.1 Prerequisites](#11-prerequisites)
-    - [1.2 Contract Negotiation Error](#12-contract-negotiation-error)
-      - [1.2.1 State Transition Errors](#121-state-transition-errors)
-      - [1.2.2 Object Not Found](#122-object-not-found)
-      - [1.2.3 Unauthorized Access](#123-unauthorized-access)
-    - [1.3 Authorization](#13-authorization)
-  - [2 Provider Path Bindings](#2-provider-path-bindings)
-    - [2.1 The `negotiations` Endpoint _(Provider-side)_](#21-the-negotiations-endpoint-provider-side)
-      - [2.1.1 GET](#211-get)
-        - [Request](#request)
-        - [Response](#response)
-    - [2.2 The `negotiations/request` Endpoint _(Provider-side)_](#22-the-negotiationsrequest-endpoint-provider-side)
-      - [2.2.1 POST](#221-post)
-        - [Request](#request-1)
-        - [Response](#response-1)
-    - [2.3 The `negotiations/:providerPid/request` Endpoint _(Provider-side)_](#23-the-negotiationsproviderpidrequest-endpoint-provider-side)
-      - [2.3.1 POST](#231-post)
-        - [Request](#request-2)
-        - [Response](#response-2)
-    - [2.4 The `negotiations/:providerPid/events` Endpoint _(Provider-side)_](#24-the-negotiationsproviderpidevents-endpoint-provider-side)
-      - [2.4.1 POST](#241-post)
-        - [Request](#request-3)
-        - [Response](#response-3)
-    - [2.5 The `negotiations/:providerPid/agreement/verification` Endpoint  _(Provider-side)_](#25-the-negotiationsproviderpidagreementverification-endpoint--provider-side)
-      - [2.5.1 POST](#251-post)
-        - [Request](#request-4)
-        - [Response](#response-4)
-    - [2.6 The `negotiations/:providerPid/termination` Endpoint _(Provider-side)_](#26-the-negotiationsproviderpidtermination-endpoint-provider-side)
-      - [2.6.1 POST](#261-post)
-        - [Request](#request-5)
-        - [Response](#response-5)
-  - [3 Consumer Callback Path Bindings](#3-consumer-callback-path-bindings)
-    - [3.1 Prerequisites](#31-prerequisites)
-    - [3.2 The `negotiations/offers` Endpoint _(Consumer-side)_](#32-the-negotiationsoffers-endpoint-consumer-side)
-      - [3.2.1 POST](#321-post)
-        - [Request](#request-6)
-        - [Response](#response-6)
-    - [3.3 The `negotiations/:consumerPid/offers` Endpoint _(Consumer-side)_](#33-the-negotiationsconsumerpidoffers-endpoint-consumer-side)
-      - [3.3.1 POST](#331-post)
-        - [Request](#request-7)
-        - [Response](#response-7)
-    - [3.4 The `negotiations/:consumerPid/agreement` Endpoint _(Consumer-side)_](#34-the-negotiationsconsumerpidagreement-endpoint-consumer-side)
-      - [3.4.1 POST](#341-post)
-        - [Request](#request-8)
-        - [Response](#response-8)
-    - [3.5 The `negotiations/:consumerPid/events` Endpoint _(Consumer-side)_](#35-the-negotiationsconsumerpidevents-endpoint-consumer-side)
-      - [3.5.1 POST](#351-post)
-        - [Request](#request-9)
-        - [Response](#response-9)
-    - [3.6 The `negotiations/:consumerPid/termination` Endpoint _(Consumer-side)_](#36-the-negotiationsconsumerpidtermination-endpoint-consumer-side)
-      - [3.6.1 POST](#361-post)
-        - [Request](#request-10)
-        - [Response](#response-10)
+- [1 Introduction](#1-introduction)
+  - [1.1 Prerequisites](#11-prerequisites)
+  - [1.2 Contract Negotiation Error](#12-contract-negotiation-error)
+    - [1.2.1 State Transition Errors](#121-state-transition-errors)
+    - [1.2.2 Object Not Found](#122-object-not-found)
+    - [1.2.3 Unauthorized Access](#123-unauthorized-access)
+  - [1.3 Authorization](#13-authorization)
+- [2 Provider Path Bindings](#2-provider-path-bindings)
+  - [2.1 The `negotiations` Endpoint _(Provider-side)_](#21-the-negotiations-endpoint-provider-side)
+  - [2.2 The `negotiations/request` Endpoint _(Provider-side)_](#22-the-negotiationsrequest-endpoint-provider-side)
+  - [2.3 The `negotiations/:providerPid/request` Endpoint _(Provider-side)_](#23-the-negotiationsproviderpidrequest-endpoint-provider-side)
+  - [2.4 The `negotiations/:providerPid/events` Endpoint _(Provider-side)_](#24-the-negotiationsproviderpidevents-endpoint-provider-side)
+  - [2.5 The `negotiations/:providerPid/agreement/verification` Endpoint  _(Provider-side)_](#25-the-negotiationsproviderpidagreementverification-endpoint--provider-side)
+  - [2.6 The `negotiations/:providerPid/termination` Endpoint _(Provider-side)_](#26-the-negotiationsproviderpidtermination-endpoint-provider-side)
+- [3 Consumer Callback Path Bindings](#3-consumer-callback-path-bindings)
+  - [3.1 Prerequisites](#31-prerequisites)
+  - [3.2 The `negotiations/offers` Endpoint _(Consumer-side)_](#32-the-negotiationsoffers-endpoint-consumer-side)
+  - [3.3 The `negotiations/:consumerPid/offers` Endpoint _(Consumer-side)_](#33-the-negotiationsconsumerpidoffers-endpoint-consumer-side)
+  - [3.4 The `negotiations/:consumerPid/agreement` Endpoint _(Consumer-side)_](#34-the-negotiationsconsumerpidagreement-endpoint-consumer-side)
+  - [3.5 The `negotiations/:consumerPid/events` Endpoint _(Consumer-side)_](#35-the-negotiationsconsumerpidevents-endpoint-consumer-side)
+  - [3.6 The `negotiations/:consumerPid/termination` Endpoint _(Consumer-side)_](#36-the-negotiationsconsumerpidtermination-endpoint-consumer-side)
+
 
 ## 1 Introduction
 
@@ -368,8 +335,8 @@ Authorization: ...
     "@type": "odrl:Offer",
     "@id": "urn:uuid:6bcea82e-c509-443d-ba8c-8eef25984c07",
     "odrl:target": "urn:uuid:3dd1add8-4d2d-569e-d634-8394a8836a88",
-    "dspace:providerId": "urn:tsdshhs636378",
-    "dspace:consumerId": "urn:jashd766",
+    "odrl:assigner": "urn:tsdshhs636378",
+    "odrl:assignee": "urn:jashd766",
     ...
   },
   "dspace:callbackAddress": "https://......"
@@ -403,8 +370,8 @@ Authorization: ...
     "@type": "odrl:Agreement",
     "odrl:target": "urn:uuid:3dd1add4-4d2d-569e-d634-8394a8836d23",
     "dspace:timestamp": "2023-01-01T01:00:00Z",
-    "dspace:providerId": "urn:tsdshhs636378",
-    "dspace:consumerId": "urn:jashd766",
+    "odrl:assigner": "urn:tsdshhs636378",
+    "odrl:assignee": "urn:jashd766",
     ...
   },
   "dspace:callbackAddress": "https://......"

diff --git a/negotiation/contract.negotiation.protocol.md b/negotiation/contract.negotiation.protocol.md
@@ -99,7 +99,7 @@ The Contract Agreement Message is sent by a [Provider](../model/terminology.md#p
 - The message must contain a `consumerPid` and a `providerPid`.
 - The message must contain an [ODRL Agreement](https://www.w3.org/TR/odrl-vocab/#term-Agreement).
 - An [Agreement](../model/terminology.md#agreement) must contain a `timestamp` property defined as an [XSD DateTime](https://www.w3schools.com/XML/schema_dtypes_date.asp) type.
-- An [Agreement](../model/terminology.md#agreement) must contain a `consumerId` and `providerId`. The contents of these properties are a dataspace-specific unique identifier of the [Agreement](../model/terminology.md#agreement) parties. Note that these identifiers are not necessarily the same as the identifiers of the [Participant Agents](../model/terminology.md#participant-agent) negotiating the contract (e.g., [Connectors](../model/terminology.md#connector--data-service-)).
+- An [Agreement](../model/terminology.md#agreement) must contain an `assigner` and `assignee`. The contents of these properties are a dataspace-specific unique identifier of the [Agreement](../model/terminology.md#agreement) parties. Note that these identifiers are not necessarily the same as the identifiers of the [Participant Agents](../model/terminology.md#participant-agent) negotiating the contract (e.g., [Connectors](../model/terminology.md#connector--data-service-)).
 - An [Agreement](../model/terminology.md#agreement) must contain a `odrl:target` property. None of its Rules, however, must have any `odrl:target` attributes to prevent inconsistencies with the [ODRL inferencing rules for compact policies](https://www.w3.org/TR/odrl-model/#composition-compact).
 
 

diff --git a/negotiation/message/diagram/contract-agreement-message.png b/negotiation/message/diagram/contract-agreement-message.png
diff --git a/negotiation/message/diagram/contract-agreement-message.puml b/negotiation/message/diagram/contract-agreement-message.puml
@@ -19,8 +19,8 @@ class odrl:Agreement {
     @id: String
     odrl:target : xsd:anyURI
     dspace:timestamp : xsd:dateTime
-    dspace:consumerId : String
-    dspace:providerId : String
+    odrl:assignee : String
+    odrl:assigner : String
 }
 
 "dspace:ContractAgreementMessage" "1" *-- "1" "odrl:Agreement" : "dspace:agreement"

diff --git a/negotiation/message/example/contract-agreement-message.json b/negotiation/message/example/contract-agreement-message.json
@@ -8,8 +8,8 @@
     "@type": "odrl:Agreement",
     "odrl:target": "urn:uuid:3dd1add4-4d2d-569e-d634-8394a8836d23",
     "dspace:timestamp": "2023-01-01T01:00:00Z",
-    "dspace:providerId": "urn:tsdshhs636378",
-    "dspace:consumerId": "urn:jashd766",
+    "odrl:assigner": "urn:tsdshhs636378",
+    "odrl:assignee": "urn:jashd766",
     "odrl:permission": [{
       "odrl:action": "odrl:use" ,
       "odrl:constraint": [{

diff --git a/negotiation/message/example/contract-offer-message.json b/negotiation/message/example/contract-offer-message.json
@@ -7,8 +7,8 @@
     "@type": "odrl:Offer",
     "@id": "urn:uuid:6bcea82e-c509-443d-ba8c-8eef25984c07",
     "odrl:target": "urn:uuid:3dd1add8-4d2d-569e-d634-8394a8836a88",
-    "dspace:providerId": "urn:tsdshhs636378",
-    "dspace:consumerId": "urn:jashd766",
+    "odrl:assigner": "urn:tsdshhs636378",
+    "odrl:assignee": "urn:jashd766",
     "odrl:permission": [{
       "odrl:action": "odrl:use" ,
       "odrl:constraint": [{

diff --git a/negotiation/message/example/contract-request-message.json b/negotiation/message/example/contract-request-message.json
@@ -5,8 +5,8 @@
   "dspace:consumerPid": "urn:uuid:32541fe6-c580-409e-85a8-8a9a32fbe833",
   "dspace:offer": {
     "odrl:target": "urn:uuid:3dd1add8-4d2d-569e-d634-8394a8836a88",
-    "dspace:providerId": "urn:tsdshhs636378",
-    "dspace:consumerId": "urn:jashd766",
+    "odrl:assigner": "urn:tsdshhs636378",
+    "odrl:assignee": "urn:jashd766",
     "odrl:permission": [{
       "odrl:action": "odrl:use" ,
       "odrl:constraint": [{

diff --git a/negotiation/message/example/contract.agreement.message.http.transfer.json b/negotiation/message/example/contract.agreement.message.http.transfer.json
@@ -3,12 +3,12 @@
   "@type": "dspace:ContractAgreementMessage",
   "dspace:providerPid": "urn:uuid:a343fcbf-99fc-4ce8-8e9b-148c97605aab",
   "dspace:consumerPid": "urn:uuid:32541fe6-c580-409e-85a8-8a9a32fbe833",
-  "dspace:consumerId": "...",
-  "dspace:providerId": "...",
   "dspace:agreement": {
     "@id": "some-other-id",
     "@type": "odrl:Agreement",
     "odrl:target": "urn:uuid:3dd1add8-4d2d-569e-d634-8394a8836a88",
+    "odrl:assignee": "...",
+    "odrl:assigner": "...",
     "odrl:permission": [
       {
         "@id": "some-permission-id",

diff --git a/negotiation/message/schema/contract-schema.json b/negotiation/message/schema/contract-schema.json
@@ -62,10 +62,10 @@
         },
         "AbstractPolicyRule": {
             "properties": {
-                "dspace:providerId": {
+                "odrl:assigner": {
                     "type": "string"
                 },
-                "dspace:consumerId": {
+                "odrl:assignee": {
                     "type": "string"
                 }
             },
@@ -100,7 +100,7 @@
                     ]
                 }
             ],
-            "required": [ "@type", "dspace:providerId" ]
+            "required": [ "@type", "odrl:assigner" ]
         },
         "#/definitions/Offer": {
             "type": "object",
@@ -154,9 +154,8 @@
                 "@type",
                 "@id",
                 "@target",
-                "dspace:providerId",
-                "dspace:consumerId", 
-                "dspace:timestamp"
+                "odrl:assignee", 
+                "odrl:assigner"
             ]
         },
         "RuleClass": {