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

Commit 9a1176b

Browse files
author
Haley Van Dyck
committed
Merge pull request #148 from seanherron/schema_formatting
Schema formatting
2 parents 722f79d + 992295f commit 9a1176b

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Diff for: schema.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ The following fields must be used to describe each dataset if they are applicabl
6262
{: .table .table-striped}
6363
Field | Definition |JSON
6464
------- | --------------- | --------------
65-
Bureau Code | Federal agencies, combined agency and bureau code from [OMB Circular A-11, Appendix C](http://www.whitehouse.gov/sites/default/files/omb/assets/a11_current_year/app_c.pdf) in the format of 015:010. | bureauCode
66-
Program Code | Federal agencies, list the primary program related to this data asset, from the [Federal Program Inventory](http://goals.performance.gov/sites/default/files/images/FederalProgramInventory_FY13_MachineReadable_091613.xls). Use the format of 015:001"" | programCode
65+
Bureau Code | Federal agencies, combined agency and bureau code from [OMB Circular A-11, Appendix C](http://www.whitehouse.gov/sites/default/files/omb/assets/a11_current_year/app_c.pdf) in the format of `015:010`. | bureauCode
66+
Program Code | Federal agencies, list the primary program related to this data asset, from the [Federal Program Inventory](http://goals.performance.gov/sites/default/files/images/FederalProgramInventory_FY13_MachineReadable_091613.xls). Use the format of `015:001` | programCode
6767
Access Level Comment | An explanation for the selected “accessLevel” including instructions for how to access a restricted file, if applicable, or explanation for why a “non-public” or “restricted public” data assetis not “public,” if applicable. Text, 255 characters. | accessLevelComment
6868
Download URL | URL providing direct access to the downloadable distribution of a dataset. | accessURL
6969
Endpoint | Endpoint of web service to access dataset. | webService
@@ -150,8 +150,8 @@ Further Metadata Field Guidance
150150
**Cardinality** | (1,1)
151151
**Required** | Yes, always
152152
**Accepted Values** | String
153-
**Usage Notes** |
154-
**Example** | `{"contactPoint":"John Brown"}`
153+
**Usage Notes** | -
154+
**Example** | `{"contactPoint":"John Brown"}`
155155

156156
{: .table .table-striped}
157157
**Field** | **dataDictionary**
@@ -209,8 +209,8 @@ Further Metadata Field Guidance
209209
**Cardinality** | (0,1)
210210
**Required** | Yes, if the file is available for public download.
211211
**Accepted Values** | String
212-
**Usage Notes** | This must describe the exact files available at **accessURL** using [MIME Types](http://en.wikipedia.org/wiki/Internet_media_type), represented as a list.
213-
**Example** | `{"format": ['application/json'] }` `{"format": ['application/json', 'application/pdf', application/zip']}
212+
**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"}`
214214

215215
{: .table .table-striped}
216216
**Field** | **identifier**
@@ -255,7 +255,7 @@ Further Metadata Field Guidance
255255
**Required** | No
256256
**Accepted Values** | Array of strings
257257
**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":["en-US"]}` `{"language":["en-GB"]}` `{"language":["jp"]}` `{"language":["es-MX"], ["wo"], ["nv"], ["en-US"]}`
258+
**Examples** | `{"language":["es-MX"], ["wo"], ["nv"], ["en-US"]}`
259259

260260
{: .table .table-striped}
261261
**Field** | **license**
@@ -309,7 +309,7 @@ Further Metadata Field Guidance
309309
**Required** | Yes, for United States Federal Government Agencies
310310
**Accepted Values** | Array of strings
311311
**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).
312-
**Example** | {"programCode":["015:001”, “015:002”]}
312+
**Example** | `{"programCode":["015:001”, “015:002”]}`
313313

314314
{: .table .table-striped}
315315
**Field** | **references**
@@ -396,4 +396,4 @@ Examples
396396
--------
397397
* [JSON](/metadata-resources/)
398398
* [RDFa Lite](/metadata-resources/)
399-
* [XML](/metadata-resources/)
399+
* [XML](/metadata-resources/)

0 commit comments

Comments
 (0)