adiwg-json_schemas 0.8.1 → 0.9.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.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/adiwg-json_schemas.gemspec +2 -2
  3. data/examples/full_example.json +58 -55
  4. data/examples/full_example2.json +64 -61
  5. data/examples/lcc_project_example.json +1 -3
  6. data/examples/minimum_example.json +35 -0
  7. data/examples/resourceConstraints.json +1 -2
  8. data/examples/resourceInfo.json +2 -0
  9. data/lib/adiwg/json_schemas/version.rb +1 -1
  10. data/schema/schema/citation.json +68 -6
  11. data/schema/schema/contact.json +131 -46
  12. data/schema/schema/dataQuality.json +80 -7
  13. data/schema/schema/distributor.json +91 -10
  14. data/schema/schema/extent.json +93 -11
  15. data/schema/schema/geojson/bbox.json +5 -1
  16. data/schema/schema/geojson/crs.json +74 -48
  17. data/schema/schema/geojson/geojson.json +63 -18
  18. data/schema/schema/geojson/geometry.json +69 -9
  19. data/schema/schema/graphicOverview.json +22 -3
  20. data/schema/schema/keyword.json +15 -1
  21. data/schema/schema/maintInfo.json +18 -2
  22. data/schema/schema/metadata.json +97 -17
  23. data/schema/schema/onlineResource.json +21 -5
  24. data/schema/schema/resolution.json +21 -4
  25. data/schema/schema/resourceConstraint.json +46 -7
  26. data/schema/schema/resourceInfo.json +142 -15
  27. data/schema/schema/taxonomy.json +64 -7
  28. data/schema/schema/usage.json +18 -3
  29. data/schema/schema.json +12 -2
  30. data/templates/adiwg_metadata_template.json +450 -147
  31. data/test/tc_schemas.rb +5 -0
  32. metadata +3 -2
data/schema/schema/onlineResource.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "id": "onlineResource.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
- "description": "schema for online resource",
5
4
  "type": "object",
5
+ "description": "Information about accessing on-line resources and services.",
6
6
  "required": ["uri"],
7
7
  "additionalProperties": false,
8
8
  "properties": {
@@ -10,16 +10,32 @@
10
10
  "$ref": "../schema.json#/definitions/uri"
11
11
  },
12
12
  "name": {
13
- "type": "string"
13
+ "type": "string",
14
+ "description": "Name of the online resource.",
15
+ "translation": {
16
+ "ISO 19115-2": ["CI_OnlineResource > name"]
17
+ }
14
18
  },
15
19
  "protocol": {
16
- "type": "string"
20
+ "type": "string",
21
+ "description": "The connection protocol to be used such as ftp, http, etc.",
22
+ "translation": {
23
+ "ISO 19115-2": ["CI_OnlineResource > protocol"]
24
+ }
17
25
  },
18
26
  "description": {
19
- "type": "string"
27
+ "type": "string",
28
+ "description": "Detailed text description of what the online resource is/does.",
29
+ "translation": {
30
+ "ISO 19115-2": ["CI_OnlineResource > description"]
31
+ }
20
32
  },
21
33
  "function": {
22
- "type": "string"
34
+ "type": "string",
35
+ "description": "Function performed by the online resource.",
36
+ "translation": {
37
+ "ISO 19115-2": ["CI_OnlineResource > function > CI_OnlineFunctionCode [codelist]"]
38
+ }
23
39
  }
24
40
  }
25
41
  }
data/schema/schema/resolution.json CHANGED
@@ -1,29 +1,46 @@
1
1
  {
2
2
  "id": "resolution.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
- "description": "schema for spatial resolution",
4
+ "description": "Information about the scale of the geographic extent.",
5
+ "translation": {
6
+ "ISO 19115-2": ["MD_Resolution"]
7
+ },
5
8
  "anyOf": [
6
9
  {
7
10
  "type": "object",
8
11
  "title": "scaleFactor",
12
+ "description": "Scale of geographic extent",
9
13
  "required": ["equivalentScale"],
10
14
  "additionalProperties": true,
11
15
  "properties": {
12
16
  "equivalentScale": {
13
- "type": "number"
17
+ "type": "number",
18
+ "description": "Scale of geographic extent expressed in a hardcopy map scale fraction (denominator).",
19
+ "translation": {
20
+ "ISO 19115-2": ["MD_Resolution > equivalentScale > MD_RepresentativeFraction > denominator > Integer"]
21
+ }
14
22
  }
15
23
  }
16
24
  }, {
17
25
  "type": "object",
18
26
  "title": "distance",
27
+ "description": "Scale of geographic extent expressed in ground distance parameters.",
19
28
  "required": ["distance"],
20
29
  "additionalProperties": true,
21
30
  "properties": {
22
31
  "distance": {
23
- "type": "number"
32
+ "type": "number",
33
+ "description": "Ground distance measurement representing geographic extent.",
34
+ "translation": {
35
+ "ISO 19115-2": ["MD_Resolution > distance > Distance "]
36
+ }
24
37
  },
25
38
  "uom": {
26
- "type": "string"
39
+ "type": "string",
40
+ "description": "Ground distance units of measure.",
41
+ "translation": {
42
+ "ISO 19115-2": ["MD_Resolution > distance > Distance @uom"]
43
+ }
27
44
  }
28
45
  }
29
46
  }
data/schema/schema/resourceConstraint.json CHANGED
@@ -13,29 +13,48 @@
13
13
  ],
14
14
  "definitions": {
15
15
  "useLimitation": {
16
- "type": "array",
17
- "items": {
18
- "type": "string"
16
+ "type": "string",
17
+ "description": "Limitation affecting the fitness for use of the resource or metadata. For example, “not to be used for navigation”.",
18
+ "translation": {
19
+ "ISO 19115-2": ["MD_Constraints > useLimitation"]
19
20
  }
20
21
  },
21
22
  "legalConstraint": {
22
23
  "type": "object",
24
+ "description": "Restrictions and legal prerequisites for accessing and using the resource or metadata.",
25
+ "translation": {
26
+ "ISO 19115-2": ["MD_LegalConstraints"]
27
+ },
23
28
  "additionalProperties": false,
24
29
  "properties": {
25
30
  "accessConstraint": {
26
31
  "type": "array",
32
+ "description": "Access constraints applied to assure the protection of privacy or intellectual property, and any special restrictions or limitations on obtaining the resource or metadata.",
33
+ "translation": {
34
+ "ISO 19115-2": ["MD_LegalConstraints > accessConstraints [MD_RestrictionCode]"],
35
+ "FGDC CSDGM": ["idinfo > accconst"]
36
+ },
27
37
  "items": {
28
38
  "type": "string"
29
39
  }
30
40
  },
31
41
  "useConstraint": {
32
42
  "type": "array",
43
+ "description": "Constraints applied to assure the protection of privacy or intellectual property, and any special restrictions or limitations or warnings on using the resource or metadata.",
44
+ "translation": {
45
+ "ISO 19115-2": ["MD_LegalConstraints > useConstraints [MD_RestrictionCode]"],
46
+ "FGDC CSDGM": ["idinfo > useconst"]
47
+ },
33
48
  "items": {
34
49
  "type": "string"
35
50
  }
36
51
  },
37
52
  "otherConstraint": {
38
53
  "type": "array",
54
+ "description": "Other restrictions and legal prerequisites for accessing and using the resource or metadata.",
55
+ "translation": {
56
+ "ISO 19115-2": ["MD_LegalConstraints > otherConstraints"]
57
+ },
39
58
  "items": {
40
59
  "type": "string"
41
60
  }
@@ -44,20 +63,40 @@
44
63
  },
45
64
  "securityConstraint": {
46
65
  "type": "object",
66
+ "description": "Handling restrictions imposed on the resource or metadata for national security or similar security concerns.",
67
+ "translation": {
68
+ "ISO 19115-2": ["MD_SecurityConstraints"]
69
+ },
47
70
  "required": ["classification"],
48
71
  "additionalProperties": false,
49
72
  "properties": {
50
73
  "classification": {
51
- "type": "string"
74
+ "type": "string",
75
+ "description": "Name of the handling restrictions on the resource or metadata.",
76
+ "translation": {
77
+ "ISO 19115-2": ["MD_SecurityConstraints > classification [MD_ClassificationCode]"]
78
+ }
52
79
  },
53
80
  "userNote": {
54
- "type": "string"
81
+ "type": "string",
82
+ "description": "Explanation of the application of the legal constraints or other restrictions and legal prerequisites for obtaining and using the resource or metadata.",
83
+ "translation": {
84
+ "ISO 19115-2": ["MD_SecurityConstraints > userNote"]
85
+ }
55
86
  },
56
87
  "classificationSystem": {
57
- "type": "string"
88
+ "type": "string",
89
+ "description": "Name of the classification system associated with a security constraint.",
90
+ "translation": {
91
+ "ISO 19115-2": ["MD_SecurityConstraints > classificationSystem"]
92
+ }
58
93
  },
59
94
  "handlingDescription": {
60
- "type": "string"
95
+ "type": "string",
96
+ "description": "Additional description regarding the security handling of the resource or metadata.",
97
+ "translation": {
98
+ "ISO 19115-2": ["MD_SecurityConstraints > handlingDescription"]
99
+ }
61
100
  }
62
101
  }
63
102
  }
data/schema/schema/resourceInfo.json CHANGED
@@ -1,16 +1,44 @@
1
1
  {
2
2
  "id": "resourceInfo.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
- "description": "schema for ADIwg metadata resourceInfo section",
4
+ "description": "Information about the resource.",
5
5
  "type": "object",
6
- "required": ["citation", "abstract", "status", "language"],
6
+ "example": "../../examples/full_example.json#/metadata/resourceInfo",
7
+ "translation": {
8
+ "ISO 19115-2": ["MD_DataIdentification"],
9
+ "FGDC CSDGM": ["idinfo"]
10
+ },
11
+ "required": ["resourceType", "citation", "abstract", "status", "language", "pointOfContact"],
7
12
  "additionalProperties": false,
8
13
  "properties": {
14
+ "resourceType": {
15
+ "type": "string",
16
+ "description": "Identifies the type of resource, such as; a dataset, study, publication, etc.",
17
+ "translation": {
18
+ "ISO 19115-2": ["MI_Metadata > hierarchyLevel [MD_ScopeCode]"]
19
+ }
20
+ },
9
21
  "citation": {
22
+ "description": "Citation for the resource.",
23
+ "translation": {
24
+ "ISO 19115-2": ["MD_DataIdentification > citation > CI_Citation"],
25
+ "FGDC CSDGM": ["idinfo > citation"]
26
+ },
10
27
  "$ref": "citation.json#"
11
28
  },
29
+ "resourceTimePeriod": {
30
+ "description": "Time period for the resource, e.g. project start and end date(s).",
31
+ "translation": {
32
+ "ISO 19115-2": ["EX_Extent > temporalElement > EX_TemporalExtent > extent > TimePeriod"]
33
+ },
34
+ "$ref": "extent.json#/definitions/timePeriod"
35
+ },
12
36
  "pointOfContact": {
13
37
  "type": "array",
38
+ "description": "Identification of, and means of communication with, person(s) and organizations that may be contacted for acquiring knowledge about or acquisition of the resource.",
39
+ "translation": {
40
+ "ISO 19115-2": ["MD_DataIdentification > pointOfContact"]
41
+ },
14
42
  "minItems": 1,
15
43
  "uniqueItems": true,
16
44
  "items": {
@@ -18,49 +46,86 @@
18
46
  }
19
47
  },
20
48
  "abstract": {
21
- "type": "string"
49
+ "type": "string",
50
+ "description": "Brief narrative summary of the content of the resource.",
51
+ "translation": {
52
+ "ISO 19115-2": ["MD_DataIdentification > abstract"],
53
+ "FGDC CSDGM": ["idinfo > descript > abstract"]
54
+ }
22
55
  },
23
56
  "shortAbstract": {
24
- "type": "string"
57
+ "type": "string",
58
+ "description": "A short description of the resource. Max of 300 characters."
25
59
  },
26
60
  "status": {
27
- "type": "string"
28
- },
29
- "resourceUri": {
30
- "$ref": "../schema.json#/definitions/uri"
61
+ "type": "string",
62
+ "description": "Status of the resource.",
63
+ "translation": {
64
+ "ISO 19115-2": ["MD_DataIdentification > status"],
65
+ "FGDC CSDGM": ["idinfo > status > progress"]
66
+ }
31
67
  },
32
68
  "hasMapLocation": {
33
- "type": "boolean"
69
+ "type": "boolean",
70
+ "description": "A flag indicating that a resource has a geographic location associated with it and therefore can be located using a map interface."
34
71
  },
35
72
  "hasDataAvailable": {
36
- "type": "boolean"
73
+ "type": "boolean",
74
+ "description": "A flag to indicate whether data for this resource is available for distribution."
37
75
  },
38
76
  "language": {
39
77
  "type": "array",
78
+ "description": "Language(s) used within the resource. Should be a valid ISO 639-3 code.",
79
+ "translation": {
80
+ "ISO 19115-2": ["MD_DataIdentification > language"]
81
+ },
40
82
  "items": {
41
83
  "type": "string"
42
84
  }
43
85
  },
44
86
  "purpose": {
45
- "type": "string"
87
+ "type": "string",
88
+ "description": "A summary of intentions for which the resource was created.",
89
+ "translation": {
90
+ "ISO 19115-2": ["MD_DataIdentification > purpose"],
91
+ "FGDC CSDGM": ["idinfo > descript > purpose"]
92
+ }
46
93
  },
47
94
  "credit": {
48
95
  "type": "array",
96
+ "description": "A narrative identification of additional resources credited for the resource.",
97
+ "translation": {
98
+ "ISO 19115-2": ["MD_DataIdentification > credit"],
99
+ "FGDC CSDGM": ["idinfo > datacred"]
100
+ },
49
101
  "items": {
50
102
  "type": "string"
51
103
  }
52
104
  },
53
105
  "topicCategory": {
54
106
  "type": "array",
107
+ "description": "General theme keyword of the resource, such as; oceans, biota atmosphere, etc.",
108
+ "translation": {
109
+ "ISO 19115-2": ["MD_DataIdentification > topicCategory"]
110
+ },
55
111
  "items": {
56
112
  "type": "string"
57
113
  }
58
114
  },
59
115
  "environmentDescription": {
60
- "type": "string"
116
+ "type": "string",
117
+ "description": "Description of the dataset in the producer’s processing environment, including items such as the software, the computer, the computer operating system, file name, and the dataset size.",
118
+ "translation": {
119
+ "ISO 19115-2": ["MD_DataIdentification > environmentDescription"],
120
+ "FGDC CSDGM": ["idinfo > native"]
121
+ }
61
122
  },
62
123
  "resourceNativeFormat": {
63
124
  "type": "array",
125
+ "description": "Provides a description of the format of the resource(s).",
126
+ "translation": {
127
+ "ISO 19115-2": ["MD_DataIdentification > resourceFormat > MD_Format"]
128
+ },
64
129
  "minItems": 1,
65
130
  "uniqueItems": true,
66
131
  "items": {
@@ -69,6 +134,11 @@
69
134
  },
70
135
  "keyword": {
71
136
  "type": "array",
137
+ "description": "Provides category keywords, their type, and reference source.",
138
+ "translation": {
139
+ "ISO 19115-2": ["MD_DataIdentification > descriptiveKeywords > MD_Keywords"],
140
+ "FGDC CSDGM": ["idinfo > keywords"]
141
+ },
72
142
  "uniqueItems": true,
73
143
  "items": {
74
144
  "$ref": "keyword.json"
@@ -76,12 +146,20 @@
76
146
  },
77
147
  "resourceMaintenance": {
78
148
  "type": "array",
149
+ "description": "Information about the maintenance of the resource.",
150
+ "translation": {
151
+ "ISO 19115-2": ["MD_DataIdentification > resourceMaintenance > MD_MaintenanceInformation"]
152
+ },
79
153
  "items": {
80
154
  "$ref": "maintInfo.json#"
81
155
  }
82
156
  },
83
157
  "resourceSpecificUsage": {
84
158
  "type": "array",
159
+ "description": "Description of ways in which the resource is currently or has been used.",
160
+ "translation": {
161
+ "ISO 19115-2": ["MD_DataIdentification > resourceSpecificUsage > MD_Usage"]
162
+ },
85
163
  "uniqueItems": true,
86
164
  "items": {
87
165
  "$ref": "usage.json"
@@ -89,24 +167,44 @@
89
167
  },
90
168
  "graphicOverview": {
91
169
  "type": "array",
170
+ "description": "A browse graphic associated with the resource in which to gain an at-a-glance referencing for the resource, such as geographic location and extent.",
171
+ "translation": {
172
+ "ISO 19115-2": ["MD_DataIdentification > graphicOverview > MD_BrowseGraphic"]
173
+ },
92
174
  "items": {
93
175
  "$ref": "graphicOverview.json#"
94
176
  }
95
177
  },
96
178
  "constraint": {
97
179
  "type": "object",
180
+ "description": "Provides information about constraints to the use of the resource.",
181
+ "translation": {
182
+ "ISO 19115-2": ["MD_DataIdentification > resourceConstraints"]
183
+ },
98
184
  "properties": {
99
185
  "useLimitation": {
100
- "$ref": "resourceConstraint.json#/definitions/useLimitation"
186
+ "type": "array",
187
+ "translation": {
188
+ "ISO 19115-2": ["MD_DataIdentification > resourceConstraints > MD_Constraints[useLimitation]"]
189
+ },
190
+ "items": {
191
+ "$ref": "resourceConstraint.json#/definitions/useLimitation"
192
+ }
101
193
  },
102
194
  "legalConstraint": {
103
195
  "type": "array",
196
+ "translation": {
197
+ "ISO 19115-2": ["MI_Metadata > resourceConstraints > MD_LegalConstraints"]
198
+ },
104
199
  "items": {
105
200
  "$ref": "resourceConstraint.json#/definitions/legalConstraint"
106
201
  }
107
202
  },
108
203
  "securityConstraint": {
109
204
  "type": "array",
205
+ "translation": {
206
+ "ISO 19115-2": ["MI_Metadata > resourceConstraints > MD_SecurityConstraints"]
207
+ },
110
208
  "items": {
111
209
  "$ref": "resourceConstraint.json#/definitions/securityConstraint"
112
210
  }
@@ -114,11 +212,18 @@
114
212
  }
115
213
  },
116
214
  "taxonomy": {
215
+ "translation": {
216
+ "ISO 19115-2": ["MD_DataIdentification > taxonomy"],
217
+ "FGDC CSDGM": ["idinfo > taxonomy"]
218
+ },
117
219
  "$ref": "taxonomy.json"
118
220
  },
119
221
  "spatialReferenceSystem": {
120
- "description": "Description of the spatial and temporal reference systems used in the dataset.",
222
+ "description": "Geospatial referencing system associated with describing the geospatial extent of the data resource. The referencing can be provided indirectly by an EPSG number, a named reference, or providing the parameters in a well known text (WKT) format.",
121
223
  "example": "../../examples/spatialRef.json",
224
+ "translation": {
225
+ "ISO 19115-2": ["MD_Metadata > referenceSystemInfo > MD_ReferenceSystem > referenceSystemIdentifier > RS_Identifier > code"]
226
+ },
122
227
  "type": "object",
123
228
  "properties": {
124
229
  "name": {
@@ -146,30 +251,52 @@
146
251
  },
147
252
  "spatialRepresentation": {
148
253
  "type": "array",
254
+ "description": "Format of the resource geographic extent, such as; vector, grid, etc.",
255
+ "translation": {
256
+ "ISO 19115-2": ["MD_DataIdenification > spatialRepresentationType [MD_SpatialRepresentationTypeCode]"],
257
+ "FGDC CSDGM": ["spdoinfo"]
258
+ },
149
259
  "items": {
150
260
  "type": "string"
151
261
  }
152
262
  },
153
263
  "spatialResolution": {
154
264
  "type": "array",
265
+ "description": "Information about the scale of the geographic extent.",
266
+ "translation": {
267
+ "ISO 19115-2": ["MD_DataIdenification > spatialResolution > MD_Resolution"]
268
+ },
155
269
  "items": {
156
270
  "$ref": "resolution.json"
157
271
  }
158
272
  },
159
273
  "extent": {
160
274
  "type": "array",
275
+ "description": "Information about the geographic extent of the resource. A resource may have multiple extents.",
276
+ "translation": {
277
+ "ISO 19115-2": ["MD_DataIdentification > extent > EX_Extent"]
278
+ },
161
279
  "items": {
162
280
  "$ref": "extent.json"
163
281
  }
164
282
  },
165
283
  "dataQualityInfo": {
166
284
  "type": "array",
285
+ "description": "Information about the quality of the resource.",
286
+ "translation": {
287
+ "ISO 19115-2": ["MI_Metadata > dataQualityInfo > DQ_DataQuality"],
288
+ "FGDC CSDGM": ["dataqual"]
289
+ },
167
290
  "items": {
168
291
  "$ref": "dataQuality.json#"
169
292
  }
170
293
  },
171
294
  "supplementalInfo": {
172
- "type": "string"
295
+ "type": "string",
296
+ "description": "Any other descriptive information about the dataset.",
297
+ "translation": {
298
+ "ISO 19115-2": ["MD_DataIdentification > supplementalInfo"]
299
+ }
173
300
  }
174
301
  }
175
302
  }