Merge remote-tracking branch 'refs/remotes/origin/master' into featur…

…e/fdo-1.0
DiSSCo · Sep 24, 2024 · 77c3f56 · 77c3f56
2 parents 9fdcc51 + 6b28ddc
commit 77c3f56
Show file tree

Hide file tree

Showing 15 changed files with 83 additions and 78 deletions.
diff --git a/...er-schema/machine-annotation-service/0.3.0/schema/machine-annotation-service-request.json b/...er-schema/machine-annotation-service/0.3.0/schema/machine-annotation-service-request.json
@@ -154,17 +154,18 @@
       "description": "Object containing the tombstone metadata of the object",
       "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/tombstone-metadata.json"
     },
-    "ods:hasEnvironment": {
+    "ods:hasEnvironmentalVariable": {
       "type": "array",
       "description": "Environmental variables to supply to the MAS, non-sensitive",
       "items": {
-        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/machine-annotation-service/0.3.0/machine-annotation-service-environment.json"
+        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/environmental-variable.json"
       }
     },
-    "ods:hasSecret": {
+    "ods:hasSecretVariable": {
       "type": "array",
+      "description": "Secret variables to supply to the MAS",
       "items": {
-        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/machine-annotation-service/0.3.0/machine-annotation-service-secret.json"
+        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/secret-variable.json"
       }
     }
   },

diff --git a/data-model/fdo-type/annotation/0.3.0/examples/active-annotation-example.json b/data-model/fdo-type/annotation/0.3.0/examples/active-annotation-example.json
@@ -13,7 +13,7 @@
     "ods:type": "https://doi.org/21.T11148/bbad8c4e101e8af01115",
     "oa:hasSelector": {
       "@type": "ods:FieldSelector",
-      "ods:field": "$.hasEvent[0].location.dwc:country"
+      "ods:field": "$['ods:hasEvent'][0]['ods:Location']['dwc:country']"
     }
   },
   "oa:hasBody": {

diff --git a/data-model/fdo-type/annotation/0.3.0/examples/active-deleting-annotation-example.json b/data-model/fdo-type/annotation/0.3.0/examples/active-deleting-annotation-example.json
@@ -14,7 +14,7 @@
     "ods:type": "https://doi.org/21.T11148/bbad8c4e101e8af01115",
     "oa:hasSelector": {
       "@type": "ods:ClassSelector",
-      "ods:field": "$.hasEvent[0].location"
+      "ods:field": "$['ods:hasEvent'][0]['ods:Location']"
     }
   },
   "dcterms:creator": {

diff --git a/data-model/fdo-type/annotation/0.3.0/examples/approved-annotation-example.json b/data-model/fdo-type/annotation/0.3.0/examples/approved-annotation-example.json
@@ -13,7 +13,7 @@
     "ods:type": "https://doi.org/21.T11148/bbad8c4e101e8af01115",
     "oa:hasSelector": {
       "@type": "ods:FieldSelector",
-      "ods:field": "$.hasEvent[0].location.dwc:country"
+      "ods:field": "$['ods:hasEvent'][0]['ods:Location']['dwc:country']"
     }
   },
   "oa:hasBody": {

diff --git a/data-model/fdo-type/annotation/0.3.0/examples/rejected-annotation-example.json b/data-model/fdo-type/annotation/0.3.0/examples/rejected-annotation-example.json
@@ -13,7 +13,7 @@
     "ods:type": "https://doi.org/21.T11148/bbad8c4e101e8af01115",
     "oa:hasSelector": {
       "@type": "ods:FieldSelector",
-      "ods:field": "$.hasEvent[0].location.dwc:country"
+      "ods:field": "$['ods:hasEvent'][0]['ods:Location']['dwc:country']"
     }
   },
   "oa:hasBody": {

diff --git a/data-model/fdo-type/annotation/0.3.0/examples/tombstoned-annotation.json b/data-model/fdo-type/annotation/0.3.0/examples/tombstoned-annotation.json
@@ -13,7 +13,7 @@
     "ods:type": "https://doi.org/21.T11148/bbad8c4e101e8af01115",
     "oa:hasSelector": {
       "@type": "ods:FieldSelector",
-      "ods:field": "$.hasEvent[0].location.dwc:country"
+      "ods:field": "$['ods:hasEvent'][0]['ods:Location']['dwc:country']"
     }
   },
   "oa:hasBody": {

diff --git a/data-model/fdo-type/annotation/0.3.0/schema/annotation-target.json b/data-model/fdo-type/annotation/0.3.0/schema/annotation-target.json
@@ -52,9 +52,9 @@
             },
             "ods:field": {
               "type": "string",
-              "description": "The full jsonPath of the field being annotated. Following: https://goessner.net/articles/JsonPath/index.html#e2",
+              "description": "The full jsonPath in block notation of the field being annotated. Following: https://goessner.net/articles/JsonPath/index.html#e2",
               "examples": [
-                "$.hasEvent[0].location.dwc:country"
+                "$['ods:hasEvent'][0]['Location']['dwc:country']"
               ]
             }
           },
@@ -74,9 +74,9 @@
             },
             "ods:class": {
               "type": "string",
-              "description": "The full jsonPath of the class being annotated. Following: https://goessner.net/articles/JsonPath/index.html#e2",
+              "description": "The full jsonPath in block notation of the class being annotated. Following: https://goessner.net/articles/JsonPath/index.html#e2",
               "examples": [
-                "$.hasEvent[0].location.georeference"
+                "$['ods:hasEvent'][0]['Location']['ods:GeoReference']"
               ]
             }
           },

diff --git a/data-model/fdo-type/data-mapping/0.3.0/examples/data-mapping-example.json b/data-model/fdo-type/data-mapping/0.3.0/examples/data-mapping-example.json
@@ -9,28 +9,26 @@
   "schema:description": "The default mapping for the Herbarium of the University of Coimbra (COI) to the Darwin Core standard.",
   "schema:dateCreated": "2021-06-01T12:00:00.122Z",
   "schema:dateModified": "2021-06-01T12:00:00.122Z",
-  "ods:creator": {
+  "schema:creator": {
     "@id": "e2befba6-9324-4bb4-9f41-d7dfae4a44b0",
     "@type": "schema:Person",
     "schema:name": "John Doe"
   },
-  "ods:Mapping": {
-    "ods:DefaultMapping": [
-      {
-        "ods:physicalSpecimenIDType": "Global"
-      },
-      {
-        "ods:type": "ZoologyVertebrateSpecimen"
-      },
-      {
-        "ods:organisationId": "https://ror.org/05xg72x27"
-      }
-    ],
-    "ods:FieldMapping": [
-      {
-        "ods:physicalSpecimenId": "dwc:catalogNumber"
-      }
-    ]
-  },
+  "ods:DefaultMapping": [
+    {
+      "ods:physicalSpecimenIDType'": "Global"
+    },
+    {
+      "ods:type": "ZoologyVertebrateSpecimen"
+    },
+    {
+      "ods:organisationID": "https://ror.org/05xg72x27"
+    }
+  ],
+  "ods:FieldMapping": [
+    {
+      "ods:physicalSpecimenID": "dwc:catalogNumber"
+    }
+  ],
   "ods:mappingDataStandard": "dwc"
 }
diff --git a/data-model/fdo-type/data-mapping/0.3.0/examples/tombstoned-data-mapping-example.json b/data-model/fdo-type/data-mapping/0.3.0/examples/tombstoned-data-mapping-example.json
@@ -9,29 +9,27 @@
   "schema:description": "The default mapping for the Herbarium of the University of Coimbra (COI) to the Darwin Core standard.",
   "schema:dateCreated": "2021-06-01T12:00:00.122Z",
   "schema:dateModified": "2021-06-06T13:22:00.123Z",
-  "ods:creator": {
+  "schema:creator": {
     "@id": "e2befba6-9324-4bb4-9f41-d7dfae4a44b0",
     "@type": "schema:Person",
     "schema:name": "John Doe"
   },
-  "ods:Mapping": {
-    "ods:DefaultMapping": [
-      {
-        "ods:physicalSpecimenIDType": "Global"
-      },
-      {
-        "ods:type": "ZoologyVertebrateSpecimen"
-      },
-      {
-        "ods:organisationId": "https://ror.org/05xg72x27"
-      }
-    ],
-    "ods:FieldMapping": [
-      {
-        "ods:physicalSpecimenId": "dwc:catalogNumber"
-      }
-    ]
-  },
+  "ods:DefaultMapping": [
+    {
+      "ods:physicalSpecimenIDType": "Global"
+    },
+    {
+      "ods:type": "ZoologyVertebrateSpecimen"
+    },
+    {
+      "ods:organisationID": "https://ror.org/05xg72x27"
+    }
+  ],
+  "ods:FieldMapping": [
+    {
+      "ods:physicalSpecimenID": "dwc:catalogNumber"
+    }
+  ],
   "ods:mappingDataStandard": "dwc",
   "ods:TombstoneMetadata": {
     "@type": "ods:Tombstone",

diff --git a/data-model/fdo-type/data-mapping/0.3.0/schema/data-mapping.json b/data-model/fdo-type/data-mapping/0.3.0/schema/data-mapping.json
@@ -94,7 +94,7 @@
             "ods:type": "ZoologyVertebrateSpecimen"
           },
           {
-            "ods:organisationId": "https://ror.org/05xg72x27"
+            "ods:organisationID": "https://ror.org/05xg72x27"
           }
         ]
       ],

diff --git a/data-model/fdo-type/machine-annotation-service/0.3.0/schema/machine-annotation-service.json b/data-model/fdo-type/machine-annotation-service/0.3.0/schema/machine-annotation-service.json
@@ -102,17 +102,17 @@
       "description": "Filters describing the criteria that must be met in order to apply the MAS. No filters implies the MAS may run on *any* digital object. Field names are given in JSON paths, and accepted values for that field are provided as an arrays",
       "example": [
         {
-          "$.ods:type": [
+          "$['ods:type']": [
             "https://doi.org/21.T11148/894b1e6cad57e921764e"
           ],
-          "$.ods:topicDiscipline": [
+          "$['ods:topicDiscipline']": [
             "Astrogeology",
             "Geology",
             "Palaeontology",
             "Other Geodiversity",
             "Unclassified"
           ],
-          "$.hasEvent[*].location.dwc:locality": [
+          "$['ods:hasEvent'][*]['ods:Location']['dwc:locality']": [
             "*"
           ]
         }
@@ -217,17 +217,18 @@
       "description": "Object containing the tombstone metadata of the object",
       "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/tombstone-metadata.json"
     },
-    "ods:hasEnvironment": {
+    "ods:hasEnvironmentalVariable": {
       "type": "array",
       "description": "Environmental variables to supply to the MAS, non-sensitive",
       "items": {
-        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/machine-annotation-service/0.3.0/machine-annotation-service-environment.json"
+        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/environmental-variable.json"
       }
     },
-    "ods:hasSecret": {
+    "ods:hasSecretVariable": {
       "type": "array",
+      "description": "Secret variables to supply to the MAS",
       "items": {
-        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/machine-annotation-service/0.3.0/machine-annotation-service-secret.json"
+        "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/secret-variable.json"
       }
     }
   },

diff --git a/data-model/fdo-type/shared-model/0.3.0/examples/environmental-variable-example.json b/data-model/fdo-type/shared-model/0.3.0/examples/environmental-variable-example.json
@@ -0,0 +1,4 @@
+{
+  "schema:name": "server.port",
+  "schema:value": 8080
+}
diff --git a/data-model/fdo-type/shared-model/0.3.0/examples/secret-variable.json b/data-model/fdo-type/shared-model/0.3.0/examples/secret-variable.json
@@ -0,0 +1,4 @@
+{
+  "schema:name": "database.password",
+  "ods:secretKeyRef": "db-password"
+}
diff --git a/...chine-annotation-service-environment.json → .../0.3.0/schema/environmental-variable.json b/...chine-annotation-service-environment.json → .../0.3.0/schema/environmental-variable.json
@@ -1,25 +1,24 @@
 {
-  "$id": "https://schemas.dissco.tech/schemas/fdo-type/machine-annotation-service/0.3.0/machine-annotation-service-environment.json",
+  "$id": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/environment-variable.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$comment": "Machine Annotation Service Environment Version 0.3.0",
-  "title": "MachineAnnotationServiceEnvironment",
+  "$comment": "Environmental variables Version 0.3.0",
+  "title": "EnvironmentalVariable",
   "type": "object",
-  "description": "Environmental variables to supply to the MAS, non-sensitive",
+  "description": "Environmental variables to supply to the a Digital Object, non-sensitive",
   "properties": {
-    "name": {
+    "schema:name": {
       "type": "string",
       "description": "The name of a non-sensitive property or environmental variable",
       "examples": [
         "server.port",
         "spring.profiles.active"
       ]
     },
-    "value": {
+    "schema:value": {
       "type": [
         "string",
         "integer",
-        "boolean",
-        "null"
+        "boolean"
       ],
       "description": "Value to be stored in the \"name\" field. NOT for sensitive information.",
       "examples": [
@@ -30,7 +29,7 @@
   },
   "additionalProperties": false,
   "required": [
-    "name",
-    "value"
+    "schema:name",
+    "schema:value"
   ]
 }
diff --git a/...ma/machine-annotation-service-secret.json → ...d-model/0.3.0/schema/secret-variable.json b/...ma/machine-annotation-service-secret.json → ...d-model/0.3.0/schema/secret-variable.json
@@ -1,30 +1,30 @@
 {
-  "$id": "https://schemas.dissco.tech/schemas/fdo-type/machine-annotation-service/0.3.0/machine-annotation-service-secret.json",
+  "$id": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/secret-variable.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$comment": "Machine Annotation Service Environment Version 0.3.0",
-  "title": "MachineAnnotationServiceSecret",
+  "$comment": "Secret Variable Version 0.3.0",
+  "title": "SecretVariable",
   "type": "object",
-  "description": "Remote secrets to supply to the MAS",
+  "description": "Secret Variable that need to be supplied to an Digital Object",
   "properties": {
-    "secretName": {
+    "schema:name": {
       "type": "string",
       "description": "The name of an environmental variable stored remotely",
       "examples": [
         "database.password",
         "keycloak.secret"
       ]
     },
-    "secretKeyRef": {
+    "ods:secretKeyRef": {
       "type": "string",
       "description": "The name of the key stored in the secret store. NOT the secret's value.",
-      "example": [
+      "examples": [
         "db-password"
       ]
     }
   },
   "additionalProperties": false,
   "required": [
-    "name",
-    "secretKeyRef"
+    "schema:name",
+    "ods:secretKeyRef"
   ]
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -94,7 +94,7 @@ @@
                 "ods:type": "ZoologyVertebrateSpecimen"
               },
               {
-                "ods:organisationId": "https://ror.org/05xg72x27"
+                "ods:organisationID": "https://ror.org/05xg72x27"
               }
             ]
           ],
@@ Expand Down @@