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

Add acq-instrument.json schema and example file #296

Merged
merged 2 commits into from
Apr 8, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
14 changes: 14 additions & 0 deletions examples/acq-instrument.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"instrument": [
{
"instrumentId": "instrument ID",
"citation": [],
"identifier": {},
"instrumentType": "instrument type",
"description": "instrument description",
"mountedOn": "platformId",
"history": ["events list"],
"hostId": "host instrument ID"
}
]
}
44 changes: 40 additions & 4 deletions schema/acq-instrument.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,46 @@
{
"id": "acq-.json",
"id": "acq-instrument.json",
"$schema": "https://json-schema.org/draft-04/schema#",
"description": "",
"type": "object",
"example": "../examples/acq-.json",
"example": "../examples/acq-instrument.json",
"additionalProperties": false,
"required": [],
"properties": {}
"required": ["instrumentId","identifier","instrumentType"],
"properties": {
"instrumentId": {
"type": "string",
"description": "a unique identifier for the instrument"
},
"citation": {
"$ref": "./citation.json",
"description": "complete citation of the instrument"
},
"identifier": {
"$ref": "./identifier.json",
"description": "unique identification of the instrument"
},
"instrumentType": {
"type": "string",
"description": "name of the type of instrument. Examples: framing, linescan, push-broom, panframe"
},
"description": {
"type": "string",
"description": "textual description of the instrument"
},
"mountedOn": {
"type": "string",
"description": "platform on which the instrument is mounted"
},
"history": {
"type": "array",
"items": {
"type": "string"
},
J-Oliveros marked this conversation as resolved.
Show resolved Hide resolved
"description": "list of events associated with the instrument"
},
"hostId": {
"$ref": "./identifier.json",
"description": "identifier of the hosting instrument for a sensor"
}
}
}