Merge pull request #70 from DiSSCo/feature/fdo-profiles

Feature/fdo profiles

data-model/Dockerfile

@@ -4,8 +4,15 @@ COPY ./nginx/nginx.conf /etc/nginx/nginx.conf
 
 COPY ./annotations/0.1.0/schema/annotations.json schema-root/schemas/annotations/0.1.0/annotation.json
 
+COPY ./fdo-profiles/0.1.0/annotation/schema/ schema-root/schemas/fdo-profiles/0.1.0/
+COPY ./fdo-profiles/0.1.0/digital-specimen/schema/ schema-root/schemas/fdo-profiles/0.1.0/
 COPY ./fdo-profiles/0.1.0/doi-kernel/schema/ schema-root/schemas/fdo-profiles/0.1.0/
 COPY ./fdo-profiles/0.1.0/handle-kernel/schema/ schema-root/schemas/fdo-profiles/0.1.0/
+COPY ./fdo-profiles/0.1.0/mapping/schema/ schema-root/schemas/fdo-profiles/0.1.0/
+COPY ./fdo-profiles/0.1.0/mas/schema/ schema-root/schemas/fdo-profiles/0.1.0/
+COPY ./fdo-profiles/0.1.0/media-object/schema/ schema-root/schemas/fdo-profiles/0.1.0/
+COPY ./fdo-profiles/0.1.0/organisation/schema/ schema-root/schemas/fdo-profiles/0.1.0/
+COPY ./fdo-profiles/0.1.0/tombstone/schema/ schema-root/schemas/fdo-profiles/0.1.0/
 
 COPY digitalobjects/0.1.0/digital-specimens/schema schema-root/schemas/digitalobjects/0.1.0/digital-specimens
 COPY digitalobjects/0.1.0/shared-models/schema schema-root/schemas/digitalobjects/0.1.0/shared-models

data-model/annotations/0.1.0/schema/annotations.json

@@ -1,6 +1,7 @@
 {
   "$id": "https://schemas.dissco.tech/schemas/annotations/0.1.0/annotations.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment":"Annotation Version 0.1.0",
   "title": "Annotation",
   "description": "Information about the annotation data model. This model has been based on the W3C Web Annotation model",
   "type": "object",

data-model/digitalobjects/0.1.0/digital-media-objects/schema/digital-entity.json

@@ -1,6 +1,7 @@
 {
   "$id": "https://schemas.dissco.tech/schemas/digitalobjects/0.1.0/digital-media-objects/digital-entity.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment":"DigitalObject Version 0.1.0",
   "type": "object",
   "properties": {
     "ods:id": {

data-model/digitalobjects/0.1.0/digital-specimens/schema/chronometric-age.json

@@ -1,6 +1,7 @@
 {
   "$id": "https://schemas.dissco.tech/schemas/digitalobjects/0.1.0/digital-specimens/chronometric-age.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment":"DigitalObject Version 0.1.0",
   "type": "object",
   "properties": {
     "chrono:verbatimChronometricAge": {

data-model/digitalobjects/0.1.0/digital-specimens/schema/digital-specimen.json

@@ -1,6 +1,7 @@
 {
   "$id": "https://schemas.dissco.tech/schemas/digitalobjects/0.1.0/digital-specimens/digital-specimen.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment":"DigitalObject Version 0.1.0",
   "type": "object",
   "properties": {
     "ods:id": {

data-model/digitalobjects/0.1.0/digital-specimens/schema/events.json

@@ -1,6 +1,7 @@
 {
   "$id": "https://schemas.dissco.tech/schemas/digitalobjects/0.1.0/digital-specimens/events.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment":"DigitalObject Version 0.1.0",
   "type": "object",
   "properties": {
     "???:eventName": {

data-model/digitalobjects/0.1.0/digital-specimens/schema/identifications.json

@@ -1,6 +1,7 @@
 {
   "$id": "https://schemas.dissco.tech/schemas/digitalobjects/0.1.0/digital-specimens/identifications.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment":"DigitalObject Version 0.1.0",
   "type": "object",
   "properties": {
     "dwc:identificationID": {

data-model/digitalobjects/0.1.0/digital-specimens/schema/location.json

@@ -1,6 +1,7 @@
 {
   "$id": "https://schemas.dissco.tech/schemas/digitalobjects/0.1.0/digital-specimens/location.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment":"DigitalObject Version 0.1.0",
   "type": "object",
   "properties": {
     "dwc:continent": {

data-model/digitalobjects/0.1.0/digital-specimens/schema/material-entity.json

@@ -1,6 +1,7 @@
 {
   "$id": "https://schemas.dissco.tech/schemas/digitalobjects/0.1.0/digital-specimens/material-entity.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment":"DigitalObject Version 0.1.0",
   "type": "object",
   "$comment": "Only if the part did not get a separate catalogue number, otherwise it will be a separate digital specimen itself",
   "properties": {

data-model/digitalobjects/0.1.0/digital-specimens/schema/occurrences.json

@@ -1,6 +1,7 @@
 {
   "$id": "https://schemas.dissco.tech/schemas/digitalobjects/0.1.0/digital-specimens/occurrences.json",
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment":"DigitalObject Version 0.1.0",
   "type": "object",
   "properties": {
     "dwc:organismQuantity": {

data-model/fdo-profiles/0.1.0/annotation/schema/annotation-request.json

@@ -0,0 +1,45 @@
+{
+  "$id": "https://json-schema.org/draft/2020-12/schemas/fdo-profiles/0.1.0/annotation-request.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Schema for creating new PID records for Annotations using the DiSSCO PID API. API maps requests to annotation.json profile",
+  "$comment":"FDO Profile Version 0.1.0",
+  "allof": [
+    {
+      "$ref": "https://schemas.dissco.tech/schemas/fdo-profiles/0.1.0/handle-request.json"
+    }
+  ],
+  "properties": {
+    "targetPid": {
+      "type": "string",
+      "description": "A Handle or DOI of the object that is being annotated",
+      "example": "https:/hdl.handle.net/20.5000.1025/ABC-123-XYZ",
+      "$comment": "idx = 500"
+    },
+    "targetType": {
+      "type": "string",
+      "description": "Map to ods:type in annotation model",
+      "$comment": "idx = 500"
+    },
+    "motivation": {
+      "enum": [
+        "ods:adding",
+        "oa:assessing",
+        "oa:editing",
+        "oa:commenting"
+      ],
+      "description": "The motivation for the annotation. Based on a selection of https://www.w3.org/TR/annotation-model/#motivation-and-purpose. The motivation ods:adding is added for DiSSCo's purposes.",
+      "$comment": "idx = 502"
+    },
+    "annotationHash": {
+      "type": "string",
+      "description": "MD5 hash based on target, motivation, and creator. Internally generated by DiSSCo Annotation Processing Service for machine annotations",
+      "$comment": "idx = 503"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "targetPid",
+    "targetType",
+    "motivation"
+  ]
+}

data-model/fdo-profiles/0.1.0/annotation/schema/annotation.json

@@ -0,0 +1,45 @@
+{
+  "$id": "https://json-schema.org/draft/2020-12/schemas/fdo-profiles/0.1.0/annotation.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "FDO Profile for DiSSCo Annotations",
+  "$comment":"FDO Profile Version 0.1.0",
+  "allof": [
+    {
+      "$ref": "https://schemas.dissco.tech/schemas/fdo-profiles/0.1.0/handle-kernel.json"
+    }
+  ],
+  "properties": {
+    "targetPid": {
+      "type": "string",
+      "description": "A Handle or DOI of the object that is being annotated",
+      "example": "https:/hdl.handle.net/20.5000.1025/ABC-123-XYZ",
+      "$comment": "idx = 500"
+    },
+    "targetType": {
+      "type": "string",
+      "description": "Map to ods:type in annotation model",
+      "$comment": "idx = 500"
+    },
+    "motivation": {
+      "enum": [
+        "ods:adding",
+        "oa:assessing",
+        "oa:editing",
+        "oa:commenting"
+      ],
+      "description": "The motivation for the annotation. Based on a selection of https://www.w3.org/TR/annotation-model/#motivation-and-purpose. The motivation ods:adding is added for DiSSCo's purposes.",
+      "$comment": "idx = 502"
+    },
+    "annotationHash": {
+      "type": "string",
+      "description": "MD5 hash based on target, motivation, and creator. Internally generated by DiSSCo Annotation Processing Service for machine annotations",
+      "$comment": "idx = 503"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "targetPid",
+    "targetType",
+    "motivation"
+  ]
+}