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

updated virtualcollections schema, align with LatimerCore #81

Merged
merged 9 commits into from
Mar 15, 2024
116 changes: 115 additions & 1 deletion data-model/virtualcollections/v.0.1.0/schemas/virtualcollections.json
samleeflang marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1 +1,115 @@

{
"$schema": "http://json-schema.org/draft-2020-12/schema#",
"type": "object",
samleeflang marked this conversation as resolved.
Show resolved Hide resolved
"properties": {
"ods:id": {
"type": "string",
"pattern": "^https:\\/\\/hdl\\.handle\\.net\\/20\\.5000\\.1025\\/.{3}-.{3}-.{3}$",
"examples": ["https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX"],
"description": "Unique identifier for the object."
},
"ods:type": {
"type": "string",
"examples": ["https://doi.org/21.T11148/2037de437c80264ccbce"],
"description": "This is the handle of the type of the object."
},
sharifX marked this conversation as resolved.
Show resolved Hide resolved
"ods:version": {
"type": "integer",
"examples": [1],
"description": "The version of the object."
},
"dcterms:creator": {
"type": "object",
"properties": {
"ods:type": {
"type": "string",
"examples": ["foaf:Person"],
"description": "Object containing information on who created the object.",
"enum": [
"foaf:Person",
"foaf:Organisation",
"oa:SoftwareAgent"
]
},
"foaf:name": {
"type": "string",
"examples": ["My Name"],
"description": "Name of the creator."
}
sharifX marked this conversation as resolved.
Show resolved Hide resolved
},
"description": "The creator of the collection."
},
"ltc:ObjectGroup": {
"type": "object",
sharifX marked this conversation as resolved.
Show resolved Hide resolved
sharifX marked this conversation as resolved.
Show resolved Hide resolved
"properties": {
"ltc:conditionsOfAccess": {
"type": "boolean",
"examples": ["Open to the public"],
"description": "Information about who can access the collection being described or an indication of its security status."
sharifX marked this conversation as resolved.
Show resolved Hide resolved
samleeflang marked this conversation as resolved.
Show resolved Hide resolved
},
"ltc:collectionName": {
"type": "string",
"examples": ["Arctiacaja1991Netherlands"],
"description": "A short title that summarizes the collection objects contained within the ObjectGroup."
},
"ltc:description": {
"type": "string",
"examples": ["A virtual collection representing all butterfly specimens in South Holland"],
"description": "A free text description or narrative about the collection."
},
"ltc:isKnownToContainTypes": {
"type": "array",
"description": "Flag property to indicate that the collection is known to include type specimens. `true` - this collection contains types; `false` - this collections does not contain types.",
samleeflang marked this conversation as resolved.
Show resolved Hide resolved
"items": {
sharifX marked this conversation as resolved.
Show resolved Hide resolved
"type": "boolean",
"examples": ["true"],
"description": "Type known to be contained."
}
}
},
"description": "An intentionally grouped set of objects with one or more common characteristics."
},
sharifX marked this conversation as resolved.
Show resolved Hide resolved
"ltc:MeasurementOrFact": {
"type": "object",
sharifX marked this conversation as resolved.
Show resolved Hide resolved
"properties": {
"dwc:measurementType": {
"type": "string",
"examples": ["Object Count"],
"description": "The nature of the measurement, fact, characteristic, or assertion."
},
"dwc:measurementValue": {
"type": "number",
sharifX marked this conversation as resolved.
Show resolved Hide resolved
"examples": [100],
"description": "The numerical value of the measurement."
}
},
"description": "A measurement of or fact about a class within the standard, or a relationship between the ObjectGroup and an associated class."
},
"ods:search_filters": {
"type": "array",
sharifX marked this conversation as resolved.
Show resolved Hide resolved
"description": "Search filters selected for the virtual collection.",
"items": {
"type": "object",
"properties": {
"filter_name": {
"type": "string",
sharifX marked this conversation as resolved.
Show resolved Hide resolved
"examples": ["c4df6c19a91c2daaeccd9628e3d3f196"],
"description": "Name or identifier/UUID for the filter."
},
sharifX marked this conversation as resolved.
Show resolved Hide resolved
"filter_value": {
"type": "array",
"examples": ["topicDiscipline=Zoology&midsLevel=1&country=Indonesia&hasMedia=1"],
"description": "Value or configuration of the filter."
}
}
}
},
"ltc:basisOfScheme": {
"type": "string",
sharifX marked this conversation as resolved.
Show resolved Hide resolved
"examples": ["dataset for workshop"],
"description": "A summary of the basis or purpose for the LatimerCoreScheme. This property is intended to summarize the reason for grouping a number of ObjectGroups within the LatimerCoreScheme, and the purpose for which the data is intended to be used."
}
},
"required": ["ods:id", "ods:version","ltc:ObjectGroup"],
"additionalProperties": false
sharifX marked this conversation as resolved.
Show resolved Hide resolved
}
Loading