Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
128 changes: 128 additions & 0 deletions data-model/fdo-type/controlled-value/controlled-value.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://schemas.dissco.tech/schemas/fdo-type/controlled-value/0.1.0/controlled-value.json",
"title": "DiSSCo Controlled Value",
"description": "A schema for defining individual controlled values used in openDS Terms.",
"type": "object",
"properties": {
"@id": {
"type": "string",
"description": "The unique identifier (handle) of the controlled value",
"pattern": "^https://hdl\\.handle\\.net/20\\.500\\.1025/[a-zA-Z0-9/_-]+$",
"examples": [
"https://hdl.handle.net/20.500.1025/topicDiscipline/Botany",
"https://hdl.handle.net/20.500.1025/status/Active"
]
},
"@type": {
"type": "string",
"const": "ods:ControlledValue",
"description": "The type of the digital object"
},
"ods:fdoType": {
"type": "string",
"description": "The Handle to the FDO type of the object",
"pattern": "^https://hdl\\.handle\\.net/[0-9]+\\.[0-9A-Z]+/[a-f0-9]+$",
"examples": [
"https://hdl.handle.net/21.T11148/bbad8c4e101e8af01115",
"https://hdl.handle.net/21.T11148/894b1e6cad57e921764e"
]
},
"ods:status": {
"type": "string",
"enum": [
"ods:Draft",
"ods:Active",
"ods:Tombstone"
],
"description": "The status of the Digital Object",
"examples": [
"ods:Active"
]
},
"ods:version": {
"type": "integer",
"description": "The version of the object, each change generates a new version. The version starts at 1 and each change will increment the version number with 1",
"minimum": 1,
"examples": [
1
]
},
"ods:hasAgents": {
"type": "array",
"description": "Contains all agents that are connected to this digital object.",
"items": {
"type": "object",
"$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.4.0/agent.json"
}
},
"dcterms:title": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you add more examples for the below fields

"type": "string",
"description": "The title of the controlled value",
"examples": [
"Botany",
"Geology",
"Preserved"
]
},
"skos:prefLabel": {
"type": "string",
"description": "Preferred label for the value",
"examples": [
"Botany"
]
},
"skos:definition": {
"type": "string",
"description": "A concise definition of the controlled value",
"examples": [
"The scientific study of plants."
]
},
"skos:inScheme": {
"type": "string",
"format": "uri",
"description": "The PID of the Term (e.g. ods:topicDiscipline) this value belongs to",
"examples": [
"https://hdl.handle.net/20.500.1025/topicDiscipline"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Check the assumption that it is only ever connected to one term

]
},
"skos:broader": {
"type": "string",
"format": "uri",
"description": "The broader controlled value in the hierarchy",
"pattern": "^https://hdl\\.handle\\.net/20\\.500\\.1025/([^/]+)/([^/]+)$"
},
"owl:deprecated": {
"type": "boolean",
"description": "Indicates whether the value is deprecated",
"examples": [
"false"
]
},
"dcterms:created": {
"type": "string",
"format": "date-time",
"description": "Timestamp of creation"
},
"dcterms:modified": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Missing example

"type": "string",
"format": "date-time",
"description": "Timestamp of last modification"
}
},
"required": [
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Missing ods:status, ods:fdoType. I think modified should be optional

"@id",
"@type",
"ods:status",
"ods:fdoType",
"dcterms:title",
"skos:prefLabel",
"skos:definition",
"skos:inScheme",
"owl:deprecated",
"ods:version",
"ods:hasAgents",
"dcterms:created"
]
}
29 changes: 29 additions & 0 deletions data-model/fdo-type/controlled-value/examples/botany.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"@id": "https://hdl.handle.net/20.500.1025/topicDiscipline/Botany",
"@type": "ods:ControlledValue",
"ods:fdoType": "https://hdl.handle.net/21.T11148/bbad8c4e101e8af01115",
"ods:status": "ods:Active",
"ods:version": 1,
"ods:hasAgents": [
{
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

roleName incorrectly added. Should be a separate object

"@type": "schema:Person",
"schema:identifier": "https://orcid.org/0000-0001-1234-5678",
"schema:name": "FirstName LastName",
"ods:hasRoles": [
{
"@type": "schema:Role",
"schema:roleName": "creator",
"schema:startDate": "2024-01-15T10:30:00Z",
"schema:position": 1
}
]
}
],
"dcterms:title": "Botany",
"skos:prefLabel": "Botany",
"skos:definition": "The scientific study of plants.",
"skos:inScheme": "https://hdl.handle.net/20.500.1025/topicDiscipline",
"owl:deprecated": false,
"dcterms:created": "2024-01-15T10:30:00Z",
"dcterms:modified": "2024-10-15T14:22:00Z"
}
Loading