Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/fdo profiles #70

Merged
merged 12 commits into from
Jan 18, 2024
7 changes: 7 additions & 0 deletions data-model/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions data-model/annotations/0.1.0/schema/annotations.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Original file line number Diff line number Diff line change
@@ -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"
]
}
45 changes: 45 additions & 0 deletions data-model/fdo-profiles/0.1.0/annotation/schema/annotation.json
Original file line number Diff line number Diff line change
@@ -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"
]
}
Loading
Loading