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

Commit b3c27ac

Browse files
author
Rebecca Williams
committed
added table for new catalog requirements
1 parent a333039 commit b3c27ac

File tree

1 file changed

+51
-53
lines changed

1 file changed

+51
-53
lines changed

Diff for: ‎v1.1/schema.md

+51-53
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,15 @@ The Project Open Data schema is case sensitive. The schema uses a camel case con
5454
Links to downloadable examples of metadata files developed in this and other formats in [the metadata resources](/metadata-resources/). Tools to help agencies produce and maintain their data inventories are [available on GitHub](http://www.github.com/project-open-data) and hosted at [Labs.Data.gov](http://labs.data.gov).
5555

5656

57-
Schema Version Declaration (Required)
58-
-----------------------------
59-
In order to distinguish the schema version being used publishers are required to specify the relevant URI using the `conformsTo` field at the beginning of their data.json file. Version 1.1 of the schema should be identified with the following URI: http://project-open-data.cio.gov/v1.1/schema. Optionally, publishers may also use the `describedBy` field to reference the default [JSON Schema](http://json-schema.org/) file used to define the schema (http://project-open-data.cio.gov/v1.1/schema/catalog.json) or they may refer to their own JSON Schema file where they have extended the schema. These fields are both part of a JSON object that also contains a listing of all datasets under the `dataset` field. See the [Catalog section](#Catalog) under *Further Metadata Field Guidance* for more details.
57+
Schema Version Required Declaration
58+
-------------------------------------------------
59+
The following fields are required, to be used to describe each Public Data Listing. See the [Catalog section](#Catalog) under *Further Metadata Field Guidance* for more details.
6060

61+
{: .table .table-striped}
62+
Field | Label | Definition
63+
-------------- | -------------- | --------------
64+
conformsTo | Data Standard | Version 1.1 of the schema should be identified with the following URI: http://project-open-data.cio.gov/v1.1/schema. Optionally, publishers may also use the `describedBy` field to reference the default [JSON Schema](http://json-schema.org/) file used to define the schema (http://project-open-data.cio.gov/v1.1/schema/catalog.json) or they may refer to their own JSON Schema file where they have extended the schema.
65+
dataset | Dataset | This field is a container for an array of Dataset objects. See See <a href="#Dataset">Dataset Fields</a> below for details</td> below for details.
6166

6267
"Common Core" Required Fields
6368
-----------------------------
@@ -138,58 +143,51 @@ Further Metadata Field Guidance
138143
-------------------------------
139144
Additional details for each field are provided here broken down into sections for the overarching [Catalog](#Catalog), each [dataset](#dataset), and each dataset's [distribution](#distribution).
140145

141-
{: .schema-fields .requirements-key}
142-
* Key
143-
* {: .field-required} Required
144-
* {: .field-required-if-applicable} Required if Applicable
145-
* {: .field-optional} Expanded (optional)
146-
147146

148-
{: .schema-fields}
149147
* Catalog
150-
* {: .field-required}[conformsTo](#conformsTo)
151-
* {: .field-optional}[describedBy](#describedBy)
152-
* {: .field-required}[dataset](#dataset)
153-
* {: .field-required}[accessLevel](#accessLevel)
154-
* {: .field-optional}[accrualPeriodicity](#accrualPeriodicity)
155-
* {: .field-required}[bureauCode](#bureauCode)
156-
* {: .field-optional}[conformsTo](#dataset-conformsTo)
157-
* {: .field-required}[contactPoint](#contactPoint)
158-
* {: .field-required}[fn](#contactPoint-fn)
159-
* {: .field-required}[hasEmail](#contactPoint-hasEmail)
160-
* {: .field-required-if-applicable}[dataQuality](#dataQuality)
161-
* {: .field-optional}[describedBy](#dataset-describedBy)
162-
* {: .field-optional}[describedByType](#dataset-describedByType)
163-
* {: .field-required}[description](#description)
164-
* {: .field-required-if-applicable}[distribution](#distribution)
165-
* {: .field-optional}[accessURL](#distribution-accessURL)
166-
* {: .field-optional}[conformsTo](#distribution-conformsTo)
167-
* {: .field-required-if-applicable}[downloadURL](#distribution-downloadURL)
168-
* {: .field-optional}[describedBy](#distribution-describedBy)
169-
* {: .field-optional}[describedByType](#distribution-describedByType)
170-
* {: .field-optional}[description](#distribution-description)
171-
* {: .field-optional}[format](#distribution-format)
172-
* {: .field-required-if-applicable}[mediaType](#distribution-mediaType)
173-
* {: .field-optional}[title](#title)
174-
* {: .field-required}[identifier](#identifier)
175-
* {: .field-optional}[isPartOf](#isPartOf)
176-
* {: .field-optional}[issued](#issued)
177-
* {: .field-required}[keyword](#keyword)
178-
* {: .field-optional}[landingPage](#landingPage)
179-
* {: .field-optional}[language](#language)
180-
* {: .field-required-if-applicable}[license](#license)
181-
* {: .field-required}[modified](#modified)
182-
* {: .field-optional}[primaryITInvestmentUII](#primaryITInvestmentUII)
183-
* {: .field-required}[programCode](#programCode)
184-
* {: .field-required}[publisher](#publisher)
185-
* {: .field-required}[name](#publisher-name)
186-
* {: .field-optional}[subOrganizationOf](#publisher-subOrganizationOf)
187-
* {: .field-required-if-applicable}[rights](#rights)
188-
* {: .field-required-if-applicable}[spatial](#spatial)
189-
* {: .field-optional}[systemOfRecords](#systemOfRecords)
190-
* {: .field-required-if-applicable}[temporal](#temporal)
191-
* {: .field-optional}[theme](#theme)
192-
* {: .field-required}[title](#title)
148+
* [conformsTo](#conformsTo)
149+
* [describedBy](#describedBy)
150+
* [dataset](#dataset)
151+
* [accessLevel](#accessLevel)
152+
* [accrualPeriodicity](#accrualPeriodicity)
153+
* [bureauCode](#bureauCode)
154+
* [conformsTo](#dataset-conformsTo)
155+
* [contactPoint](#contactPoint)
156+
* [fn](#contactPoint-fn)
157+
* [hasEmail](#contactPoint-hasEmail)
158+
* [dataQuality](#dataQuality)
159+
* [describedBy](#dataset-describedBy)
160+
* [describedByType](#dataset-describedByType)
161+
* [description](#description)
162+
* [distribution](#distribution)
163+
* [accessURL](#distribution-accessURL)
164+
* [conformsTo](#distribution-conformsTo)
165+
* [downloadURL](#distribution-downloadURL)
166+
* [describedBy](#distribution-describedBy)
167+
* [describedByType](#distribution-describedByType)
168+
* [description](#distribution-description)
169+
* [format](#distribution-format)
170+
* [mediaType](#distribution-mediaType)
171+
* [title](#title)
172+
* [identifier](#identifier)
173+
* [isPartOf](#isPartOf)
174+
* [issued](#issued)
175+
* [keyword](#keyword)
176+
* [landingPage](#landingPage)
177+
* [language](#language)
178+
* [license](#license)
179+
* [modified](#modified)
180+
* [primaryITInvestmentUII](#primaryITInvestmentUII)
181+
* [programCode](#programCode)
182+
* [publisher](#publisher)
183+
* [name](#publisher-name)
184+
* [subOrganizationOf](#publisher-subOrganizationOf)
185+
* [rights](#rights)
186+
* [spatial](#spatial)
187+
* [systemOfRecords](#systemOfRecords)
188+
* [temporal](#temporal)
189+
* [theme](#theme)
190+
* [title](#title)
193191

194192

195193
Catalog Fields {#Catalog}

0 commit comments

Comments
 (0)