adiwg-mdjson_schemas 2.9.6 → 2.10.0.pre.beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +4 -4
- data/README.md +2 -2
- data/adiwg-json_schemas.gemspec +1 -1
- data/examples/environment.json +10 -0
- data/examples/event.json +13 -0
- data/examples/instrument.json +12 -0
- data/examples/instrumentationEvent.json +9 -0
- data/examples/instrumentationEventList.json +9 -0
- data/examples/objective.json +13 -0
- data/examples/operation.json +16 -0
- data/examples/pass.json +8 -0
- data/examples/plan.json +10 -0
- data/examples/platform.json +11 -0
- data/examples/requestedDate.json +4 -0
- data/examples/requirement.json +14 -0
- data/examples/revision.json +5 -0
- data/lib/adiwg/mdjson_schemas/version.rb +1 -1
- data/package-lock.json +75 -73
- data/package.json +3 -6
- data/schema/acquisition.json +70 -0
- data/schema/dataDictionary.json +5 -36
- data/schema/dataQualityReport.json +15 -15
- data/schema/environment.json +34 -0
- data/schema/event.json +56 -0
- data/schema/instrument.json +46 -0
- data/schema/instrumentationEvent.json +49 -0
- data/schema/instrumentationEventList.json +40 -0
- data/schema/metadata.json +7 -0
- data/schema/objective.json +69 -0
- data/schema/operation.json +101 -0
- data/schema/pass.json +30 -0
- data/schema/plan.json +65 -0
- data/schema/platform.json +48 -0
- data/schema/requestedDate.json +20 -0
- data/schema/requirement.json +57 -0
- data/schema/revision.json +27 -0
- data/schema/schema.json +1 -1
- metadata +33 -9
- data/.github/workflows/create-release.yml +0 -41
- data/CONTRIBUTING.md +0 -75
- data/scripts/clean.sh +0 -5
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "platform.json#",
|
|
3
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
4
|
+
"description": "designation of the platform used to acquire the dataset",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"example": "../examples/platform.json",
|
|
7
|
+
"additionalProperties": false,
|
|
8
|
+
"required": ["platformId", "identifier", "description", "instrument"],
|
|
9
|
+
"properties": {
|
|
10
|
+
"platformId": {
|
|
11
|
+
"type": "string",
|
|
12
|
+
"description": "a unique mdJSON system identifier for the platform"
|
|
13
|
+
},
|
|
14
|
+
"citation": {
|
|
15
|
+
"$ref": "./citation.json#",
|
|
16
|
+
"description": "source where information about the platform is described"
|
|
17
|
+
},
|
|
18
|
+
"identifier": {
|
|
19
|
+
"$ref": "./identifier.json#",
|
|
20
|
+
"description": "unique identification of the platform"
|
|
21
|
+
},
|
|
22
|
+
"description": {
|
|
23
|
+
"type": "string",
|
|
24
|
+
"description": "narrative description of the platform supporting the instrument"
|
|
25
|
+
},
|
|
26
|
+
"sponsor": {
|
|
27
|
+
"type": "array",
|
|
28
|
+
"items": {
|
|
29
|
+
"$ref": "./responsibility.json#"
|
|
30
|
+
},
|
|
31
|
+
"description": "organization responsible for building, launch, or operation of the platform"
|
|
32
|
+
},
|
|
33
|
+
"instrument": {
|
|
34
|
+
"type": "array",
|
|
35
|
+
"items": {
|
|
36
|
+
"$ref": "./instrument.json#"
|
|
37
|
+
},
|
|
38
|
+
"description": "instrument(s) mounted on a platform"
|
|
39
|
+
},
|
|
40
|
+
"history": {
|
|
41
|
+
"type": "array",
|
|
42
|
+
"items": {
|
|
43
|
+
"$ref": "./instrumentationEventList.json#"
|
|
44
|
+
},
|
|
45
|
+
"description": "list of events affecting a platform"
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "requestedDate.json#",
|
|
3
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
4
|
+
"description": "range of date validity",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"example": "../examples/requestedDate.json",
|
|
7
|
+
"additionalProperties": false,
|
|
8
|
+
"required": ["requestedDateOfCollection","latestAcceptableDate"],
|
|
9
|
+
"properties": {
|
|
10
|
+
"requestedDateOfCollection": {
|
|
11
|
+
"$ref": "./common.json#/definitions/date",
|
|
12
|
+
"description": "preferred date and time of collection"
|
|
13
|
+
},
|
|
14
|
+
"latestAcceptableDate": {
|
|
15
|
+
"$ref": "./common.json#/definitions/date",
|
|
16
|
+
"description": "latest date and time collection must be completed"
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "requirement.json#",
|
|
3
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
4
|
+
"description": "requirement to be satisfied by the planned data acquisition",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"required": ["requirementId","identifier","requestor","recipient","priority","requestedDate","expiryDate"],
|
|
7
|
+
"example": "../examples/requirement.json",
|
|
8
|
+
"additionalProperties": false,
|
|
9
|
+
"properties": {
|
|
10
|
+
"requirementId": {
|
|
11
|
+
"type": "string",
|
|
12
|
+
"description": "a unique mdJSON system identifier for the requirement"
|
|
13
|
+
},
|
|
14
|
+
"citation": {
|
|
15
|
+
"$ref": "./citation.json#",
|
|
16
|
+
"description": "identification of reference or guidance material for the requirement"
|
|
17
|
+
},
|
|
18
|
+
"identifier": {
|
|
19
|
+
"$ref": "./identifier.json#",
|
|
20
|
+
"description": "unique name, or code, for the requirement"
|
|
21
|
+
},
|
|
22
|
+
"requestor": {
|
|
23
|
+
"type": "array",
|
|
24
|
+
"items": {
|
|
25
|
+
"$ref": "./responsibility.json#"
|
|
26
|
+
},
|
|
27
|
+
"description": "origin of requirement"
|
|
28
|
+
},
|
|
29
|
+
"recipient": {
|
|
30
|
+
"type": "array",
|
|
31
|
+
"items": {
|
|
32
|
+
"$ref": "./responsibility.json#"
|
|
33
|
+
},
|
|
34
|
+
"description": "person(s), or body(ies), to receive results of requirement"
|
|
35
|
+
},
|
|
36
|
+
"priority": {
|
|
37
|
+
"type": "string",
|
|
38
|
+
"enum": ["critical","highImportance","mediumImportance","lowImportance"],
|
|
39
|
+
"description": "relative ordered importance, or urgency, of the requirement"
|
|
40
|
+
},
|
|
41
|
+
"requestedDate": {
|
|
42
|
+
"$ref": "./requestedDate.json#",
|
|
43
|
+
"description": "required or preferred acquisition date and time"
|
|
44
|
+
},
|
|
45
|
+
"expiryDate": {
|
|
46
|
+
"$ref": "./common.json#/definitions/date",
|
|
47
|
+
"description": "date and time after which collection is no longer valid"
|
|
48
|
+
},
|
|
49
|
+
"satisfiedPlan": {
|
|
50
|
+
"type": "array",
|
|
51
|
+
"items": {
|
|
52
|
+
"$ref": "./plan.json#"
|
|
53
|
+
},
|
|
54
|
+
"description": "plan that identifies solution to satisfy the requirement"
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "revision.json#",
|
|
3
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
4
|
+
"description": "history of the revision of an event",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"example": "../examples/revision.json",
|
|
7
|
+
"additionalProperties": false,
|
|
8
|
+
"required": ["description", "responsibleParty", "dateInfo"],
|
|
9
|
+
"properties": {
|
|
10
|
+
"description": {
|
|
11
|
+
"type": "string",
|
|
12
|
+
"description": "description of the revision."
|
|
13
|
+
},
|
|
14
|
+
"responsibleParty": {
|
|
15
|
+
"$ref": "./responsibility.json#",
|
|
16
|
+
"description": "individual or organization responsible for the revision"
|
|
17
|
+
},
|
|
18
|
+
"dateInfo": {
|
|
19
|
+
"type": "array",
|
|
20
|
+
"items": {
|
|
21
|
+
"$ref": "./common.json#/definitions/date"
|
|
22
|
+
},
|
|
23
|
+
"description": "information about dates related to the revision"
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
|
data/schema/schema.json
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: adiwg-mdjson_schemas
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.
|
|
4
|
+
version: 2.10.0.pre.beta.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Josh Bradley, Stan Smith
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2024-05-08 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -72,14 +72,14 @@ dependencies:
|
|
|
72
72
|
requirements:
|
|
73
73
|
- - '='
|
|
74
74
|
- !ruby/object:Gem::Version
|
|
75
|
-
version: 2.
|
|
75
|
+
version: 2.9.4.pre.beta.0
|
|
76
76
|
type: :development
|
|
77
77
|
prerelease: false
|
|
78
78
|
version_requirements: !ruby/object:Gem::Requirement
|
|
79
79
|
requirements:
|
|
80
80
|
- - '='
|
|
81
81
|
- !ruby/object:Gem::Version
|
|
82
|
-
version: 2.
|
|
82
|
+
version: 2.9.4.pre.beta.0
|
|
83
83
|
description: JSON schemas for validating according to the the ADIwg project and data
|
|
84
84
|
metadata standard. The schemas comply with JSON Schema draft version 4.
|
|
85
85
|
email:
|
|
@@ -89,13 +89,11 @@ extensions: []
|
|
|
89
89
|
extra_rdoc_files: []
|
|
90
90
|
files:
|
|
91
91
|
- ".editorconfig"
|
|
92
|
-
- ".github/workflows/create-release.yml"
|
|
93
92
|
- ".github_changelog_generator"
|
|
94
93
|
- ".gitignore"
|
|
95
94
|
- ".jshintrc"
|
|
96
95
|
- ".travis.yml"
|
|
97
96
|
- CHANGELOG.md
|
|
98
|
-
- CONTRIBUTING.md
|
|
99
97
|
- CREDITS
|
|
100
98
|
- Gemfile
|
|
101
99
|
- Gemfile.lock
|
|
@@ -129,6 +127,8 @@ files:
|
|
|
129
127
|
- examples/entityAttribute.json
|
|
130
128
|
- examples/entityForeignKey.json
|
|
131
129
|
- examples/entityIndex.json
|
|
130
|
+
- examples/environment.json
|
|
131
|
+
- examples/event.json
|
|
132
132
|
- examples/extent.json
|
|
133
133
|
- examples/featureCollection.json
|
|
134
134
|
- examples/featureProperties.json
|
|
@@ -147,6 +147,9 @@ files:
|
|
|
147
147
|
- examples/gridRepresentation.json
|
|
148
148
|
- examples/identifier.json
|
|
149
149
|
- examples/imageDescription.json
|
|
150
|
+
- examples/instrument.json
|
|
151
|
+
- examples/instrumentationEvent.json
|
|
152
|
+
- examples/instrumentationEventList.json
|
|
150
153
|
- examples/keyword.json
|
|
151
154
|
- examples/legalConstraint.json
|
|
152
155
|
- examples/lineage.json
|
|
@@ -158,19 +161,27 @@ files:
|
|
|
158
161
|
- examples/metadata.json
|
|
159
162
|
- examples/metadataInfo.json
|
|
160
163
|
- examples/metadataRepository.json
|
|
164
|
+
- examples/objective.json
|
|
161
165
|
- examples/obliqueLinePoint.json
|
|
162
166
|
- examples/onlineResource.json
|
|
167
|
+
- examples/operation.json
|
|
163
168
|
- examples/orderProcess.json
|
|
164
169
|
- examples/party.json
|
|
170
|
+
- examples/pass.json
|
|
165
171
|
- examples/phone.json
|
|
172
|
+
- examples/plan.json
|
|
173
|
+
- examples/platform.json
|
|
166
174
|
- examples/processStep.json
|
|
167
175
|
- examples/projection.json
|
|
168
176
|
- examples/rangeElementDescription.json
|
|
169
177
|
- examples/referenceSystemParameterSet.json
|
|
170
178
|
- examples/releasability.json
|
|
179
|
+
- examples/requestedDate.json
|
|
180
|
+
- examples/requirement.json
|
|
171
181
|
- examples/resourceInfo.json
|
|
172
182
|
- examples/resourceType.json
|
|
173
183
|
- examples/responsibleParty.json
|
|
184
|
+
- examples/revision.json
|
|
174
185
|
- examples/scope.json
|
|
175
186
|
- examples/scopeDescription.json
|
|
176
187
|
- examples/securityConstraint.json
|
|
@@ -203,6 +214,7 @@ files:
|
|
|
203
214
|
- lib/adiwg/mdjson_schemas/version.rb
|
|
204
215
|
- package-lock.json
|
|
205
216
|
- package.json
|
|
217
|
+
- schema/acquisition.json
|
|
206
218
|
- schema/additionalDocumentation.json
|
|
207
219
|
- schema/associatedResource.json
|
|
208
220
|
- schema/attribute.json
|
|
@@ -224,7 +236,9 @@ files:
|
|
|
224
236
|
- schema/domain.json
|
|
225
237
|
- schema/entity.json
|
|
226
238
|
- schema/entityAttribute.json
|
|
239
|
+
- schema/environment.json
|
|
227
240
|
- schema/evaluationMethod.json
|
|
241
|
+
- schema/event.json
|
|
228
242
|
- schema/extent.json
|
|
229
243
|
- schema/format.json
|
|
230
244
|
- schema/funding.json
|
|
@@ -239,6 +253,9 @@ files:
|
|
|
239
253
|
- schema/gridRepresentation.json
|
|
240
254
|
- schema/identifier.json
|
|
241
255
|
- schema/imageDescription.json
|
|
256
|
+
- schema/instrument.json
|
|
257
|
+
- schema/instrumentationEvent.json
|
|
258
|
+
- schema/instrumentationEventList.json
|
|
242
259
|
- schema/keyword.json
|
|
243
260
|
- schema/lineage.json
|
|
244
261
|
- schema/locale.json
|
|
@@ -248,8 +265,13 @@ files:
|
|
|
248
265
|
- schema/metadata.json
|
|
249
266
|
- schema/metadataInfo.json
|
|
250
267
|
- schema/metadataRepository.json
|
|
268
|
+
- schema/objective.json
|
|
251
269
|
- schema/onlineResource.json
|
|
270
|
+
- schema/operation.json
|
|
252
271
|
- schema/orderProcess.json
|
|
272
|
+
- schema/pass.json
|
|
273
|
+
- schema/plan.json
|
|
274
|
+
- schema/platform.json
|
|
253
275
|
- schema/projection.json
|
|
254
276
|
- schema/qualityMeasure.json
|
|
255
277
|
- schema/qualityResultFile.json
|
|
@@ -257,9 +279,12 @@ files:
|
|
|
257
279
|
- schema/rangeElementDescription.json
|
|
258
280
|
- schema/referenceSystemParameterSet.json
|
|
259
281
|
- schema/releasability.json
|
|
282
|
+
- schema/requestedDate.json
|
|
283
|
+
- schema/requirement.json
|
|
260
284
|
- schema/resourceInfo.json
|
|
261
285
|
- schema/resourceType.json
|
|
262
286
|
- schema/responsibility.json
|
|
287
|
+
- schema/revision.json
|
|
263
288
|
- schema/schema.json
|
|
264
289
|
- schema/scope.json
|
|
265
290
|
- schema/spatialReference.json
|
|
@@ -275,7 +300,6 @@ files:
|
|
|
275
300
|
- schema/vectorRepresentation.json
|
|
276
301
|
- schema/verticalDatum.json
|
|
277
302
|
- schema/verticalExtent.json
|
|
278
|
-
- scripts/clean.sh
|
|
279
303
|
- scripts/prepublish.js
|
|
280
304
|
- test/draft-04.json
|
|
281
305
|
- test/helper.rb
|
|
@@ -379,9 +403,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
379
403
|
version: '0'
|
|
380
404
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
381
405
|
requirements:
|
|
382
|
-
- - "
|
|
406
|
+
- - ">"
|
|
383
407
|
- !ruby/object:Gem::Version
|
|
384
|
-
version:
|
|
408
|
+
version: 1.3.1
|
|
385
409
|
requirements: []
|
|
386
410
|
rubygems_version: 3.1.6
|
|
387
411
|
signing_key:
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
name: Deploy to GitHub Pages
|
|
2
|
-
|
|
3
|
-
on:
|
|
4
|
-
push:
|
|
5
|
-
branches:
|
|
6
|
-
- master
|
|
7
|
-
|
|
8
|
-
jobs:
|
|
9
|
-
create-release:
|
|
10
|
-
runs-on: ubuntu-latest
|
|
11
|
-
steps:
|
|
12
|
-
- uses: actions/checkout@v3
|
|
13
|
-
|
|
14
|
-
- name: Use Node.js
|
|
15
|
-
uses: actions/setup-node@v3
|
|
16
|
-
with:
|
|
17
|
-
node-version: "16"
|
|
18
|
-
|
|
19
|
-
- name: Create Tag
|
|
20
|
-
id: create_tag
|
|
21
|
-
env:
|
|
22
|
-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
23
|
-
run: |
|
|
24
|
-
# Read version from package.json
|
|
25
|
-
version=$(node -p "require('./package.json').version")
|
|
26
|
-
version_tag="v$version"
|
|
27
|
-
echo "Version from package.json: $version_tag"
|
|
28
|
-
echo "version=$version_tag" >> $GITHUB_OUTPUT
|
|
29
|
-
git tag $version_tag
|
|
30
|
-
git push origin $version_tag
|
|
31
|
-
|
|
32
|
-
- name: Create GitHub Release
|
|
33
|
-
uses: ncipollo/release-action@v1
|
|
34
|
-
with:
|
|
35
|
-
tag: ${{ steps.create_tag.outputs.version }}
|
|
36
|
-
name: Release ${{ steps.create_tag.outputs.version }}
|
|
37
|
-
body: Automated release for version ${{ steps.create_tag.outputs.version }}.
|
|
38
|
-
draft: false
|
|
39
|
-
prerelease: false
|
|
40
|
-
env:
|
|
41
|
-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
data/CONTRIBUTING.md
DELETED
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
# mdJSON Schema Style Guidelines
|
|
2
|
-
The following guidelines should be used when editiing mdJSON schema definition files.
|
|
3
|
-
|
|
4
|
-
# Guidelines
|
|
5
|
-
- [Use lowerCamelCase](#use-lowercamelcase)
|
|
6
|
-
- [Use singular tense](#use-singular-tense)
|
|
7
|
-
- [Provide all translations](#provide-all-translations)
|
|
8
|
-
|
|
9
|
-
## Use lowerCamelCase
|
|
10
|
-
Use lower camel case for all schema property names.
|
|
11
|
-
|
|
12
|
-
yes:
|
|
13
|
-
```
|
|
14
|
-
title
|
|
15
|
-
associatedResource{}
|
|
16
|
-
pointOfContact[]
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
no:
|
|
20
|
-
```
|
|
21
|
-
Title
|
|
22
|
-
AssociatedResource{}
|
|
23
|
-
pointofContact[]
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Use singular tense
|
|
27
|
-
Use singular tense for all property names names.
|
|
28
|
-
|
|
29
|
-
yes: `dataDictionary[]`
|
|
30
|
-
|
|
31
|
-
no: `dataDictionaries[]`
|
|
32
|
-
|
|
33
|
-
## Provide all translations
|
|
34
|
-
Provide translations for: 1) "[__FGDC CSDGM__](https://www.fgdc.gov/metadata/csdgm-standard)", 2) "__DCAT__" ([Data Catalog Vocabulary](https://www.w3.org/TR/vocab-dcat-2/)), and 3) "[__sbJSON__]" ([ScienceBase JSON](https://www.usgs.gov/sciencebase-instructions-and-documentation/item-core-model)) when an ISO translation is provided. If no translation is available indicate ```"no translation"```.
|
|
35
|
-
|
|
36
|
-
yes:
|
|
37
|
-
```
|
|
38
|
-
"translation": {
|
|
39
|
-
"ISO 19115-1": ["CI_ResponsibleParty > partyIdentifier"],
|
|
40
|
-
"FGDC CSDGM": ["no translation"]
|
|
41
|
-
"DCAT": ["no translation"],
|
|
42
|
-
"sbJSON": ["no translation"]
|
|
43
|
-
}
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
yes:
|
|
47
|
-
```
|
|
48
|
-
"translation": {
|
|
49
|
-
"ISO 19115-2": ["MD_Keywords > thesaurusName > CI_Citation"],
|
|
50
|
-
"FGDC CSDGM": [
|
|
51
|
-
"idinfo>keywords>theme>themekt",
|
|
52
|
-
"idinfo>keywords>place>placekt",
|
|
53
|
-
"idinfo>keywords>temporal>tempkt"
|
|
54
|
-
],
|
|
55
|
-
"DCAT": ["no translation"],
|
|
56
|
-
"sbJSON": ["tags > scheme"]
|
|
57
|
-
}
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
no:
|
|
61
|
-
```
|
|
62
|
-
"translation": {
|
|
63
|
-
"ISO 19115-1": ["CI_ResponsibleParty > partyIdentifier"]
|
|
64
|
-
}
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
no:
|
|
68
|
-
```
|
|
69
|
-
"translation": {
|
|
70
|
-
"ISO 19115-1": ["CI_ResponsibleParty > partyIdentifier"],
|
|
71
|
-
"FGDC CSDGM": ["no translation"]
|
|
72
|
-
}
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
|