You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 18, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: v1.1/schema.md
+41-1
Original file line number
Diff line number
Diff line change
@@ -53,6 +53,11 @@ The Project Open Data schema is case sensitive. The schema uses a camel case con
53
53
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).
54
54
55
55
56
+
Schema Version Declaration (Required)
57
+
-----------------------------
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.
59
+
60
+
56
61
"Common Core" Required Fields
57
62
-----------------------------
58
63
The following "common core" fields are required, to be used to describe each entry:
@@ -125,7 +130,42 @@ issued | Release Date | Date of formal issuance.
125
130
systemOfRecords | System of Records | If the systems is designated as a system of records under the Privacy Act of 1974, provide the URL to the System of Records Notice related to this dataset.
126
131
127
132
128
-
Further Metadata Field Guidance (alphabetical by field)
133
+
Further Metadata Field Guidance
134
+
-------------------------------
135
+
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).
**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`
**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.
0 commit comments