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

Commit 6945364

Browse files
committed
adding describedBy and describedByType to schema
1 parent be7513f commit 6945364

File tree

1 file changed

+29
-10
lines changed

1 file changed

+29
-10
lines changed

Diff for: v1.1/schema.md

+29-10
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Agencies are encouraged to use the following expanded fields when appropriate. A
117117
Field | Label | Definition
118118
-------------- | -------------- | --------------
119119
theme | Category | Main thematic category of the dataset.
120-
dataDictionary | Data Dictionary | URL to the data dictionary for the dataset or API. Note that documentation other than a data dictionary can be referenced using Related Documents as shown in the expanded fields.
120+
describedBy | Data Dictionary | URL to the data dictionary for the dataset or API. Note that documentation other than a data dictionary can be referenced using Related Documents as shown in the expanded fields.
121121
dataQuality | Data Quality | Whether the dataset meets the agency's Information Quality Guidelines (true/false).
122122
accrualPeriodicity | Frequency | Frequency with which dataset is published.
123123
landingPage | Homepage URL | Alternative landing page used to redirect user to a contextual, Agency-hosted "homepage" for the Dataset or API when selecting this resource from the Data.gov user interface.
@@ -238,15 +238,6 @@ Dataset Fields {#Dataset}
238238
**Usage Notes** | This should be formatted per vCard specifications (see example below) and included with **fn** as part of a record's **contactPoint** (see above example).
239239
**Example** | `{"hasEmail": "mailto:[email protected]"}`
240240

241-
{: .table .table-striped #dataDictionary}
242-
**Field [#](#dataDictionary){: .permalink}** | **dataDictionary**
243-
----- | -----
244-
**Cardinality** | (0,1)
245-
**Required** | No (Documentation that is not specifically a data dictionary belongs in "references")
246-
**Accepted Values** | String (URL)
247-
**Usage Notes** | -
248-
**Example** | `{"dataDictionary":"http://www.agency.gov/vegetables/dictionary.html"}`
249-
250241
{: .table .table-striped #dataQuality}
251242
**Field [#](#dataQuality){: .permalink}** | **dataQuality**
252243
----- | -----
@@ -256,6 +247,16 @@ Dataset Fields {#Dataset}
256247
**Usage Notes** | Indicates whether a dataset conforms to the agency's information quality guidelines.
257248
**Example** | `{"dataQuality":true}`
258249

250+
{: .table .table-striped #dataset-describedBy}
251+
**Field [#](#dataset-describedBy){: .permalink}** | **describedBy**
252+
----- | -----
253+
**Cardinality** | (0,1)
254+
**Required** | No
255+
**Accepted Values** | String (URL)
256+
**Usage Notes** | This is used to specify a data dictionary or schema that defines fields or column headings in the dataset. If this is a machine readable file, it's recommended to be specified with [describedBy](#distribution-describedBy) at the distribution level along with the associated `describedByType`. At the dataset level it's assumed to be a human readable HTML webpage. Documentation that is not specifically a data dictionary belongs in "references"
257+
**Example** | `{"describedBy": "http://release.niem.gov/niem/domains/jxdm/4.1/jxdm.xsd"}`
258+
259+
259260
{: .table .table-striped #description}
260261
**Field [#](#description){: .permalink}** | **description**
261262
----- | -----
@@ -326,6 +327,24 @@ Dataset Fields {#Dataset}
326327
**Usage Notes** | This must be the **direct** download URL. Other means of accessing the dataset should be expressed using **accessURL**. This should always be accompanied by **mediaType**.
327328
**Example** | `{"downloadURL":"http://www.agency.gov/vegetables/listofvegetables.csv"}`
328329

330+
{: .table .table-striped .child-field #distribution-describedBy}
331+
**Field [#](#distribution-describedBy){: .permalink}** | **distribution → describedBy**
332+
----- | -----
333+
**Cardinality** | (0,1)
334+
**Required** | No
335+
**Accepted Values** | String (URL)
336+
**Usage Notes** | This is used to specify a data dictionary or schema that defines fields or column headings in the distribution. If this is a machine readable file the media type should be specified with `describedByType` - otherwise it's assumed to be a human readable HTML webpage.
337+
**Example** | `{"describedBy": "http://www.agency.gov/vegetables/schema.json"}`
338+
339+
{: .table .table-striped .child-field #distribution-describedByType}
340+
**Field [#](#distribution-describedByType){: .permalink}** | **distribution → describedByType**
341+
----- | -----
342+
**Cardinality** | (0,1)
343+
**Required** | No
344+
**Accepted Values** | String (URL)
345+
**Usage Notes** | This is used to identify the [media type](http://en.wikipedia.org/wiki/Internet_media_type) (MIME type) of the URL used for the distribution's `describedBy` field. This is especially important if `describedBy` is a machine readable file.
346+
**Example** | `{"describedByType": "application/schema+json"}`
347+
329348
{: .table .table-striped .child-field #distribution-description}
330349
**Field [#](#distribution-description){: .permalink}** | **distribution → description**
331350
----- | -----

0 commit comments

Comments
 (0)