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

Commit baa0178

Browse files
committed
updating distribution guidance, part 1
In response to #217, #248 I still need to update the expanded guidance
1 parent 921d5ca commit baa0178

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

Diff for: v1.1/schema.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ The [Implementation Guidance](/implementation-guide/) available as a part of Pro
4141

4242
Where optional fields are included in a catalog file but are unpopulated, they may be represented by a `null` value. They should not be represented by an empty string (`""`).
4343

44+
When a record has an `accessURL` or `downloadURL`, they should be contained as objects within a `distribution`. Any object may be described by `title`, `description`, `format`, or `mediaType`, though when an object contains `downloadURL`, it must be accompanied by `mediatype`.
45+
4446
The Project Open Data schema is case sensitive. The schema uses a camel case convention where the first letter of some words within a field are capitalized (usually all words but the first one). While it may seem subtle which characters are uppercase and lowercase, it is necessary to follow the exact same casing as defined in the schema documented here. For example:
4547

4648
> Correct: `contactPoint`
@@ -79,15 +81,26 @@ Field | Label | Definition
7981
-------------- | -------------- | --------------
8082
bureauCode | Bureau Code | Federal agencies, combined agency and bureau code from [OMB Circular A-11, Appendix C](http://www.whitehouse.gov/sites/default/files/omb/assets/a11_current_year/app_c.pdf) in the format of `015:11`.
8183
programCode | Program Code | Federal agencies, list the primary program related to this data asset, from the [Federal Program Inventory](http://goals.performance.gov/sites/default/files/images/FederalProgramInventory_FY13_MachineReadable_091613.xls). Use the format of `015:001`
82-
rights | Rights | This may include information regarding access or restrictions based on privacy, security, or other policies. This should also serve as an explanation for the selected “accessLevel” including instructions for how to access a restricted file, if applicable, or explanation for why a “non-public” or “restricted public” data asset is not “public,” if applicable. Text, 255 characters.
83-
accessURL | Access URL | URL providing indirect access to a dataset, for example via API or a graphical interface.
84-
downloadURL | Download URL | URL providing direct access to a downloadable file of a dataset.
85-
format | Format | A human-readable description of the file format of a dataset.
84+
distribution | Distribution | Represents a specific available form of a dataset in the form of download or access URLs, along with metadata specific to that form.
8685
license | License | The license with which the dataset or API is published. See [Open Licenses](/open-licenses/) for more information.
87-
mediaType | MIME Type | The machine-readable file format ([IANA MIME Type](http://en.wikipedia.org/wiki/Internet_media_type)) of a dataset.
86+
rights | Rights | This may include information regarding access or restrictions based on privacy, security, or other policies. This should also serve as an explanation for the selected “accessLevel” including instructions for how to access a restricted file, if applicable, or explanation for why a “non-public” or “restricted public” data asset is not “public,” if applicable. Text, 255 characters.
8887
spatial | Spatial | The range of spatial applicability of a dataset. Could include a spatial region like a bounding box or a named place.
8988
temporal | Temporal | The range of temporal applicability of a dataset (i.e., a start and end date of applicability for the data).
9089

90+
"Common Core" Distribution Fields
91+
-------------------------------------------
92+
Within a record, `distribution` is used to aggregate the metadata specific to a dataset's resources (`accessURL` and `downloadURL`), which may be described using the following fields. Each distribution should contain one `accessURL` or `downloadURL`. `downloadURL` should always be accompanied by `mediaType`.
93+
94+
{: .table .table-striped}
95+
Field | Label | Definition
96+
-------------- | -------------- | --------------
97+
accessURL | Access URL | URL providing indirect access to a dataset, for example via API or a graphical interface.
98+
downloadURL | Download URL | URL providing direct access to a downloadable file of a dataset.
99+
description | Description | Human-readable description of the distribution.
100+
format | Format | A human-readable description of the file format of a distribution.
101+
mediaType | MIME Type | The machine-readable file format ([IANA MIME Type](http://en.wikipedia.org/wiki/Internet_media_type)) of a distribution.
102+
title | Title | Human-readable name of the distribution.
103+
91104
Beyond Common Core -- Extending the Schema
92105
------------------------------------------
93106
"Extensional" and/or domain specific metadata can easily be added using other vocabularies even if it is not a term (entity/property) that will get indexed by the major search engines - it could still be indexed by other custom search engines and by Data.gov. Agencies are encouraged to extend their metadata descriptions using elements from the "Expanded Fields" list shown below, or from any well-known vocabulary (including Dublin Core, FGDC, ISO 19115, NIEM, and a growing number of vocabularies published at [Vocab.Data.gov](http://vocab.data.gov)) as long as they are properly assigned.
@@ -102,7 +115,6 @@ Field | Label | Definition
102115
theme | Category | Main thematic category of the dataset.
103116
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.
104117
dataQuality | Data Quality | Whether the dataset meets the agency's Information Quality Guidelines (true/false).
105-
distribution | Distribution | Holds multiple download URLs for datasets composed of multiple files and/or file types
106118
accrualPeriodicity | Frequency | Frequency with which dataset is published.
107119
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.
108120
isPartOf | isPartOf | The collection of which the dataset is a subset.

0 commit comments

Comments
 (0)