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

Commit 10813c3

Browse files
author
jlberryhill
committed
Merge pull request #414 from project-open-data/v1-1-schema-date-clarification
Clarifying terminology for different date fields
2 parents 248c652 + f55b98b commit 10813c3

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Diff for: v1.1/schema.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ Dataset Fields {#Dataset}
284284
**Cardinality** | (0,1)
285285
**Required** | No
286286
**Accepted Values** | ISO 8601 Repeating Duration (or `irregular`)
287-
**Usage Notes** | Must be an ISO 8601 repeating duration unless this is not possible because the accrual periodicity is completely irregular, in which case the value should simply be `irregular`. The value should not include a start or end date but rather simply express the duration of time between data publishing. For example, a dataset which is updated on an annual basis would be `R/P1Y`; every three months would be `R/P3M`; weekly would be `R/P1W`; and daily would be `R/P1D`. Further examples and documenation [can be found here](/iso8601_guidance#accrualperiodicity).
287+
**Usage Notes** | Must be an ISO 8601 repeating duration unless this is not possible because the accrual periodicity is completely irregular, in which case the value should simply be `irregular`. The value should not include a start or end date but rather simply express the duration of time between data publishing. For example, a dataset which is published on an annual basis would be `R/P1Y`; every three months would be `R/P3M`; weekly would be `R/P1W`; and daily would be `R/P1D`. Further examples and documenation [can be found here](/iso8601_guidance#accrualperiodicity).
288288
**Example** | `{"accrualPeriodicity":"R/P1Y"}`
289289

290290
{: .table .table-striped #bureauCode}
@@ -595,8 +595,8 @@ Dataset Fields {#Dataset}
595595
**Cardinality** | (1,1)
596596
**Required** | Yes, always
597597
**Accepted Values** | ISO 8601 Date
598-
**Usage Notes** | Dates should be [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) of highest 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. 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, `R/P1D` for daily, `R/P2W` for every two weeks, and `R/PT5M` for every five minutes.
599-
+**Example** | `{"modified":"2012-01-15"}` or `{"modified":"R/P1D"}
598+
**Usage Notes** | Dates should be [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) of highest resolution. In other words, as much of YYYY-MM-DDThh:mm:ss.sTZD as is relevant to this dataset. 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, `R/P1D` for daily, `R/P2W` for every two weeks, and `R/PT5M` for every five minutes.
599+
+**Example** | `{"modified":"2012-01-15"}` or `{"modified":"R/P1D"}`
600600

601601
{: .table .table-striped #primaryITInvestmentUII}
602602
**Field [#](#primaryITInvestmentUII){: .permalink}** | **primaryITInvestmentUII**
@@ -715,8 +715,8 @@ Dataset Fields {#Dataset}
715715
**Cardinality** | (0,1)
716716
**Required** | Yes, if applicable
717717
**Accepted Values** | ISO 8601 Date
718-
**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. 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`. Updated every 5 minutes beginning on February 15, 2010 would be represented as: `R/2010-02-15/PT5M`.
719-
**Example** | `{"temporal":"2000-01-15T00:45:00Z/2010-01-15T00:06:00Z"}` or `{"temporal":"R/2000-01-15T00:45:00Z/P1W"}`
718+
**Usage Notes** | This field should contain an interval of time defined by the start and end dates for which the dataset is applicable. 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. If there is a need to define the start or end of applicability using a duration rather than a date, ISO 8601 formatting can account for this [with duration based intervals](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals). For instance, applicability starting in January 2010 and continuing for one month could be represented as `2010-01/P1M` or `2010-01/2010-02`. However, when possible, full dates are preferred for both start and end times.
719+
**Example** | `{"temporal":"2000-01-15T00:45:00Z/2010-01-15T00:06:00Z"}` or `{"temporal":"2000-01-15T00:45:00Z/P1W"}`
720720

721721
{: .table .table-striped #theme}
722722
**Field [#](#theme){: .permalink}** | **theme**
@@ -771,4 +771,4 @@ Additional Information
771771
----------------------
772772

773773
* [Template and Sample Files (CSV and JSON format)](/v1.1/metadata-resources/)
774-
* [DCAT](http://www.w3.org/TR/vocab-dcat/)
774+
* [DCAT](http://www.w3.org/TR/vocab-dcat/)

0 commit comments

Comments
 (0)