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

Commit

Permalink
new property names for schema version declaration
Browse files Browse the repository at this point in the history
As discussed in #309
  • Loading branch information
philipashlock committed Sep 10, 2014
1 parent b27b723 commit ce1bf8f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions v1.1/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Links to downloadable examples of metadata files developed in this and other for

Schema Version Declaration (Required)
-----------------------------
In order to distinguish the schema version being used publishers are required to specify the relevant URI using the `$schema` field at the beginning of their data.json file. Version 1.1 of the schema should be identified with the following URI: http://projectopendata.PLACEHOLDER.gov/v1.1/schema. Optionally, publishers may also use the `$ref` field to reference the default [JSON Schema](http://json-schema.org/) file used to define the schema (http://projectopendata.PLACEHOLDER.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.
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://projectopendata.PLACEHOLDER.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://projectopendata.PLACEHOLDER.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.


"Common Core" Required Fields
Expand Down Expand Up @@ -136,23 +136,23 @@ Additional details for each field are provided here broken down into sections fo
Catalog Fields {#Catalog}
-------------------------------

{: .table .table-striped #schema}
**Field [#](#schema){: .permalink}** | **$schema**
{: .table .table-striped #conformsTo}
**Field [#](#conformsTo){: .permalink}** | **conformsTo**
----- | -----
**Cardinality** | (1,1)
**Required** | Yes, always
**Accepted Values** | String (URL)
**Usage Notes** | This is used to identify the schema version using a URI. The URI for version 1.1 of the schema is `http://projectopendata.PLACEHOLDER.gov/v1.1/schema`
**Example** | `{"$schema": "http://projectopendata.PLACEHOLDER.gov/v1.1/schema"}`
**Example** | `{"conformsTo": "http://projectopendata.PLACEHOLDER.gov/v1.1/schema"}`

{: .table .table-striped #ref}
**Field [#](#ref){: .permalink}** | **$ref**
{: .table .table-striped #describedBy}
**Field [#](#describedBy){: .permalink}** | **describedBy**
----- | -----
**Cardinality** | (0,1)
**Required** | No
**Accepted Values** | String (URL)
**Usage Notes** | This is used to specify a [JSON Schema](http://json-schema.org/) file that defines all fields. By default, it is recommended that the canonical JSON Schema file is referenced (http://projectopendata.PLACEHOLDER.gov/v1.1/schema/catalog.json) but if the schema had been extended, publishers may reference a file that defines those extensions.
**Example** | `{"$ref": "http://projectopendata.PLACEHOLDER.gov/v1.1/schema/catalog.json"}`
**Example** | `{"describedBy": "http://projectopendata.PLACEHOLDER.gov/v1.1/schema/catalog.json"}`

{: .table .table-striped #dataset}
**Field [#](#dataset){: .permalink}** | **dataset**
Expand Down

0 comments on commit ce1bf8f

Please sign in to comment.