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.

Sign up for GitHub

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

1.0 fdo profile #138

Merged
merged 11 commits into from
Oct 7, 2024
Merged

1.0 fdo profile #138

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
be8cc02
1.0 fdo profile
southeo Sep 3, 2024
099024a
1.0 fdo profile
southeo Sep 3, 2024
5f1514d
Merge remote-tracking branch 'refs/remotes/origin/master' into featur…
southeo Sep 16, 2024
b60cd19
add digital specimen/media 1.0.0
southeo Sep 16, 2024
9fdcc51
add digital specimen/media 1.0.0
southeo Sep 17, 2024
77c3f56
Merge remote-tracking branch 'refs/remotes/origin/master' into featur…
southeo Sep 24, 2024
e79c27d
Merge remote-tracking branch 'refs/remotes/origin/master' into featur…
southeo Sep 24, 2024
6a04332
code review
southeo Sep 25, 2024
e14d88f
code review
southeo Sep 25, 2024
197f7f9
code review
southeo Oct 2, 2024
96103fa
update topic category
southeo Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion data-model/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ COPY fdo-profile/doi-kernel/1.0.0/schema schema-root/schemas/fdo-profile/doi-ker
COPY fdo-profile/source-system/1.0.0/schema schema-root/schemas/fdo-profile/source-system/1.0.0
COPY fdo-profile/digital-media/1.0.0/schema schema-root/schemas/fdo-profile/digital-media/1.0.0
COPY fdo-profile/digital-specimen/1.0.0/schema/ schema-root/schemas/fdo-profile/digital-specimen/1.0.0
COPY fdo-profile/tombstone/1.0.0/schema schema-root/schemas/fdo-profile/tombstone/1.0.0

# Latest FDO Profile schemas
COPY fdo-profile/annotation/1.0.0/schema schema-root/schemas/fdo-profile/annotation/latest
Expand All @@ -34,10 +35,10 @@ COPY fdo-profile/machine-annotation-service/1.0.0/schema schema-root/schemas/fdo
COPY fdo-profile/source-system/1.0.0/schema schema-root/schemas/fdo-profile/source-system/latest
COPY fdo-profile/digital-media/1.0.0/schema schema-root/schemas/fdo-profile/digital-media/latest
COPY fdo-profile/digital-specimen/1.0.0/schema schema-root/schemas/fdo-profile/digital-specimen/latest
COPY fdo-profile/tombstone/1.0.0/schema schema-root/schemas/fdo-profile/tombstone/latest

COPY fdo-profile/tettris-service/0.1.0/schema schema-root/schemas/fdo-profile/tettris-service/latest
COPY fdo-profile/organisation/0.1.0/schema schema-root/schemas/fdo-profile/organisation/latest
COPY fdo-profile/tombstone/0.1.0/schema schema-root/schemas/fdo-profile/tombstone/latest
COPY fdo-profile/virtual-collection/0.1.0/schema schema-root/schemas/fdo-profile/virtual-collection/latest

# Versioned FDO Type schemas
Expand Down
1 change: 1 addition & 0 deletions data-model/fdo-profile/annotation/1.0.0/examples/example-annotation-request.json
View file
Open in desktop
wouteraddink marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
],
"targetPid": "https://hdl.handle.net/20.5000.10235/aaa-bbb-ccc",
"targetType": "https://doi.org/21.T11148/894b1e6cad57e921764e",
"targetTypeName": "DigitalSpecimen",
"annotationHash": "b3dada2d-396b-cab2-665e-125659fc7ae6"
}
}
Expand Down
4 changes: 2 additions & 2 deletions data-model/fdo-profile/annotation/1.0.0/examples/example-annotation.json
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add VIEW=JSON to 10320/loc for consistency (although we do not currently have a HTML view for the annotation)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is now implemented as ID=JSON but the ID should not change, a VIEW parameter should be added. ID attributes are given an integer in the Handle documentation, I am not sure that is actually required but people using Handles may expect an integer there so I would keep the ID integers. They may be handy if there are for example multiple URLS with VIEW=JSON, to display one of them with preference using a weight (e.g. one is served in Chine, the other in Europe and for traffic coming from Europe you may prefer the one served from a location in Europe).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% sure if the handle system supports that. In their documentation, they say:

The currently defined selection methods are:

  • Locatt (select by id)
  • country
  • weight

However, they also say:

The attributes for the set of locations, as well as each location entry in the set, are open-ended to allow for future capabilities.

So it might support it, it might not. Will need to test. If it fails, using the id this way should work. There's nothing in the documentation that says that the id needs to be an integer.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, how I read the documentation you should be able to add any attribute you like. If it does not work then please use the id instead but having both attributes would be more flexible.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pidissuerName should be DiSSCo (DataCite does not issue Handles for our annotations), pidIssuer is the ROR for DiSSCo

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now pidIssuerName is changed to the ROR, but the ROR should be in pidIssuer and pidIssuerName should be DiSSCo

Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"0\" weight=\"1\"/></locations>",
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"JSON\" weight=\"1\"/></locations>",
"fdoProfile": "https://doi.org/21.T11148/cf458ca9ee1d44a5608f",
"fdoRecordLicenseId": "https://spdx.org/licenses/CC0-1.0.json",
"fdoRecordLicenseName": "CC0 1.0 Universal",
"digitalObjectType": "https://doi.org/21.T11148/cf458ca9ee1d44a5608f",
"digitalObjectName": "Annotation",
"pid": "https://hdl.handle.net/TEST/FFR-RTL-B8K",
"pidIssuer": "https://ror.org/04wxnsj81",
"pidIssuerName": "DataCite",
"pidIssuerName": "https://ror.org/02wddde16",
"pidRecordIssueDate": "2023-11-17T11:57:02.933Z",
"pidRecordIssueNumber": 1,
"pidStatus": "ACTIVE",
Expand Down
4 changes: 4 additions & 0 deletions data-model/fdo-profile/annotation/1.0.0/schema/annotation-request-attributes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@
"type": "string",
"description": "Map to ods:type in annotation model"
},
"targetTypeName": {
"type": "string",
"description": "Human-readable name of the above target type."
},
"annotationHash": {
"type": "string",
"format": "uuid",
Expand Down
5 changes: 5 additions & 0 deletions data-model/fdo-profile/annotation/1.0.0/schema/annotation.json
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update idx6 example with 10.3535 prefix, add VIEW=JSON to10320/loc

Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@
"description": "Map to ods:type in annotation model",
"$comment": "idx = 501"
},
"targetTypeName": {
"type": "string",
"description": "Human-readable name of the above target type",
"$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",
Expand Down
2 changes: 1 addition & 1 deletion data-model/fdo-profile/data-mapping/0.1.0/schema/data-mapping.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
"type": "string",
"description": "XML document describing location(s) of the resource",
"$comment": "idx = 101",
"example": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"0\" weight=\"1\"/></locations>"
"example": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"JSON\" weight=\"1\"/></locations>"
},
"tombstoneText": {
"type": "string",
Expand Down
2 changes: 1 addition & 1 deletion data-model/fdo-profile/data-mapping/1.0.0/examples/example-data-mapping.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"10320/loc": "<locations><location href=\"https://dev-orchestration.dissco.tech/api/v1/mapping/TEST/QDD-Y07-QK6\" id=\"0\" weight=\"1\"/></locations>",
"10320/loc": "<locations><location href=\"https://dev-orchestration.dissco.tech/api/v1/mapping/TEST/QDD-Y07-QK6\" id=\"JSON\" weight=\"1\"/></locations>",
"fdoProfile": "https://doi.org/21.T11148/ce794a6f4df42eb7e77e",
"fdoRecordLicense": "https://spdx.org/licenses/CC0-1.0.json",
"fdoRecordLicenseName": "CC0 1.0 Universal",
Expand Down
4 changes: 2 additions & 2 deletions data-model/fdo-profile/digital-media/1.0.0/examples/example-digital-media-request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"linkedDigitalObjectPid": "https://doi.org/10.22/GR0-WWV-3RT",
"linkedDigitalObjectType": "https://doi.org/21.T11148/d8de0819e144e4096645",
"primaryMediaId": "https://mediaphoto.mnhn.fr/media/1620403020391dDLZHWzqVzfk5Az3",
"dcterms:license": "https://spdx.org/licenses/CC0-1.0.json",
"dcterms:rightsHolder": "https://ror.org/0566bfb96"
"licenseName": "https://spdx.org/licenses/CC0-1.0.json",
"rightsHolder": "https://ror.org/0566bfb96"
}
}
}
6 changes: 3 additions & 3 deletions data-model/fdo-profile/digital-media/1.0.0/examples/example-digital-media.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"0\" weight=\"1\"/></locations>",
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"JSON\" weight=\"1\"/></locations>",
"fdoProfile": "https://doi.org/21.T11148/bbad8c4e101e8af01115",
"fdoRecordLicenseId": "https://spdx.org/licenses/CC0-1.0.json",
"fdoRecordLicenseName": "CC0 1.0 Universal",
Expand All @@ -19,6 +19,6 @@
"linkedDigitalObjectPid": "https://doi.org/10.22/GR0-WWV-3RT",
"linkedDigitalObjectType": "https://doi.org/21.T11148/d8de0819e144e4096645",
"primaryMediaId": "https://mediaphoto.mnhn.fr/media/1620403020391dDLZHWzqVzfk5Az3",
"dcterms:license": "https://spdx.org/licenses/CC0-1.0.json",
"dcterms:rightsHolder": "https://ror.org/0566bfb96"
"licenseName": "https://spdx.org/licenses/CC0-1.0.json",
"rightsHolder": "https://ror.org/0566bfb96"
}
19 changes: 12 additions & 7 deletions data-model/fdo-profile/digital-media/1.0.0/schema/digital-media-request-attributes.json
View file
Open in desktop
wouteraddink marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,28 @@
"type": "string",
"example": "DAM nr"
},
"dcterms:type": {
"mediaType": {
"type": "string",
"description": "Type, describing the (primary) nature of the image. For example an image of a label will have primaryDcType text, an image of a specimen will have primaryDcType physical object. One of: text, image, sound, dataset, software, interactive, event, physical object + Audiovisual Core: 3D object type"
},
"dcterms:format": {
"mimeType": {
"type": "string",
"description": "(Previously primaryMediaObjectType) Dublin Core: Type, describing the (primary) nature of the image. For example an image of a label will have primaryDcType text, an image of a specimen will have primaryDcType physical object. One of: text, image, sound, dataset, software, interactive, event, physical object + Audiovisual Core: 3D object type"
"description": "Only mimetypes for audio, image, model, video, text should be provided. https://www.iana.org/assignments/media-types/media-types.xhtml"
},
"dcterms:license": {
"licenseName": {
"type": "string",
"description": "http://purl.org/dc/terms/license.",
"example": "CC0 1.0 Universal (CC0 1.0) Public Domain Dedication"
},
"dcterms:rightsHolder": {
"rightsHolder": {
"type": "string",
"description": "If not present, defaults to mediaHost, https://purl.org/dc/terms/rightsHolder",
"example": "https://ror.org/0566bfb96"
},
"rightsHolderPid": {
"type": "string",
"description": "Resolvable identifier of the rights holder",
"example": "https://ror.org/0566bfb96"
}
},
"required": [
Expand All @@ -79,8 +84,8 @@
"linkedDigitalObjectPid",
"linkedDigitalObjectType",
"primaryMediaId",
"dcterms:license",
"dcterms:rightsHolder"
"licenseName",
"rightsHolder"
],
"additionalProperties": false
}
47 changes: 35 additions & 12 deletions data-model/fdo-profile/digital-media/1.0.0/schema/digital-media.json
View file
Open in desktop
wouteraddink marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@
},
"mediaHost": {
"type": "string",
"description": "ROR or, in absence of a ROR, Wikidata Qnumber for the administrative organisation responsible for hosting the digital media object. Note that this can be DiSSCo also (use DiSSCo QID in that case). Notehe organisation may use an external repository like morphobank to host the object.",
"description": "ROR or, in absence of a ROR, Wikidata Qnumber for the administrative organisation responsible for hosting the digital media object. Note that this can be DiSSCo also (use DiSSCo QID in that case). The organisation may use an external repository like morphobank to host the object.",
"example": "https://ror.org/0566bfb96",
"$comment": "idx = 400"
},
Expand Down Expand Up @@ -184,32 +184,55 @@
"$comment": "idx = 405"
},
"primaryMediaIdName": {
"type": "string",
"example": "ac:accessUr",
"$comment": "idx = 406"
},
"dcterms:type": {
"mediaType": {
"type": "string",
"description": "http://purl.org/dc/elements/1.1/type",
"description": "Describes the primary nature of the digital media",
"enum": [
"Collection",
"Dataset",
"Event",
"Image",
"InteractiveResource",
"MovingImage",
"PhysicalObject",
"Service",
"Software",
"Sound",
"Text"
],
"$comment": "idx = 407"
},
"dcterms:format": {
"mimeType": {
"type": "string",
"description": "http://purl.org/dc/terms/format",
"description": "Only mimetypes for audio, image, model, video, text should be provided. https://www.iana.org/assignments/media-types/media-types.xhtml",
"example": "image/jpeg",
"$comment": "idx = 408"
},
"dcterms:license": {
"licenseName": {
"type": "string",
"description": "http://purl.org/dc/terms/license.",
"example": "CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
"$comment": "idx = 409"
},
"dcterms:rightsHolder": {
"licenseUrl": {
"type": "string",
"description": "https://purl.org/dc/terms/rightsHolder",
"example": "https://ror.org/0566bfb96",
"description": "Machine-actionable licensing information. Uses SPDX Identifiers.",
"example": "CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
"$comment": "idx = 410"
},
"rightsHolder": {
"type": "string",
"description": "Usually the creator of the object, holds the copyright for the object. Defaults to the supplier of the media object. if no other rights holder is specified",
"example": "https://ror.org/0566bfb96",
"$comment": "idx = 411"
},
"rightsHolderPid": {
"type": "string",
"description": "Identifier of the rights holder",
"$comment": "idx = 412"
}
},
"additionalProperties": false,
Expand All @@ -233,7 +256,7 @@
"linkedDigitalObjectPid",
"linkedDigitalObjectType",
"primaryMediaId",
"dcterms:license",
"dcterms:rightsHolder"
"licenseName",
"rightsHolder"
]
}
2 changes: 1 addition & 1 deletion data-model/fdo-profile/digital-specimen/1.0.0/examples/example-digital-specimen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"0\" weight=\"1\"/></locations>",
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"JSON\" weight=\"1\"/></locations>",
"fdoProfile": "https://doi.org/21.T11148/d8de0819e144e4096645",
"fdoRecordLicenseId": "https://spdx.org/licenses/CC0-1.0.json",
"fdoRecordLicenseName": "CC0 1.0 Universal",
Expand Down
2 changes: 1 addition & 1 deletion ...-model/fdo-profile/digital-specimen/1.0.0/schema/digital-specimen-request-attributes.json
View file
Open in desktop
wouteraddink marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
"Protozoa",
"Eukaryotic microorganisms",
"Viruses",
"Mircofungi",
"Microfungi",
"Other Microbiology Objects",
"Botany Fossils",
"Invertebrate Fossils",
Expand Down
2 changes: 1 addition & 1 deletion data-model/fdo-profile/digital-specimen/1.0.0/schema/digital-specimen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@
"Protozoa",
"Eukaryotic microorganisms",
"Viruses",
"Mircofungi",
"Microfungi",
"Other Microbiology Objects",
"Botany Fossils",
"Invertebrate Fossils",
Expand Down
2 changes: 1 addition & 1 deletion data-model/fdo-profile/doi-kernel/1.0.0/examples/example-doi-kernel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"0\" weight=\"1\"/></locations>",
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"JSON\" weight=\"1\"/></locations>",
"fdoProfile": "https://doi.org/21.T11148/527856fd709ec8c5bc8c",
"fdoRecordLicense": "https://spdx.org/licenses/CC0-1.0.json",
"fdoRecordLicenseName": "CC0 1.0 Universal",
Expand Down
2 changes: 1 addition & 1 deletion data-model/fdo-profile/handle-kernel/1.0.0/examples/example-handle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"0\" weight=\"1\"/></locations>",
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"JSON\" weight=\"1\"/></locations>",
"fdoProfile": "https://doi.org/21.T11148/532ce6796e2828dd2be6",
"fdoRecordLicenseId": "https://spdx.org/licenses/CC0-1.0.json",
"fdoRecordLicenseName": "CC0 1.0 Universal",
Expand Down
2 changes: 1 addition & 1 deletion ...profile/machine-annotation-service/1.0.0/examples/example-machine-annotation-service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"0\" weight=\"1\"/></locations>",
"10320/loc": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"JSON\" weight=\"1\"/></locations>",
"fdoProfile": "https://doi.org/21.T11148/22e71a0015cbcfba8ffa",
"fdoRecordLicenseId": "https://spdx.org/licenses/CC0-1.0.json",
"fdoRecordLicenseName": "CC0 1.0 Universal",
Expand Down
2 changes: 1 addition & 1 deletion data-model/fdo-profile/source-system/1.0.0/schema/source-system-fdo-profile.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
"type": "string",
"description": "XML document describing location(s) of the resource",
"$comment": "idx = 101",
"example": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"0\" weight=\"1\"/></locations>"
"example": "<locations><location href=\"https://dev.dissco.tech/api/v1/annotations/TEST/FFR-RTL-B8K\" id=\"JSON\" weight=\"1\"/></locations>"
},
"tombstoneText": {
"type": "string",
Expand Down
Loading