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

Commit ce1bf8f

Browse files
committed
new property names for schema version declaration
As discussed in #309
1 parent b27b723 commit ce1bf8f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Diff for: v1.1/schema.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Links to downloadable examples of metadata files developed in this and other for
5555

5656
Schema Version Declaration (Required)
5757
-----------------------------
58-
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.
58+
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.
5959

6060

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

139-
{: .table .table-striped #schema}
140-
**Field [#](#schema){: .permalink}** | **$schema**
139+
{: .table .table-striped #conformsTo}
140+
**Field [#](#conformsTo){: .permalink}** | **conformsTo**
141141
----- | -----
142142
**Cardinality** | (1,1)
143143
**Required** | Yes, always
144144
**Accepted Values** | String (URL)
145145
**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`
146-
**Example** | `{"$schema": "http://projectopendata.PLACEHOLDER.gov/v1.1/schema"}`
146+
**Example** | `{"conformsTo": "http://projectopendata.PLACEHOLDER.gov/v1.1/schema"}`
147147

148-
{: .table .table-striped #ref}
149-
**Field [#](#ref){: .permalink}** | **$ref**
148+
{: .table .table-striped #describedBy}
149+
**Field [#](#describedBy){: .permalink}** | **describedBy**
150150
----- | -----
151151
**Cardinality** | (0,1)
152152
**Required** | No
153153
**Accepted Values** | String (URL)
154154
**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.
155-
**Example** | `{"$ref": "http://projectopendata.PLACEHOLDER.gov/v1.1/schema/catalog.json"}`
155+
**Example** | `{"describedBy": "http://projectopendata.PLACEHOLDER.gov/v1.1/schema/catalog.json"}`
156156

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

0 commit comments

Comments
 (0)