Editorial rework merge (#2) (#209)

* adding DCAT into JSON schema * catalog schema DCAT fix * fix catalog schema - DCAT * fix catalog schema type error - DCAT * DCAT catalog-shape added for Catalog class * fix typo in DCAT of catalog schema * fix type of dct:modified in DCAT of catalog schema * DCAT dcat:CatalogRecord class added to catalog shape * fix DCAT referecen in Resource catalog * DCAT wrong property of Resource removed * Fix DCAT catalog property of Resource * ResourceShape added to catalog-shape.ttl * RelationshipShape added to catalog-shape.ttl * DCAT fix issue in skos:Concept * DCAT ConceptShape ConceptSchemeShape and AgentShape added * DCAT fix of Dataset property * DCAT DatasetShape added * DCAT DataServiceShape added * DCAT Distribution catalog issue in type * DCAT typo in property * DCAT DataServiceShape added * add references for reused classes & datatypes * clean up on schema * properties changed * refactoring * refactoring * change dct:issued from string to dateTime * fix dct:language from xsd:string to referencing a resource * correcting hasPolicy declarations * reviewing the catalog json schema * refactor catalog json schema * add odrl policy json schema * fix syntax bugs in catalog json schema and adding foaf to the context.json * fix bugs in catalog and contract json schemas * fix examples to match to the catalog and contract json schemas * replace relative reference to the contract-schema.json with an absolute url * fix findings from mkollenstart's review * testing negotiation-subtask-1.1 branch * removing the test change * unwnated characters * Task #1: fix schemas and examples in "negotiation" * correct references to GitHub raw files * making 'required' field compatible to json 2019-09 * changes suggested by Sebastian * changes to processId, correcting ref, removing Sec * chnages since last review * left over change * missing s in dspace * removing RightOperand property * chnage in Permission, Json validated * catalog subtask changes * reverting dspace:filter type to object * re-introducing updates to the json schemas * fix filter in contract-request-message-schema * fixing schema in "Transfer" * Trying Shapes validation with Json-LD * debugging catalog shapes * fixing shapes in Catalog * Negotaitaion Shapes validation * Remove the ContractAgreement shape * add the AgreementShape * Negotiation shapes correction * conflict merge * schema and shapes re-validating after merge * change assigner and assignee to string * introduve verifiable credential structure to agreement msg * adjust agreement msg example to vc pattern * comment error * Catalog shapes changes * Shapes and schema validation for Transfer * Introduce sh:IRI pattern for agreementId * correction for dspace:reason and others * dataset schema and puml * Update catalog-error-schema.json - remove "dspace:code" and "dspace:reason" as mandatory * Update dataset-schema.json - remove "dct:title" and "dct:description" as mandatory * agreement verification change * Transfer Messages - shapes and schema validation * removing "@id" from transfer messages * correction for catalog schema * error handling * pull request #11 changes * pull request changes * new chnages to editorial-rework * merge editorial-rework to shapes-and-schemas * fix last findings --------- Co-authored-by: Thomas Ryborz <[email protected]> Co-authored-by: tr-sap <[email protected]> Co-authored-by: SimantVerma-Bcone <[email protected]> Co-authored-by: simantvermasap <[email protected]>
International-Data-Spaces-Association · Feb 1, 2024 · 11cb69e · 11cb69e
1 parent 815aedc
commit 11cb69e
Show file tree

Hide file tree

Showing 35 changed files with 152 additions and 88 deletions.
diff --git a/catalog/catalog.protocol.md b/catalog/catalog.protocol.md
@@ -182,4 +182,4 @@ When a [Catalog](../model/terminology.md#catalog) contains protected [Datasets](
 
 ### 4.4 Catalog Brokers
 
-A [Dataspace](../model/terminology.md#dataspace) may include Catalog Brokers. A Catalog Broker is a [Consumer](../model/terminology.md#consumer) that has trusted access to 1..N upstream [Catalog Services](../model/terminology.md#catalog-service) and advertises their respective [Catalogs](../model/terminology.md#catalog) as a single [Catalog Service](../model/terminology.md#catalog-service). The broker is expected to honor upstream access control requirements.
+A [Dataspace](../model/terminology.md#dataspace) may include Catalog Brokers. A Catalog Broker is a [Consumer](../model/terminology.md#consumer) that has trusted access to 1..N upstream [Catalog Services](../model/terminology.md#catalog-service) and advertises their respective [Catalogs](../model/terminology.md#catalog) as a single [Catalog Service](../model/terminology.md#catalog-service). The broker is expected to honor upstream access control requirements.
diff --git a/catalog/message/schema/catalog-error-schema.json b/catalog/message/schema/catalog-error-schema.json
@@ -24,23 +24,10 @@
 					"type": "string"
 				},
 				"dspace:reason": {
-					"type": "array",
-					"items": {
-						"type": "object",
-						"properties": {
-							"@value": {
-								"type": "string"
-							},
-							"@language": {
-								"type": "string"
-							}
-						},
-						"required": ["@value", "@language"]
-					},
-					"minItems": 1
+					"type": "array"
 				}
 			},
 			"required": [ "@context", "@type" ]
 		}
 	}
-}
+}
diff --git a/catalog/message/schema/catalog-schema.json b/catalog/message/schema/catalog-schema.json
@@ -45,10 +45,7 @@
                     }
                 }
             ],
-            "required": [
-                "@context",
-                "@type"
-            ],
+            "required": [ "@context", "@type" ],
             "additionalProperties": false
         }
     }

diff --git a/catalog/message/schema/dataset-schema.json b/catalog/message/schema/dataset-schema.json
@@ -149,9 +149,7 @@
                     "type": "string"
                 }
             },
-            "required": [
-                "@id"
-            ]
+            "required": [ "@id" ]
         },
         "Multilanguage": {
             "type": "object",
@@ -163,10 +161,7 @@
                     "type": "string"
                 }
             },
-            "required": [
-                "@value",
-                "@language"
-            ]
+            "required": [ "@value", "@language" ]
         }
     }
 }
diff --git a/catalog/message/shape/catalog-error-shape.ttl b/catalog/message/shape/catalog-error-shape.ttl
@@ -33,6 +33,8 @@ dspace_shapes:CatalogErrorShape
 		sh:datatype xsd:string ;
 	] ;
 	sh:property [
-        sh:path dspace:reason ;
-        sh:datatype rdf:langString ;
-    ] .
+		sh:path dspace:reason ;
+		sh:datatype rdf:langString ;
+	] ;
+
+.
diff --git a/catalog/message/shape/catalog-request-message-shape.ttl b/catalog/message/shape/catalog-request-message-shape.ttl
@@ -33,4 +33,5 @@ dspace_shapes:CatalogRequestMessageShape
 		a sh:PropertyShape ;
 		sh:path dspace:filter ;
 	] ;
+
 .
diff --git a/catalog/message/shape/dataset-shape.ttl b/catalog/message/shape/dataset-shape.ttl
@@ -0,0 +1,78 @@
+@prefix owl: <http://www.w3.org/2002/07/owl#> .
+@prefix rdf:   <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix dct: <http://purl.org/dc/terms/> .
+@prefix dcat: <http://www.w3.org/ns/dcat#> .
+@prefix odrl: <http://www.w3.org/ns/odrl/2/> .
+@prefix cred: <https://www.w3.org/2018/credentials#> .
+@prefix sec: <https://w3id.org/security#> .
+@prefix prov: <http://www.w3.org/ns/prov#> .
+
+@prefix dspace: <https://w3id.org/dspace/v0.8/> .
+@prefix dspace_shapes: <https://w3id.org/dspace/shapes/v0.8/> .
+
+@prefix sh: <http://www.w3.org/ns/shacl#> .
+
+dspace_shapes:
+	a owl:Ontology ;
+	sh:declare [
+		sh:prefix "rdf" ;
+		sh:namespace "http://www.w3.org/1999/02/22-rdf-syntax-ns#"^^xsd:anyURI ;
+	] ;
+	sh:declare [
+		sh:prefix "dspace" ;
+		sh:namespace "https://w3id.org/dspace/v0.8/"^^xsd:anyURI ;
+	] ;
+.
+
+dspace_shapes:DatasetShape
+	a sh:NodeShape ;
+	sh:targetClass dcat:Dataset ;
+
+    sh:property [
+        a sh:PropertyShape ;
+        sh:path dcat:distribution ;
+        sh:class dcat:Distribution ;
+        sh:minCount 0;
+        sh:severity sh:Violation ;
+        sh:message "<https://raw.githubusercontent.com/International-Data-Spaces-Association/ids-specification/master/schemas/dataset-shape.ttl> (DatasetShape): A dcat:distribution property must point to a dcat:Distribution."@en ;
+    ] ; 
+
+    sh:property [
+        a sh:PropertyShape ;
+        sh:path dcat:keyword ;
+        sh:datatype xsd:string ;
+        sh:minCount 0;
+        sh:severity sh:Violation ;
+        sh:message "<https://raw.githubusercontent.com/International-Data-Spaces-Association/ids-specification/master/schemas/dataset-shape.ttl> (DatasetShape): A dcat:keyword property must point to a xsd:string field."@en ;
+    ] ;
+
+    sh:property [
+        a sh:PropertyShape ;
+        sh:path dct:description ;
+        sh:datatype rdf:langString ;
+        sh:minCount 0;
+        sh:severity sh:Violation ;
+        sh:message "<https://raw.githubusercontent.com/International-Data-Spaces-Association/ids-specification/master/schemas/dataset-shape.ttl> (DatasetShape): A dct:description property must point to a rdf:langString field."@en ;
+    ] ;
+
+    sh:property [
+        a sh:PropertyShape ;
+        sh:path dct:title ;
+        sh:datatype xsd:string ;
+        sh:minCount 0;
+        sh:severity sh:Violation ;
+        sh:message "<https://raw.githubusercontent.com/International-Data-Spaces-Association/ids-specification/master/schemas/dataset-shape.ttl> (DatasetShape): A dct:title property must point to a xsd:string field."@en ;
+    ] ; 
+
+    sh:property [
+        a sh:PropertyShape ;
+        sh:path odrl:hasPolicy ;
+        sh:class odrl:Policy ;
+        sh:severity sh:Violation ;
+        sh:minCount 0;
+        sh:message "<https://raw.githubusercontent.com/International-Data-Spaces-Association/ids-specification/master/schemas/dataset-shape.ttl> (DatasetShape): An odrl:hasPolicy property must point to an odrl:Policy."@en ;
+    ] ;
+
+.
diff --git a/common/schema/context.json b/common/schema/context.json
@@ -36,6 +36,7 @@
     "dspace:catalog": { "@container": "@set" },
     "dspace:filter": { "@container": "@set" },
     "dspace:timestamp": { "@type": "xsd:dateTime" },
+    "dspace:callbackAddress": { "@type": "xsd:anyURI" },
 
     "foaf:homepage": { "@type": "xsd:anyURI" },
 

diff --git a/negotiation/message/diagram/contract-agreement-message.puml b/negotiation/message/diagram/contract-agreement-message.puml
@@ -17,8 +17,10 @@ class "dspace:ContractAgreementMessage" {
 class odrl:Agreement {
     @type : "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/schema/contract-schema.json b/negotiation/message/schema/contract-schema.json
@@ -96,10 +96,7 @@
                     ]
                 }
             ],
-            "required": [
-                "@type",
-                "dspace:providerId"
-            ]
+            "required": [ "@type", "dspace:providerId" ]
         },
         "Agreement": {
             "type": "object",
@@ -114,8 +111,8 @@
                             "const": "odrl:Agreement"
                         },
                         "dspace:timestamp": {
-                    "type": "string",
-                    "pattern": "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" 
+                            "type": "string",
+                            "pattern": "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?" 
                         }
                     }
                 },

diff --git a/releases/v0.8/catalog/message/catalog.json b/releases/v0.8/catalog/message/catalog.json
@@ -61,4 +61,4 @@
       }
     }
   ]
-}
+}
diff --git a/releases/v0.8/catalog/message/dataset-request-message.json b/releases/v0.8/catalog/message/dataset-request-message.json
@@ -2,4 +2,4 @@
   "@context":  "https://w3id.org/dspace/v0.8/context.json",
   "@type": "dspace:DatasetRequestMessage",
   "dspace:dataset": "urn:uuid:3dd1add8-4d2d-569e-d634-8394a8836a88"
-}
+}
diff --git a/releases/v0.8/catalog/message/dataset.json b/releases/v0.8/catalog/message/dataset.json
@@ -44,4 +44,4 @@
       ]
     }
   ]
-}
+}
diff --git a/releases/v0.8/negotiation/message/contract-agreement-message.json b/releases/v0.8/negotiation/message/contract-agreement-message.json
@@ -21,4 +21,4 @@
   },
   "dspace:signature": {},
   "dspace:callbackAddress": "https://......"
-}
+}
diff --git a/releases/v0.8/negotiation/message/contract-agreement-verification-message.json b/releases/v0.8/negotiation/message/contract-agreement-verification-message.json
@@ -2,10 +2,5 @@
   "@context":  "https://w3id.org/dspace/v0.8/context.json",
   "@type": "dspace:ContractAgreementVerificationMessage",
   "dspace:providerPid": "urn:uuid:a343fcbf-99fc-4ce8-8e9b-148c97605aab",
-  "dspace:consumerPid": "urn:uuid:32541fe6-c580-409e-85a8-8a9a32fbe833",
-  "dspace:hashedMessage": {
-      "dspace:digest": "some-hash",
-      "dspace:algorithm": "SHA-384"
-  },
-  "dspace:signature": {}
-}
+  "dspace:consumerPid": "urn:uuid:32541fe6-c580-409e-85a8-8a9a32fbe833"
+}
diff --git a/releases/v0.8/negotiation/message/contract-negotiation-event-message.json b/releases/v0.8/negotiation/message/contract-negotiation-event-message.json
@@ -4,4 +4,4 @@
   "dspace:providerPid": "urn:uuid:a343fcbf-99fc-4ce8-8e9b-148c97605aab",
   "dspace:consumerPid": "urn:uuid:32541fe6-c580-409e-85a8-8a9a32fbe833",
   "dspace:eventType": "dspace:ACCEPTED"
-}
+}
diff --git a/releases/v0.8/negotiation/message/contract-negotiation-termination-message.json b/releases/v0.8/negotiation/message/contract-negotiation-termination-message.json
@@ -10,4 +10,4 @@
       "@language": "en"
     }
   ]
-}
+}
diff --git a/releases/v0.8/negotiation/message/contract-negotiation.json b/releases/v0.8/negotiation/message/contract-negotiation.json
@@ -1,7 +1,7 @@
 {
-    "@context":  "https://w3id.org/dspace/v0.8/context.json",
-    "@type": "dspace:ContractNegotiation",
-    "dspace:providerPid": "urn:uuid:a343fcbf-99fc-4ce8-8e9b-148c97605aab",
-    "dspace:consumerPid": "urn:uuid:32541fe6-c580-409e-85a8-8a9a32fbe833",
-    "dspace:state": "dspace:REQUESTED"
-  }
+  "@context":  "https://w3id.org/dspace/v0.8/context.json",
+  "@type": "dspace:ContractNegotiation",
+  "dspace:providerPid": "urn:uuid:a343fcbf-99fc-4ce8-8e9b-148c97605aab",
+  "dspace:consumerPid": "urn:uuid:32541fe6-c580-409e-85a8-8a9a32fbe833",
+  "dspace:state": "dspace:REQUESTED"
+}
diff --git a/releases/v0.8/negotiation/message/contract-offer-message.json b/releases/v0.8/negotiation/message/contract-offer-message.json
@@ -19,4 +19,4 @@
     }]
   },
   "dspace:callbackAddress": "https://......"
-}
+}
diff --git a/releases/v0.8/negotiation/message/contract-request-message_initial.json b/releases/v0.8/negotiation/message/contract-request-message_initial.json
@@ -9,4 +9,4 @@
     "odrl:target": "urn:uuid:3dd1add8-4d2d-569e-d634-8394a8836a88"
   },
   "dspace:callbackAddress": "https://......"
-}
+}
diff --git a/releases/v0.8/transfer/message/transfer-completion-message.json b/releases/v0.8/transfer/message/transfer-completion-message.json
@@ -3,4 +3,4 @@
   "@type": "dspace:TransferCompletionMessage",
   "dspace:providerPid": "urn:uuid:a343fcbf-99fc-4ce8-8e9b-148c97605aab",
   "dspace:consumerPid": "urn:uuid:32541fe6-c580-409e-85a8-8a9a32fbe833"
-}
+}
diff --git a/releases/v0.8/transfer/message/transfer-error.json b/releases/v0.8/transfer/message/transfer-error.json
@@ -8,4 +8,4 @@
     {},
     {}
   ]
-}
+}
diff --git a/releases/v0.8/transfer/message/transfer-start-message.json b/releases/v0.8/transfer/message/transfer-start-message.json
@@ -3,5 +3,16 @@
   "@type": "dspace:TransferStartMessage",
   "dspace:providerPid": "urn:uuid:a343fcbf-99fc-4ce8-8e9b-148c97605aab",
   "dspace:consumerPid": "urn:uuid:32541fe6-c580-409e-85a8-8a9a32fbe833",
-  "dspace:dataAddress": "https://......"
+  "dspace:dataAddress": {
+    "@type": "dspace:DataAddress",
+    "dspace:endpointType": "https://w3id.org/idsa/v4.1/HTTP",
+    "dspace:endpoint": "http://example.com",
+    "dspace:endpointProperties": [
+      {
+        "@type": "dspace:EndpointProperty",
+        "dspace:name": "Authorization",
+        "dspace:value": "Bearer TOKEN-ABCDEFG"
+      }
+    ]
+  }
 }
diff --git a/releases/v0.8/transfer/message/transfer-suspension-message.json b/releases/v0.8/transfer/message/transfer-suspension-message.json
@@ -8,4 +8,4 @@
     {},
     {}
   ]
-}
+}
diff --git a/releases/v0.8/transfer/message/transfer-termination-message.json b/releases/v0.8/transfer/message/transfer-termination-message.json
@@ -8,4 +8,4 @@
     {},
     {}
   ]
-}
+}
diff --git a/transfer/message/schema/transfer-error-schema.json b/transfer/message/schema/transfer-error-schema.json
@@ -31,10 +31,7 @@
 				},
 				"dspace:reason": {
 					"type": "array",
-					"minItems": 1,
-					"items": {
-
-					}
+					"items": {}
 				}
 			},
 			"required": [ "@context", "@type", "dspace:providerPid", "dspace:consumerPid"]

diff --git a/transfer/message/schema/transfer-process-schema.json b/transfer/message/schema/transfer-process-schema.json
@@ -37,7 +37,7 @@
 					]
 				}
 			},
-			"required": [ "@context", "@type", "dspace:providerPid", "dspace:consumerPid", "dspace:consumerPid", "dspace:state" ]
+			"required": [ "@context", "@type", "dspace:providerPid", "dspace:consumerPid", "dspace:state" ]
 		}
 	}
 }
diff --git a/transfer/message/schema/transfer-suspension-message-schema.json b/transfer/message/schema/transfer-suspension-message-schema.json
@@ -32,9 +32,7 @@
 				"dspace:reason": {
 					"type": "array",
 					"minItems": 1,
-					"items": {
-
-					}
+					"items": {}
 				}
 			},
 			"required": [ "@context", "@type", "dspace:providerPid", "dspace:consumerPid" ]

diff --git a/transfer/message/shape/transfer-completion-message-shape.ttl b/transfer/message/shape/transfer-completion-message-shape.ttl
@@ -13,7 +13,7 @@
 
 @prefix sh: <http://www.w3.org/ns/shacl#> .
 
-shapes:
+dspace_shapes:
 	a owl:Ontology ;
 	sh:declare [
 		sh:prefix "rdf" ;
@@ -25,9 +25,10 @@ shapes:
 	] ;
 .
 
-shapes:TransferCompletionMessageShape
+dspace_shapes:TransferCompletionMessageShape
 	a sh:NodeShape ;
 	sh:targetClass dspace:TransferCompletionMessage ;
+	rdfs:subClassOf dspace_shapes:MessageShape ;
 
 	sh:property [
 		a sh:PropertyShape ;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -182,4 +182,4 @@ When a [Catalog](../model/terminology.md#catalog) contains protected [Datasets](

		### 4.4 Catalog Brokers

		A [Dataspace](../model/terminology.md#dataspace) may include Catalog Brokers. A Catalog Broker is a [Consumer](../model/terminology.md#consumer) that has trusted access to 1..N upstream [Catalog Services](../model/terminology.md#catalog-service) and advertises their respective [Catalogs](../model/terminology.md#catalog) as a single [Catalog Service](../model/terminology.md#catalog-service). The broker is expected to honor upstream access control requirements.
		A [Dataspace](../model/terminology.md#dataspace) may include Catalog Brokers. A Catalog Broker is a [Consumer](../model/terminology.md#consumer) that has trusted access to 1..N upstream [Catalog Services](../model/terminology.md#catalog-service) and advertises their respective [Catalogs](../model/terminology.md#catalog) as a single [Catalog Service](../model/terminology.md#catalog-service). The broker is expected to honor upstream access control requirements.
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,4 +33,5 @@ dspace_shapes:CatalogRequestMessageShape @@
     		a sh:PropertyShape ;
     		sh:path dspace:filter ;
     	] ;
     .