Skip to content
This repository was archived by the owner on Jun 18, 2024. It is now read-only.

Commit 06e5d1f

Browse files
author
Haley Van Dyck
committed
Merge pull request #239 from project-open-data/making-arrays-consistent-in-examples
Made several corrections to the sample/template files and examples on the schema page
2 parents 5716b60 + 57ae64a commit 06e5d1f

5 files changed

+66
-64
lines changed

Diff for: ‎examples/catalog-sample-extended.json

+14-14
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
{
33
"title": "Data Catalog",
44
"description": "Version 1.0",
5-
"keyword": "catalog",
5+
"keyword": ["catalog"],
66
"modified": "2013-05-09",
77
"publisher": "US Department of X",
88
"contactPoint": "John Doe",
@@ -12,7 +12,7 @@
1212
"distribution": [
1313
{
1414
"accessURL": "http://agency.gov/data.json",
15-
"format": "json"
15+
"format": "application/json"
1616
}
1717
]
1818
},
@@ -26,13 +26,13 @@
2626
"mbox": "[email protected]",
2727
"identifier": "gov-doe-nces-1121",
2828
"accessLevel": "public",
29-
"bureauCode": "018:10",
30-
"programCode": "018:001",
29+
"bureauCode": ["018:10"],
30+
"programCode": ["018:001"],
3131
"accessLevelComment": "",
3232
"distribution": [
3333
{
3434
"accessURL": "https://explore.data.gov/views/ykv5-fn9t/rows.csv?accessType=DOWNLOAD",
35-
"format": "csv"
35+
"format": "text/csv"
3636
}
3737
],
3838
"webService": "http://explore.data.gov/api/views/ykv5-fn9t/rows.json",
@@ -44,7 +44,7 @@
4444
"dataQuality": true,
4545
"issued": "2011-11-22",
4646
"accrualPeriodicity": "annual",
47-
"language": "en-US",
47+
"language": ["en-US"],
4848
"primaryITInvestmentUII": "021-006227212",
4949
"references": ["http://nces.ed.gov/ccd/data/txt/psu091alay.html","http://nces.ed.gov/ccd/data/txt/psu091s23ay.doc"],
5050
"landingPage": "http://ed.gov/developer",
@@ -60,35 +60,35 @@
6060
"mbox": "[email protected]",
6161
"identifier": "gov-doe-nces-1120",
6262
"accessLevel": "public",
63-
"bureauCode": "018:10",
64-
"programCode": "018:001",
63+
"bureauCode": ["018:10"],
64+
"programCode": ["018:001"],
6565
"accessLevelComment": "",
6666
"distribution": [
6767
{
6868
"accessURL": "https://explore.data.gov/views/ykv5-fn9s/rows.csv?accessType=DOWNLOAD",
69-
"format": "csv"
69+
"format": "text/csv"
7070
},
7171
{
7272
"accessURL": "https://explore.data.gov/views/ykv5-fn9s/rows.json?accessType=DOWNLOAD",
73-
"format": "json"
73+
"format": "application/json"
7474
},
7575
{
7676
"accessURL": "https://explore.data.gov/views/ykv5-fn9s/rows.xml?accessType=DOWNLOAD",
77-
"format": "xml"
77+
"format": "application/xml"
7878
}
7979
],
8080
"webService": "http://explore.data.gov/api/views/ykv5-fn9s/rows.json",
8181
"license": "Public Domain",
8282
"spatial": "United States",
8383
"temporal": "2008-09-01T12:00:00Z/2009-05-31T12:00:00Z",
84-
"theme": "education",
84+
"theme": ["education"],
8585
"dataDictionary": "http://nces.ed.gov/ccd/pdf/INsc09101a.pdf",
8686
"dataQuality": true,
8787
"issued": "2010-11-22",
8888
"accrualPeriodicity": "annual",
89-
"language": "en-US",
89+
"language": ["en-US"],
9090
"primaryITInvestmentUII": "021-006227212",
91-
"references": "http://nces.ed.gov/ccd/data/txt/psu091alay.txt",
91+
"references": ["http://nces.ed.gov/ccd/data/txt/psu091alay.txt"],
9292
"landingPage": "http://ed.gov/developer",
9393
"systemOfRecords": "http://nces.ed.gov/ccd/"
9494
}]

Diff for: ‎examples/catalog-sample.json

+13-10
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,18 @@
22
{
33
"title": "Data Catalog",
44
"description": "Version 1.0",
5-
"keyword": "catalog",
5+
"keyword": ["catalog"],
66
"modified": "2013-05-09",
77
"publisher": "US Department of X",
88
"contactPoint": "John Doe",
99
"mbox": "[email protected]",
1010
"identifier": "1",
1111
"accessLevel": "public",
12-
"accessURL": "http://agency.gov/data.json",
13-
"format": "json"
12+
"bureauCode": ["018:10"],
13+
"programCode": ["018:001"],
14+
"accessURL": "http://agency.gov/data.json",
15+
"format": "application/json"
16+
1417
},
1518
{
1619
"title": "Public Elementary/Secondary Listing",
@@ -25,8 +28,8 @@
2528
"bureauCode": "018:10",
2629
"programCode": "018:001",
2730
"accessLevelComment": "",
28-
"accessURL": "https://explore.data.gov/views/ykv5-fn9t/rows.csv?accessType=DOWNLOAD",
29-
"format": "csv",
31+
"accessURL": "https://explore.data.gov/views/ykv5-fn9t/rows.csv?accessType=DOWNLOAD",
32+
"format": "text/csv",
3033
"webService": "http://explore.data.gov/api/views/ykv5-fn9t/rows.json",
3134
"license": "Public Domain",
3235
"spatial": "United States",
@@ -42,21 +45,21 @@
4245
"mbox": "[email protected]",
4346
"identifier": "gov-doe-nces-1120",
4447
"accessLevel": "public",
45-
"bureauCode": "018:10",
46-
"programCode": "018:001",
48+
"bureauCode": ["018:10"],
49+
"programCode": ["018:001"],
4750
"accessLevelComment": "",
4851
"distribution": [
4952
{
5053
"accessURL": "https://explore.data.gov/views/ykv5-fn9s/rows.csv?accessType=DOWNLOAD",
51-
"format": "csv"
54+
"format": "text/csv"
5255
},
5356
{
5457
"accessURL": "https://explore.data.gov/views/ykv5-fn9s/rows.json?accessType=DOWNLOAD",
55-
"format": "json"
58+
"format": "application/json"
5659
},
5760
{
5861
"accessURL": "https://explore.data.gov/views/ykv5-fn9s/rows.xml?accessType=DOWNLOAD",
59-
"format": "xml"
62+
"format": "application/xml"
6063
}
6164
],
6265
"webService": "http://explore.data.gov/api/views/ykv5-fn9s/rows.json",

Diff for: ‎examples/catalog-template-extended.json

+13-11
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22
{
33
"title": "Data Catalog",
44
"description": "Version 1.0",
5-
"keyword": "catalog",
5+
"keyword": ["catalog"],
66
"modified": "",
77
"publisher": "",
88
"contactPoint": "",
99
"mbox": "",
1010
"identifier": "",
1111
"accessLevel": "public",
12+
"bureauCode": [""],
13+
"programCode": [""],
1214
"distribution": [
1315
{
1416
"accessURL": "",
15-
"format": "json"
17+
"format": "application/json"
1618
}
1719
]
1820
},
@@ -26,8 +28,8 @@
2628
"mbox": "",
2729
"identifier": "",
2830
"accessLevel": "",
29-
"bureauCode": "",
30-
"programCode": "",
31+
"bureauCode": [""],
32+
"programCode": [""],
3133
"accessLevelComment": "",
3234
"distribution": [
3335
{
@@ -39,12 +41,12 @@
3941
"license": "",
4042
"spatial": "",
4143
"temporal": "",
42-
"theme": "",
44+
"theme": [""],
4345
"dataDictionary": "",
4446
"dataQuality": ,
4547
"issued": "",
4648
"accrualPeriodicity": "",
47-
"language": "",
49+
"language": [""],
4850
"primaryITInvestmentUII": "",
4951
"references": ["",""],
5052
"landingPage": "",
@@ -60,8 +62,8 @@
6062
"mbox": "",
6163
"identifier": "",
6264
"accessLevel": "",
63-
"bureauCode": "",
64-
"programCode": "",
65+
"bureauCode": [""],
66+
"programCode": [""],
6567
"accessLevelComment": "",
6668
"distribution": [
6769
{
@@ -81,14 +83,14 @@
8183
"license": "",
8284
"spatial": "",
8385
"temporal": "",
84-
"theme": "",
86+
"theme": [""],
8587
"dataDictionary": "",
8688
"dataQuality": ,
8789
"issued": "",
8890
"accrualPeriodicity": "",
89-
"language": "",
91+
"language": [""],
9092
"primaryITInvestmentUII": "",
91-
"references": "",
93+
"references": [""],
9294
"landingPage": "",
9395
"systemOfRecords": ""
9496
}]

Diff for: ‎examples/catalog-template.json

+11-9
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22
{
33
"title": "Data Catalog",
44
"description": "Version 1.0",
5-
"keyword": "catalog",
5+
"keyword": ["catalog"],
66
"modified": "",
77
"publisher": "",
88
"contactPoint": "",
99
"mbox": "",
1010
"identifier": "",
1111
"accessLevel": "",
12-
"accessURL": "",
13-
"format": "json"
12+
"bureauCode": [""],
13+
"programCode": [""],
14+
"accessURL": "",
15+
"format": "application/json"
1416
},
1517
{
1618
"title": "",
@@ -22,11 +24,11 @@
2224
"mbox": "",
2325
"identifier": "",
2426
"accessLevel": "",
25-
"bureauCode": "",
26-
"programCode": "",
27+
"bureauCode": [""],
28+
"programCode": [""],
2729
"accessLevelComment": "",
28-
"accessURL": "",
29-
"format": "",
30+
"accessURL": "",
31+
"format": "",
3032
"webService": "",
3133
"license": "",
3234
"spatial": "",
@@ -42,8 +44,8 @@
4244
"mbox": "",
4345
"identifier": "",
4446
"accessLevel": "",
45-
"bureauCode": "",
46-
"programCode": "",
47+
"bureauCode": [""],
48+
"programCode": [""],
4749
"accessLevelComment": "",
4850
"distribution": [
4951
{

Diff for: ‎schema.md

+15-20
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Further Metadata Field Guidance (alphabetical by JSON field)
142142
**Required** | Yes, for United States Federal Government agencies
143143
**Accepted Values** | Array of Strings
144144
**Usage Notes** | Represent each bureau responsible for the dataset according to the codes found in [OMB Circular A-11, Appendix C](http://www.whitehouse.gov/sites/default/files/omb/assets/a11_current_year/app_c.pdf). Start with the agency code, then a colon, then the bureau code.
145-
**Example** | The Office of the Solicitor (86) at the Department of the Interior (010) would be: {"bureauCode":["010:86"]}
145+
**Example** | The Office of the Solicitor (86) at the Department of the Interior (010) would be: `{"bureauCode":["010:86"]}`. If a second bureau was also responsible, the format like this: `{"bureauCode":["010:86","010:04"]}`.
146146

147147
{: .table .table-striped}
148148
**Field** | **contactPoint**
@@ -190,16 +190,16 @@ Further Metadata Field Guidance (alphabetical by JSON field)
190190

191191
"distribution": [
192192
{
193-
"accessURL": "https://explore.data.gov/views/ykv5-fn9t/rows.csv?accessType=DOWNLOAD",
194-
"format": "text/csv"
193+
"accessURL":"https://explore.data.gov/views/ykv5-fn9t/rows.csv?accessType=DOWNLOAD",
194+
"format":"text/csv"
195195
},
196196
{
197-
"accessURL": "https://explore.data.gov/views/ykv5-fn9t/rows.json?accessType=DOWNLOAD",
198-
"format": "application/json"
197+
"accessURL":"https://explore.data.gov/views/ykv5-fn9t/rows.json?accessType=DOWNLOAD",
198+
"format":"application/json"
199199
},
200200
{
201-
"accessURL": "https://explore.data.gov/views/ykv5-fn9t/rows.xml?accessType=DOWNLOAD",
202-
"format": "text/xml"
201+
"accessURL":"https://explore.data.gov/views/ykv5-fn9t/rows.xml?accessType=DOWNLOAD",
202+
"format":"text/xml"
203203
}
204204
]
205205
@@ -210,7 +210,7 @@ Further Metadata Field Guidance (alphabetical by JSON field)
210210
**Required** | Yes, if the file is available for public download.
211211
**Accepted Values** | String
212212
**Usage Notes** | This must describe the exact files available at **accessURL** using [MIME Types](http://en.wikipedia.org/wiki/Internet_media_type).
213-
**Example** | `{"format": "application/json"}`
213+
**Example** | `{"format":"application/json"}`
214214

215215
{: .table .table-striped}
216216
**Field** | **identifier**
@@ -237,7 +237,7 @@ Further Metadata Field Guidance (alphabetical by JSON field)
237237
**Required** | Yes, always
238238
**Accepted Values** | Array of strings
239239
**Usage Notes** | Surround each keyword with quotes. Separate keywords with commas.
240-
**Example** | `{"keyword": ["vegetables","veggies","greens","leafy","spinach","kale","nutrition"]}`
240+
**Example** | `{"keyword":["vegetables","veggies","greens","leafy","spinach","kale","nutrition"]}`
241241

242242
{: .table .table-striped}
243243
**Field** | **landingPage**
@@ -254,8 +254,8 @@ Further Metadata Field Guidance (alphabetical by JSON field)
254254
**Cardinality** | (0,n)
255255
**Required** | No
256256
**Accepted Values** | Array of strings
257-
**Usage Notes** | This should adhere to the [RFC 5646](http://tools.ietf.org/html/rfc5646) standard. http://rishida.net/utils/subtags/ provides a good tool for checking and verifying language codes. A language tag is comprised of either one or two parts, the language subtag (such as en for English, sp for Spanish, wo for Wolof) and the regional subtag (such as US for United States, GB for Great Britain, MX for Mexico), separated by a hyphen. Regional subtags should only be provided when needed to distinguish a language tag from another one (such as American vs. British English).
258-
**Examples** | `{"language":["es-MX", "wo", "nv", "en-US"]}`
257+
**Usage Notes** | This should adhere to the [RFC 5646](http://tools.ietf.org/html/rfc5646) standard. This [language subtag lookup](http://rishida.net/utils/subtags/) provides a good tool for checking and verifying language codes. A language tag is comprised of either one or two parts, the language subtag (such as en for English, sp for Spanish, wo for Wolof) and the regional subtag (such as US for United States, GB for Great Britain, MX for Mexico), separated by a hyphen. Regional subtags should only be provided when needed to distinguish a language tag from another one (such as American vs. British English).
258+
**Example** | `{"language":["en-US"]}` or if multiple languages, `{"language":["es-MX","wo","nv","en-US"]}`
259259

260260
{: .table .table-striped}
261261
**Field** | **license**
@@ -300,7 +300,7 @@ Further Metadata Field Guidance (alphabetical by JSON field)
300300
**Required** | Yes, for United States Federal Government Agencies
301301
**Accepted Values** | Array of strings
302302
**Usage Notes** | Provide an array of programs related to this data asset, from the [Federal Program Inventory](http://goals.performance.gov/sites/default/files/images/FederalProgramInventory_FY13_MachineReadable_091613.xls).
303-
**Example** | `{"programCode":["015:001”, “015:002”]}`
303+
**Example** | `{"programCode":["015:001"]}` or if multiple programs, `{"programCode":["015:001","015:002"]}`
304304

305305
{: .table .table-striped}
306306
**Field** | **publisher**
@@ -318,7 +318,7 @@ Further Metadata Field Guidance (alphabetical by JSON field)
318318
**Required** | No
319319
**Accepted Values** | Array of strings (URLs)
320320
**Usage Notes** | Enclose each URL within strings. Separate multiple URLs with a comma.
321-
**Example** | `{"references":["http://www.agency.gov/legumes/legumes_data_documentation.html", "http://www.agency.gov/fruits/fruit_data_documentation.html"]}`
321+
**Example** | `{"references":["http://www.agency.gov/legumes/legumes_data_documentation.html"]}` or if multiple URLs, `{"references":["http://www.agency.gov/legumes/legumes_data_documentation.html","http://www.agency.gov/fruits/fruit_data_documentation.html"]}`
322322

323323
{: .table .table-striped}
324324
**Field** | **spatial**
@@ -345,7 +345,7 @@ Further Metadata Field Guidance (alphabetical by JSON field)
345345
**Required** | No
346346
**Accepted Values** | Array of strings
347347
**Usage Notes** | Separate multiple categories with a comma. Could include [ISO Topic Categories](http://www.isotopicmaps.org/).
348-
**Example** | `{"theme":["vegetables","produce"]}`
348+
**Example** | `{"theme":["vegetables"]}` or if muplitle categories, `{"theme":["vegetables","produce"]}`
349349

350350
{: .table .table-striped}
351351
**Field** | **title**
@@ -390,10 +390,5 @@ Additional Information
390390
* [Schema.org](http://schema.org)
391391
* [DCAT](http://www.w3.org/TR/vocab-dcat/)
392392
* [Vocab.Data.gov](http://vocab.data.gov)
393+
* [Template and Sample Files (CSV and JSON format)](/metadata-resources/)
393394

394-
395-
Examples
396-
--------
397-
* [JSON](/metadata-resources/)
398-
* [RDFa Lite](/metadata-resources/)
399-
* [XML](/metadata-resources/)

0 commit comments

Comments
 (0)