From 11d418268971bc0f95674b49f2a1febaebe84e28 Mon Sep 17 00:00:00 2001 From: Sean Herron Date: Fri, 5 Jul 2013 15:37:49 -0400 Subject: [PATCH 1/3] Edited schema to express temporal ranges in ISO 8601 format --- schema.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/schema.md b/schema.md index 0da3e565..27d81fd3 100644 --- a/schema.md +++ b/schema.md @@ -236,8 +236,8 @@ Field | title **Cardinality** | (0,1) **Required** | Yes, if applicable **Accepted Values** | See Usage Notes -**Usage Notes** | This field should contain an interval of time defined by start and end dates. Dates should be formatted as pairs of {start date, end date} in the format YYYY-MM-DD hh:mm:ss using 24 hour clock time notation (e.g., 2011-02-14 12:00:00, 2013-02-14 12:00:00). -**Example** | `{"temporal":"2000-01-15 00:45:00,2010-01-15 00:06:00"}` +**Usage Notes** | This field should contain an interval of time defined by start and end dates. Dates should be formatted as pairs of {start datetime/end datetime} in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. ISO 8601 specifies datetimes to be formatted as YYY-MM-DDT12:46:14Z, where the T specifies a seperator between the date and time and time is expressed in 24 hour notation in the UTC (Zulu) time zone. (e.g., 2011-02-14T12:00:00Z/2013-07-04T19:34:00Z). +**Example** | `{"temporal":"2000-01-15T00:45:00Z/2010-01-15T00:06:00Z"}` {.table .table-striped} **Field** | **issued** From a0fa7bf0e4b791457b5132ccdc843d17c923a719 Mon Sep 17 00:00:00 2001 From: Sean Herron Date: Fri, 5 Jul 2013 16:10:05 -0400 Subject: [PATCH 2/3] Edited accrualPeriodicity to align with Dublin Core acceptable values --- schema.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/schema.md b/schema.md index 27d81fd3..2b716575 100644 --- a/schema.md +++ b/schema.md @@ -253,9 +253,9 @@ Field | title ----- | ----- **Cardinality** | (0,1) **Required** | No -**Accepted Values** | Must be one of the following: hourly, daily, weekly, yearly, other +**Accepted Values** | Must be one of the following: Annual, Bimonthly, Semiweekly, Daily, Biweekly, Semiannual, Biennial, Triennial, Three times a week, Three times a month, Continuously updated, Monthly, Quarterly, Semimonthly, Three times a year, Weekly, Completely irregular **Usage Notes** | - -**Example** | `{"accrualPeriodicity":"yearly"}` +**Example** | `{"accrualPeriodicity":"annual"}` {.table .table-striped} **Field** | **language** From 992295f6f65112aa8eac5a71ec11ec46866e1134 Mon Sep 17 00:00:00 2001 From: Sean Herron Date: Fri, 20 Sep 2013 23:33:51 -0400 Subject: [PATCH 3/3] fixed table and MIME type issues --- schema.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/schema.md b/schema.md index 54fc0901..43479452 100644 --- a/schema.md +++ b/schema.md @@ -62,8 +62,8 @@ The following fields must be used to describe each dataset if they are applicabl {: .table .table-striped} Field | Definition |JSON ------- | --------------- | -------------- -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 -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 +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 +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 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 Download URL | URL providing direct access to the downloadable distribution of a dataset. | accessURL Endpoint | Endpoint of web service to access dataset. | webService @@ -150,8 +150,8 @@ Further Metadata Field Guidance **Cardinality** | (1,1) **Required** | Yes, always **Accepted Values** | String -**Usage Notes** | -**Example** | `{"contactPoint":"John Brown"}` +**Usage Notes** | - +**Example** | `{"contactPoint":"John Brown"}` {: .table .table-striped} **Field** | **dataDictionary** @@ -209,8 +209,8 @@ Further Metadata Field Guidance **Cardinality** | (0,1) **Required** | Yes, if the file is available for public download. **Accepted Values** | String -**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. -**Example** | `{"format": ['application/json'] }` `{"format": ['application/json', 'application/pdf', application/zip']} +**Usage Notes** | This must describe the exact files available at **accessURL** using [MIME Types](http://en.wikipedia.org/wiki/Internet_media_type). +**Example** | `{"format": "application/json"}` {: .table .table-striped} **Field** | **identifier** @@ -255,7 +255,7 @@ Further Metadata Field Guidance **Required** | No **Accepted Values** | Array of strings **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). -**Examples** | `{"language":["en-US"]}` `{"language":["en-GB"]}` `{"language":["jp"]}` `{"language":["es-MX"], ["wo"], ["nv"], ["en-US"]}` +**Examples** | `{"language":["es-MX"], ["wo"], ["nv"], ["en-US"]}` {: .table .table-striped} **Field** | **license** @@ -309,7 +309,7 @@ Further Metadata Field Guidance **Required** | Yes, for United States Federal Government Agencies **Accepted Values** | Array of strings **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). -**Example** | {"programCode":["015:001”, “015:002”]} +**Example** | `{"programCode":["015:001”, “015:002”]}` {: .table .table-striped} **Field** | **references**