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

Commit b7c1011

Browse files
author
Haley Van Dyck
committed
Merge pull request #262 from project-open-data/mime-and-temporal-schema-clarifications
Mime and temporal schema clarifications
2 parents f646ede + 97ecb2f commit b7c1011

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

Diff for: schema.md

+14-8
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ Further Metadata Field Guidance (alphabetical by JSON field)
211211
**Cardinality** | (0,1)
212212
**Required** | Yes, if the file is available for public download.
213213
**Accepted Values** | String
214-
**Usage Notes** | This must describe the exact files available at **accessURL** using [MIME Types](http://en.wikipedia.org/wiki/Internet_media_type).
214+
**Usage Notes** | This must describe the exact files available at **accessURL** using [MIME Types](http://en.wikipedia.org/wiki/Internet_media_type). _[Also note [Office Open XML MIME types](http://blogs.msdn.com/b/vsofficedeveloper/archive/2008/05/08/office-2007-open-xml-mime-types.aspx)]_
215215
**Example** | `{"format":"application/json"}`
216216

217217
{: .table .table-striped}
@@ -229,7 +229,7 @@ Further Metadata Field Guidance (alphabetical by JSON field)
229229
**Cardinality** | (0,1)
230230
**Required** | No
231231
**Accepted Values** | ISO 8601 Date
232-
**Usage Notes** | Dates should be [ISO 8601](http://www.w3.org/TR/NOTE-datetime) of least resolution. In other words, as much of YYYY-MM-DDThh:mm:ss.sTZD as is relevant to this dataset.
232+
**Usage Notes** | Dates should be [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) of least resolution. In other words, as much of YYYY-MM-DDThh:mm:ss.sTZD as is relevant to this dataset.
233233
**Example** | `{"issued":"2001-01-15"}`
234234

235235
{: .table .table-striped}
@@ -283,8 +283,10 @@ Further Metadata Field Guidance (alphabetical by JSON field)
283283
**Cardinality** | (1,1)
284284
**Required** | Yes, always
285285
**Accepted Values** | ISO 8601 Date
286-
**Usage Notes** | Dates should be [ISO 8601](http://www.w3.org/TR/NOTE-datetime) of least resolution. In other words, as much of YYYY-MM-DDThh:mm:ss.sTZD as is relevant to this dataset. If this file is brand-new, enter the **issued** date here as well.
287-
**Example** | `{"modified":"2012-01-15"}`
286+
**Usage Notes** | Dates should be [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) of least resolution. In other words, as much of YYYY-MM-DDThh:mm:ss.sTZD as is relevant to this dataset. If this file is brand-new, enter the **issued** date here as well.
287+
288+
If there is a need to reflect that the dataset is continually updated, ISO 8601 formatting can account for this by [giving the duration](http://en.wikipedia.org/wiki/ISO_8601#Durations). For instance, `P1D` for daily, `P2W` for every two weeks, and `PT5M` for every five minutes.
289+
**Example** | `{"modified":"2012-01-15"}` or `{"modified":"P1D"}`
288290

289291
{: .table .table-striped}
290292
**Field** | **PrimaryITInvestmentUII**
@@ -336,9 +338,13 @@ Further Metadata Field Guidance (alphabetical by JSON field)
336338
----- | -----
337339
**Cardinality** | (0,1)
338340
**Required** | Yes, if applicable
339-
**Accepted Values** | See Usage Notes
340-
**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 that datetimes can be formatted in a number of ways, including a simple four-digit year (eg. 2013) to a much more specific YYYY-MM-DDTHH:MM:SSZ, 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). Use a solidus ("/") to separate start and end times.
341-
**Example** | `{"temporal":"2000-01-15T00:45:00Z/2010-01-15T00:06:00Z"}`
341+
**Accepted Values** | ISO 8601 Date
342+
**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](http://en.wikipedia.org/wiki/ISO_8601) format. ISO 8601 specifies that datetimes can be formatted in a number of ways, including a simple four-digit year (eg. 2013) to a much more specific YYYY-MM-DDTHH:MM:SSZ, 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). Use a solidus ("/") to separate start and end times.
343+
344+
If there is a need to reflect that the dataset is continually updated, ISO 8601 formatting can account for this [with repeating intervals](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals). For instance, updated monthly starting in January 2010 and continuing through the present would be represented as: `R/2010-01/P1M`.
345+
346+
Updated every 5 minutes beginning on February 15, 2010 would be represented as: `R/2010-02-15/PT5M`.
347+
**Example** | `{"temporal":"2000-01-15T00:45:00Z/2010-01-15T00:06:00Z"}` or `{"temporal":"R/2000-01-15T00:45:00Z/P1W"}`
342348

343349
{: .table .table-striped}
344350
**Field** | **theme**
@@ -347,7 +353,7 @@ Further Metadata Field Guidance (alphabetical by JSON field)
347353
**Required** | No
348354
**Accepted Values** | Array of strings
349355
**Usage Notes** | Separate multiple categories with a comma. Could include [ISO Topic Categories](http://www.isotopicmaps.org/).
350-
**Example** | `{"theme":["vegetables"]}` or if muplitle categories, `{"theme":["vegetables","produce"]}`
356+
**Examples** | `{"theme":["vegetables"]}` or if multiple categories, `{"theme":["vegetables","produce"]}`
351357

352358
{: .table .table-striped}
353359
**Field** | **title**

0 commit comments

Comments
 (0)