adiwg-json_schemas 0.8.1 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,7 +1,12 @@
1
1
  {
2
2
  "id": "contact.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
- "description": "schema for a contacts list, contains definitions for individual and organization",
4
+ "description": "An array of contacts to be referenced throughout the metadata. Any contact used in the metadata record must be stored within this array and referenced by contactId. Items in array may be used 0-n times throughout the record.",
5
+ "translation": {
6
+ "ISO 19115-2": ["Contact > CI_ResponsibleParty"],
7
+ "FGDC CSDGM": ["[single member of array] = cntinfo"]
8
+ },
9
+ "example": "../../examples/contact.json",
5
10
  "type": "array",
6
11
  "minItems": 1,
7
12
  "uniqueItems": true,
@@ -20,14 +25,22 @@
20
25
  "required": ["phoneNumber"],
21
26
  "properties": {
22
27
  "phoneName": {
23
- "type": "string"
28
+ "type": "string",
29
+ "description": "Descriptive name of the phone number."
24
30
  },
25
31
  "phoneNumber": {
26
32
  "type": "string",
33
+ "description": "Telephone number. Recommended format is to use 'x' or 'ext' to denote extensions.",
34
+ "translation": {
35
+ "ISO 19115-2": ["CI_Telephone > voice | facsimile"],
36
+ "FGDC CSDGM": ["cntinfo > cntvoice"]
37
+ },
27
38
  "pattern": "^[0-9+()#. \/ext-]+$"
28
39
  },
29
40
  "service": {
30
41
  "type": "array",
42
+ "description": "Type(s) of phone number, e.g. voice, sms."
43
+ ,
31
44
  "items": {
32
45
  "type": "string"
33
46
  },
@@ -38,28 +51,63 @@
38
51
  },
39
52
  "address": {
40
53
  "type": "object",
54
+ "description": "Physical and email address at which the organization or individual may be contacted.",
55
+ "translation": {
56
+ "ISO 19115-2": ["CI_ResponsibleParty > contactInfo > CI_Contact > address > CI_Address"],
57
+ "FGDC CSDGM": ["cntinfo > cntaddr"]
58
+ },
41
59
  "properties": {
42
60
  "deliveryPoint": {
43
61
  "type": "array",
62
+ "description": "Address line for the location.",
63
+ "translation": {
64
+ "ISO 19115-2": ["CI_Address > deliveryPoint"],
65
+ "FGDC CSDGM": ["cntinfo > cntaddr > address"]
66
+ },
44
67
  "items": {
45
68
  "type": "string"
46
69
  },
47
70
  "uniqueItems": true
48
71
  },
49
72
  "city": {
50
- "type": "string"
73
+ "type": "string",
74
+ "description": "City of the location.",
75
+ "translation": {
76
+ "ISO 19115-2": ["CI_Address > city"],
77
+ "FGDC CSDGM": ["cntinfo > cntaddr > city"]
78
+ }
51
79
  },
52
80
  "administrativeArea": {
53
- "type": "string"
81
+ "type": "string",
82
+ "description": "State, province of the location.",
83
+ "translation": {
84
+ "ISO 19115-2": ["CI_Address > administrativeArea"],
85
+ "FGDC CSDGM": ["cntinfo > cntaddr > state"]
86
+ }
54
87
  },
55
88
  "postalCode": {
56
- "type": "string"
89
+ "type": "string",
90
+ "description": "ZIP or other postal code.",
91
+ "translation": {
92
+ "ISO 19115-2": ["CI_Address > postalCode"],
93
+ "FGDC CSDGM": ["cntinfo > cntaddr > postal"]
94
+ }
57
95
  },
58
96
  "country": {
59
- "type": "string"
97
+ "type": "string",
98
+ "description": "ZIP or other postal code.",
99
+ "translation": {
100
+ "ISO 19115-2": ["CI_Address > postalCode"],
101
+ "FGDC CSDGM": ["cntinfo > cntaddr > postal"]
102
+ }
60
103
  },
61
104
  "electronicMailAddress": {
62
105
  "type": "array",
106
+ "description": "E-mail or electronic mailbox address.",
107
+ "translation": {
108
+ "ISO 19115-2": ["CI_Address > electronicMailAddress"],
109
+ "FGDC CSDGM": ["cntinfo > cntemail"]
110
+ },
63
111
  "items": {
64
112
  "type": "string",
65
113
  "pattern": "^.+@.+\\..+$"
@@ -69,80 +117,111 @@
69
117
  },
70
118
  "additionalProperties": false
71
119
  },
72
- "individual": {
120
+ "baseContact": {
73
121
  "type": "object",
74
- "title": "individual",
75
- "required": ["contactId", "individualName"],
122
+ "title": "base contact",
123
+ "description": "Basic information for a contact.",
124
+ "required": ["contactId"],
76
125
  "additionalProperties": true,
77
126
  "properties": {
78
127
  "contactId": {
79
128
  "type": "string"
80
129
  },
81
- "individualName": {
82
- "type": "string"
83
- },
84
130
  "positionName": {
85
- "type": "string"
86
- },
87
- "organizationName": {
88
- "type": "string"
131
+ "type": "string",
132
+ "description": "Role or position of the person, usually within a given organization.",
133
+ "translation": {
134
+ "ISO 19115-2": ["CI_ResponsibleParty > positionName"],
135
+ "FGDC CSDGM": ["cntinfo > cntpos"]
136
+ }
89
137
  },
90
138
  "address": {
91
139
  "$ref": "#/definitions/address"
92
140
  },
93
141
  "onlineResource": {
94
142
  "type": "array",
143
+ "description": "Information about accessing on-line resources and services. This may be a website, profile page, GitHub page, etc. related to the contact.",
144
+ "translation": {
145
+ "ISO 19115-2": ["CI_ResponsibleParty > contactInfo > CI_Contact > onlineResource > CI_OnlineResource"]
146
+ },
95
147
  "items": {
96
148
  "$ref": "onlineResource.json#"
97
149
  },
98
150
  "uniqueItems": true
99
151
  },
100
152
  "contactInstructions": {
101
- "type": "string"
153
+ "type": "string",
154
+ "description": "Supplemental instructions on how or when to contact the individual or organization.",
155
+ "translation": {
156
+ "ISO 19115-2": ["CI_Contact > contactInstructions"],
157
+ "FGDC CSDGM": ["cntinfo > cntinst"]
158
+ }
102
159
  },
103
160
  "phoneBook": {
104
161
  "type": "array",
162
+ "description": "Supplemental instructions on how or when to contact the individual or organization.",
163
+ "translation": {
164
+ "ISO 19115-2": ["CI_Contact > contactInstructions"],
165
+ "FGDC CSDGM": ["cntinfo > cntinst"]
166
+ },
105
167
  "items": {
106
168
  "$ref": "#/definitions/phone"
107
169
  }
108
170
  }
109
171
  }
110
172
  },
173
+ "individual": {
174
+ "type": "object",
175
+ "title": "individual",
176
+ "description": "Contact information for a person.",
177
+ "example": "../../examples/contact.json#/0",
178
+ "translation": {
179
+ "ISO 19115-2": ["Contact > CI_ResponsibleParty"],
180
+ "FGDC CSDGM": ["cntinfo > cntperp"]
181
+ },
182
+ "required": ["individualName"],
183
+ "additionalProperties": true,
184
+ "properties": {
185
+ "individualName": {
186
+ "type": "string",
187
+ "description": "Name of the person – surname, given name, title separated by a delimiter.",
188
+ "translation": {
189
+ "ISO 19115-2": ["CI_ResponsibleParty > individualName"],
190
+ "FGDC CSDGM": ["cntinfo > cntperp > cntper"]
191
+ }
192
+ }
193
+ },
194
+ "allOf": [
195
+ {
196
+ "$ref": "#/definitions/baseContact"
197
+ }
198
+ ]
199
+ },
111
200
  "organization": {
112
201
  "type": "object",
113
202
  "title": "organization",
114
- "required": ["contactId", "organizationName"],
203
+ "example": "../../examples/contact.json#/1",
204
+ "translation": {
205
+ "ISO 19115-2": ["Contact > CI_ResponsibleParty"],
206
+ "FGDC CSDGM": ["cntinfo > cntorgp"]
207
+ },
208
+ "required": ["organizationName"],
115
209
  "additionalProperties": true,
116
210
  "properties": {
117
- "contactId": {
118
- "type": "string"
119
- },
120
- "positionName": {
121
- "type": "string"
122
- },
123
211
  "organizationName": {
124
- "type": "string"
125
- },
126
- "address": {
127
- "$ref": "#/definitions/address"
128
- },
129
- "onlineResource": {
130
- "type": "array",
131
- "items": {
132
- "$ref": "onlineResource.json#"
133
- },
134
- "uniqueItems": true
135
- },
136
- "contactInstructions": {
137
- "type": "string"
138
- },
139
- "phoneBook": {
140
- "type": "array",
141
- "items": {
142
- "$ref": "#/definitions/phone"
212
+ "type": "string",
213
+ "description": "Name of the organization.",
214
+ "translation": {
215
+ "ISO 19115-2": ["CI_ResponsibleParty > organisationName"],
216
+ "FGDC CSDGM": ["cntinfo > cntperp > cntorg"]
143
217
  }
144
218
  }
145
- }
219
+ },
220
+ "allOf": [
221
+ {
222
+ "$ref": "#/definitions/baseContact"
223
+ }
224
+ ]
146
225
  },
147
226
  "contactRef": {
148
227
  "type": "object",
@@ -150,10 +229,16 @@
150
229
  "required": ["contactId", "role"],
151
230
  "properties": {
152
231
  "contactId": {
153
- "type": "string"
232
+ "type": "string",
233
+ "description": "Identifier matching a contactId in the main contact array."
154
234
  },
155
235
  "role": {
156
- "type": "string"
236
+ "type": "string",
237
+ "description": "Function performed by the contact in the current context.",
238
+ "translation": {
239
+ "ISO 19115-2": ["MI_Metadata > Contact > CI_Contact > role [CI_RoleCode]"],
240
+ "FGDC CSDGM": ["metainfo > cntinfo > cntpos"]
241
+ }
157
242
  }
158
243
  }
159
244
  }
@@ -1,34 +1,63 @@
1
1
  {
2
2
  "id": "dataQuality.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
- "description": "schema for dataQuality",
5
4
  "type": "object",
5
+ "description": "Information about the quality of the resource.",
6
+ "translation": {
7
+ "ISO 19115-2": ["DQ_DataQuality"],
8
+ "FGDC CSDGM": ["dataqual"]
9
+ },
6
10
  "required": ["scope"],
7
11
  "additionalProperties": false,
8
12
  "properties": {
9
13
  "scope": {
10
- "type": "string"
14
+ "type": "string",
15
+ "description": "The scope to which the data quality information is applied, for instance; dataset, attribute, feature, series, etc.",
16
+ "translation": {
17
+ "ISO 19115-2": ["DQ_DataQuality > scope > DQ_Scope > level > MD_ScopeCode"]
18
+ }
11
19
  },
12
20
  "lineage": {
21
+ "translation": {
22
+ "ISO 19115-2": ["DQ_DataQuality > lineage > LI_Lineage"],
23
+ "FGDC CSDGM": ["dataqual > lineage"]
24
+ },
13
25
  "$ref": "#/definitions/lineage"
14
26
  }
15
27
  },
16
28
  "definitions": {
17
29
  "lineage": {
18
30
  "type": "object",
31
+ "description": "Non-quantitative quality information about the lineage of the resource as specified by the scope.",
32
+ "translation": {
33
+ "ISO 19115-2": ["LI_Lineage"]
34
+ },
19
35
  "additionalProperties": false,
20
36
  "properties": {
21
37
  "statement": {
22
- "type": "string"
38
+ "type": "string",
39
+ "description": "General explanation of the data producer’s knowledge about the lineage of a dataset.",
40
+ "translation": {
41
+ "ISO 19115-2": ["LI_Lineage > statement"]
42
+ }
23
43
  },
24
44
  "processStep": {
25
45
  "type": "array",
46
+ "description": "Process or methodology steps applied to development of the resource.",
47
+ "translation": {
48
+ "ISO 19115-2": ["LI_Lineage > processStep > LI_ProcessStep"]
49
+ },
26
50
  "items": {
27
51
  "$ref": "#/definitions/processStep"
28
52
  }
29
53
  },
30
54
  "source": {
31
55
  "type": "array",
56
+ "description": "Information about the source of the resource relative to the data quality scope.",
57
+ "translation": {
58
+ "ISO 19115-2": ["LI_Lineage > source > LI_Source"],
59
+ "FGDC CSDGM": ["dataqual > lineage > srcinfo"]
60
+ },
32
61
  "items": {
33
62
  "$ref": "#/definitions/source"
34
63
  }
@@ -37,23 +66,50 @@
37
66
  },
38
67
  "processStep": {
39
68
  "type": "object",
69
+ "description": "Process or methodology steps applied to development of the resource.",
70
+ "translation": {
71
+ "ISO 19115-2": ["LI_ProcessStep"]
72
+ },
40
73
  "required": ["description"],
41
74
  "additionalProperties": false,
42
75
  "properties": {
43
76
  "stepId": {
44
- "type": "string"
77
+ "type": "string",
78
+ "description": "Serial identifier used to order the sequence of steps used.",
79
+ "translation": {
80
+ "ISO 19115-2": ["LI_ProcessStep @ id"]
81
+ }
45
82
  },
46
83
  "description": {
47
- "type": "string"
84
+ "type": "string",
85
+ "description": "Description of the process or methodology step.",
86
+ "translation": {
87
+ "ISO 19115-2": ["LI_ProcessStep > description"],
88
+ "FGDC CSDGM": ["dataqual > lineage > procstep > procdesc"]
89
+ }
48
90
  },
49
91
  "rationale": {
50
- "type": "string"
92
+ "type": "string",
93
+ "description": "Requirement or purpose for the process or methodology step.",
94
+ "translation": {
95
+ "ISO 19115-2": ["LI_ProcessStep > rationale"]
96
+ }
51
97
  },
52
98
  "dateTime": {
99
+ "description": "Date and time or date at which the process or methodology step occurred.",
100
+ "translation": {
101
+ "ISO 19115-2": ["LI_ProcessStep > dateTime"],
102
+ "FGDC CSDGM": ["dataqual > lineage > procstep > procdate"]
103
+ },
53
104
  "$ref": "../schema.json#/definitions/date"
54
105
  },
55
106
  "processor": {
56
107
  "type": "array",
108
+ "description": "Identification of, and means of communication with, person(s) and organization(s) associated with the process or methodology step.",
109
+ "translation": {
110
+ "ISO 19115-2": ["LI_ProcessStep > processor > CI_ResponsibleParty"],
111
+ "FGDC CSDGM": ["dataqual > lineage > procstep > proccont > cntinfo"]
112
+ },
57
113
  "items": {
58
114
  "$ref": "contact.json#/definitions/contactRef"
59
115
  }
@@ -62,16 +118,33 @@
62
118
  },
63
119
  "source": {
64
120
  "type": "object",
121
+ "description": "Information about the source of the resource relative to the data lineage.",
122
+ "translation": {
123
+ "ISO 19115-2": ["LI_Source"]
124
+ },
65
125
  "additionalProperties": false,
66
126
  "properties": {
67
127
  "description": {
68
- "type": "string"
128
+ "type": "string",
129
+ "description": "Description of the source for the resource.",
130
+ "translation": {
131
+ "ISO 19115-2": ["LI_Source > description"]
132
+ }
69
133
  },
70
134
  "citation": {
135
+ "description": "Citation for the source.",
136
+ "translation": {
137
+ "ISO 19115-2": ["LI_Source > sourceCitation > CI_Citation"],
138
+ "FGDC CSDGM": ["dataqual > lineage > srcinfo > srccite > citeinfo"]
139
+ },
71
140
  "$ref": "citation.json#"
72
141
  },
73
142
  "processStep": {
74
143
  "type": "array",
144
+ "description": "Process or methodology steps applied to the development of the source.",
145
+ "translation": {
146
+ "ISO 19115-2": ["LI_Source > sourceStep > LI_ProcessStep"]
147
+ },
75
148
  "items": {
76
149
  "$ref": "#/definitions/processStep"
77
150
  }
@@ -1,38 +1,74 @@
1
1
  {
2
2
  "id": "distributor.json#",
3
3
  "$schema": "http://json-schema.org/draft-04/schema#",
4
- "description": "schema for a distributor entry",
5
4
  "type": "object",
5
+ "description": "Information about the distributor of and options for obtaining the resource.",
6
+ "translation": {
7
+ "ISO 19115-2": ["MD_Distribution"],
8
+ "FGDC CSDGM": ["distinfo"]
9
+ },
6
10
  "required": ["distributorContact"],
7
11
  "additionalProperties": false,
8
12
  "properties": {
9
13
  "distributorContact": {
14
+ "description": "Party from whom the resource may be obtained. Note: This list need not be exhaustive.",
15
+ "translation": {
16
+ "ISO 19115-2": ["MD_Distribution > distributor > MD_Distributor > distributorContact > CI_ResponsibleParty"],
17
+ "FGDC CSDGM": ["distinfo > distrib > cntinfo"]
18
+ },
10
19
  "$ref": "contact.json#/definitions/contactRef"
11
20
  },
12
21
  "distributionOrderProcess": {
13
22
  "type": "array",
23
+ "description": "Provides information about how the resource may be obtained and related instructions and fee information.",
24
+ "translation": {
25
+ "ISO 19115-2": ["MD_Distribution > distributor > MD_Distributor > distributionOrderProcess > MD_StandardOrderProcess"]
26
+ },
14
27
  "items": {
15
28
  "type": "object",
16
29
  "additionalProperties": false,
17
-
18
30
  "properties": {
19
31
  "fees": {
20
- "type": "string"
32
+ "type": "string",
33
+ "description": "Fees and terms for retrieving the resource, including monetary units.",
34
+ "translation": {
35
+ "ISO 19115-2": ["MD_StandardOrderProcess > fees"],
36
+ "FGDC CSDGM": ["distinfo > stdorder > fees"]
37
+ }
21
38
  },
22
39
  "plannedAvailabilityDateTime": {
40
+ "description": "Date and time when the resource will be available.",
41
+ "translation": {
42
+ "ISO 19115-2": ["MD_StandardOrderProcess > plannedAvailabilityDateTime"]
43
+ },
23
44
  "$ref": "../schema.json#/definitions/date"
24
45
  },
25
46
  "orderingInstructions": {
26
- "type": "string"
47
+ "type": "string",
48
+ "description": "General instructions, terms and services provided by the distributor.",
49
+ "translation": {
50
+ "ISO 19115-2": ["MD_StandardOrderProcess > orderingInstructions"],
51
+ "FGDC CSDGM": ["distinfo > stdorder > digform > digtopt > onlinopt > accinstr"]
52
+ }
27
53
  },
28
54
  "turnaround": {
29
- "type": "string"
55
+ "type": "string",
56
+ "description": "Typical turnaround time for the filling of an order.",
57
+ "translation": {
58
+ "ISO 19115-2": ["MD_StandardOrderProcess > turnaround"],
59
+ "FGDC CSDGM": ["distinfo > stdorder > turnarnd"]
60
+ }
30
61
  }
31
62
  }
32
63
  }
33
64
  },
34
65
  "distributorFormat": {
35
66
  "type": "array",
67
+ "description": "Provides information about the format used by the distributor.",
68
+ "translation": {
69
+ "ISO 19115-2": ["MD_Distribution > distributor > MD_Distributor > distributorFormat > MD_Format"],
70
+ "FGDC CSDGM": ["distinfo > stdorder > digform"]
71
+ },
36
72
  "items": {
37
73
  "$ref": "#/definitions/format"
38
74
  }
@@ -41,11 +77,21 @@
41
77
  "type": "array",
42
78
  "items": {
43
79
  "type": "object",
80
+ "description": "Identifier whether resource is available on-line or by off-line procedure.",
81
+ "translation": {
82
+ "ISO 19115-2": ["MD_Distributor > distributorTransferOptions > MD_DigitalTransferOptions"],
83
+ "FGDC CSDGM": ["distinfo > stdorder > digform > digtopt"]
84
+ },
44
85
  "additionalProperties": false,
45
86
 
46
87
  "properties": {
47
88
  "online": {
48
89
  "type": "array",
90
+ "description": "Information about obtaining the resource on-line.",
91
+ "translation": {
92
+ "ISO 19115-2": ["MD_DigitalTransferOptions > online > CI_OnlineResource"],
93
+ "FGDC CSDGM": ["distinfo > stdorder > digform > digtopt > onlinopt"]
94
+ },
49
95
  "items": {
50
96
  "$ref": "onlineResource.json#"
51
97
  },
@@ -53,17 +99,37 @@
53
99
  },
54
100
  "offline": {
55
101
  "type": "object",
102
+ "description": "Information about obtaining the resource through off-line procedure.",
103
+ "translation": {
104
+ "ISO 19115-2": ["MD_DigitalTransferOptions > offline > MD_Medium"],
105
+ "FGDC CSDGM": ["distinfo > stdorder > digform > digtopt > offoptn"]
106
+ },
56
107
  "additionalProperties": false,
57
108
 
58
109
  "properties": {
59
110
  "name": {
60
- "type": "string"
111
+ "type": "string",
112
+ "description": "Name of the format the data is distributed in, such as; dvd, hardcopy, etc.",
113
+ "translation": {
114
+ "ISO 19115-2": ["MD_Medium > name [MD_MediumNameCode]"],
115
+ "FGDC CSDGM": ["distinfo > stdorder > digform > digtopt > offoptn > offmedia"]
116
+ }
61
117
  },
62
118
  "mediumFormat": {
63
- "type": "string"
119
+ "type": "string",
120
+ "description": "Method used by the resource provider to write to the medium, such as; tar, iso9660, etc.",
121
+ "translation": {
122
+ "ISO 19115-2": ["MD_Medium > mediumFormat [MD_MediumFormatCode]"],
123
+ "FGDC CSDGM": ["distinfo > stdorder > digform > digtopt > offoptn > recfmt"]
124
+ }
64
125
  },
65
126
  "mediumNote": {
66
- "type": "string"
127
+ "type": "string",
128
+ "description": "Description of other limitations or requirements for using the medium.",
129
+ "translation": {
130
+ "ISO 19115-2": ["MD_Medium > mediumNote"],
131
+ "FGDC CSDGM": ["distinfo > stdorder > digform > digtopt > offoptn > compat"]
132
+ }
67
133
  }
68
134
  }
69
135
  }
@@ -74,14 +140,29 @@
74
140
  "definitions": {
75
141
  "format": {
76
142
  "type": "object",
143
+ "description": "Provides information about the format used by the distributor.",
144
+ "translation": {
145
+ "ISO 19115-2": ["MD_Format"],
146
+ "FGDC CSDGM": ["distinfo > stdorder > digform"]
147
+ },
77
148
  "required": ["formatName"],
78
149
  "additionalProperties": false,
79
150
  "properties": {
80
151
  "formatName": {
81
- "type": "string"
152
+ "type": "string",
153
+ "description": "Name of the data transfer format.",
154
+ "translation": {
155
+ "ISO 19115-2": ["MD_Format > name"],
156
+ "FGDC CSDGM": ["distinfo > stdorder > digform > digtinfo > formname"]
157
+ }
82
158
  },
83
159
  "version": {
84
- "type": "string"
160
+ "type": "string",
161
+ "description": "Version of the format (date, number, etc.)",
162
+ "translation": {
163
+ "ISO 19115-2": ["MD_Format > version"],
164
+ "FGDC CSDGM": ["idinfo > citation > citeinfo > edition"]
165
+ }
85
166
  }
86
167
  }
87
168
  }