feat: add consumerId and providerId to ODRL agreement (International-…

…Data-Spaces-Association#102) * feat: add consumerId and providerId to ODRL agreement * chore: update contract-agreement-message.png
jimmarino · May 25, 2023 · 03123f0 · 03123f0
1 parent f950ff5
commit 03123f0
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 2 deletions.
diff --git a/negotiation/contract.negotiation.binding.https.md b/negotiation/contract.negotiation.binding.https.md
@@ -231,7 +231,9 @@ Authorization: ...
   "dspace:processId": "urn:uuid:a343fcbf-99fc-4ce8-8e9b-148c97605aab",
   "dspace:agreement": {
     "@type": "odrl:Agreement",
-    "@id": "e8dc8655-44c2-46ef-b701-4cffdc2faa44"
+    "@id": "e8dc8655-44c2-46ef-b701-4cffdc2faa44",
+    "dspace:consumerId": "...",
+    "dspace:providerId": "...",
     }
   }
 }

diff --git a/negotiation/contract.negotiation.protocol.md b/negotiation/contract.negotiation.protocol.md
@@ -125,6 +125,11 @@ A `ContractAgreementMessage` must contain an ODRL `Agreement`.
 
 An `Agreement` must contain a `dspace:timestamp` property defined as an XSD DateTime type.  
 
+An `Agreement` must contain a `dspace:consumerId` and `dspace:providerId`. The contents of these
+properties are a dataspace-specific unique identifier of the contract agreement parties. Note that these
+identifiers are not necessarily the same as the identifiers of the participant agents negotiating the
+contract (i.e. the "connectors").
+
 ### 4. ContractAgreementVerificationMessage
 
 

diff --git a/negotiation/message/contract-agreement-message.json b/negotiation/message/contract-agreement-message.json
@@ -9,6 +9,8 @@
       "@value": "2023-01-01T01:00:00Z",
       "@type": "xsd:dateTime"
     },
+    "dspace:consumerId": "...",
+    "dspace:providerId": "...",
     "odrl:permission": {
       ...
     }

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,6 +19,8 @@ class odrl:Agreement {
     @id: String
     odrl:target : xsd:anyURI
     dspace:timestamp : xsd:dateTime
+    dspace:consumerId : String
+    dspace:providerId : String
 }
 
 "dspace:ContractAgreementMessage" "1" *-- "1" "odrl:Agreement" : "odrl:agreement"

diff --git a/negotiation/message/example/contract.agreement.message.http.transfer.json b/negotiation/message/example/contract.agreement.message.http.transfer.json
@@ -3,6 +3,8 @@
   "@id": "some-id",
   "@type": ["dspace:ContractAgreementMessage"],
   "dspace:processId": "urn:uuid:a343fcbf-99fc-4ce8-8e9b-148c97605aab",
+  "dspace:consumerId": "...",
+  "dspace:providerId": "...",
   "dspace:agreement": {
     "@type": "odrl:Agreement",
     "@id": "some-other-id",

diff --git a/negotiation/message/schema/contract-agreement-message-schema.json b/negotiation/message/schema/contract-agreement-message-schema.json
@@ -54,10 +54,18 @@
 									"required": true
 								}
 							}
+						},
+						"dspace:consumerId": {
+							"type": "string",
+							"required": true
+						},
+						"dspace:providerId": {
+							"type": "string",
+							"required": true
 						}
 					}
 				}
 			}
 		}
 	}
-}
+}