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

Commit 1c93d7f

Browse files
committed
accessURL, downloadURL, webService
* refined accessURL * added downloadURL * removed webService addressing #335, #291
1 parent 8eb32ce commit 1c93d7f

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

Diff for: v1.1/schema.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ Field | Label | Definition
8080
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`.
8181
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`
8282
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 | Download URL | URL providing direct access to the downloadable distribution of a dataset.
84-
webService | Endpoint | Endpoint of web service to access dataset.
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.
8585
format | Format | The file format or API type of the distribution.
8686
license | License | The license with which the dataset or API is published. See [Open Licenses](/open-licenses/) for more information.
8787
spatial | Spatial | The range of spatial applicability of a dataset. Could include a spatial region like a bounding box or a named place.
@@ -127,11 +127,11 @@ Further Metadata Field Guidance (alphabetical by field)
127127
{: .table .table-striped}
128128
**Field <a class="permalink" href="#accessURL">#</a>** | **<a name="accessURL">accessURL</a>**
129129
----- | -----
130-
**Cardinality** | (0,1)
131-
**Required** | Yes, if the file is available for public download.
130+
**Cardinality** | (0,n)
131+
**Required** | Yes, if the file is accessible indirectly, through means other than direct download.
132132
**Accepted Values** | String (URL)
133-
**Usage Notes** | This must be the **direct** download URL. Use **homepage** for landing or disambiguation pages, or **references** for documentation pages. For multiple downloads, use **distribution** to include as many **accessURL** entries as you need.
134-
**Example** | `{"accessURL":"http://www.agency.gov/vegetables/listofvegetables.csv"}`
133+
**Usage Notes** | This should be the URL for an indirect means of accessing the data, such as API documentation, a 'wizard' or other graphical interface which is used to generate a download, feed, or a request form for the data. This should not be a **direct** download URL. It is usually assumed that accessURL is an HTML webpage.
134+
**Example** | `{"accessURL":"http://www.agency.gov/api/vegetables/"}`
135135

136136
{: .table .table-striped}
137137
**Field <a class="permalink" href="#accrualPeriodicity">#</a>** | **<a name="accrualPeriodicity">accrualPeriodicity</a>**
@@ -210,6 +210,16 @@ Further Metadata Field Guidance (alphabetical by field)
210210
}
211211
]
212212
213+
214+
{: .table .table-striped}
215+
**Field <a class="permalink" href="#downloadURL">#</a>** | **<a name="downloadURL">downloadURL</a>**
216+
----- | -----
217+
**Cardinality** | (0,n)
218+
**Required** | Yes, if the file is available for public download.
219+
**Accepted Values** | String (URL)
220+
**Usage Notes** | This must be the **direct** download URL. Other means of accessing the dataset should be expressed using **accessURL**.
221+
**Example** | `{"downloadURL":"http://www.agency.gov/vegetables/listofvegetables.csv"}`
222+
213223
{: .table .table-striped}
214224
**Field <a class="permalink" href="#format">#</a>** | **<a name="format">format</a>**
215225
----- | -----
@@ -398,15 +408,6 @@ Updated every 5 minutes beginning on February 15, 2010 would be represented as:
398408
**Usage Notes** | Acronyms should be avoided.
399409
**Example** | `{"title":"Types of Vegetables"}`
400410

401-
{: .table .table-striped}
402-
**Field <a class="permalink" href="#webService">#</a>** | **<a name="webService">webService</a>**
403-
----- | -----
404-
**Cardinality** | (0,1)
405-
**Required** | Yes, if the dataset has an API
406-
**Accepted Values** | String (URL)
407-
**Usage Notes** | This field will serve to delineate the web services offered by an agency and will be used to aggregate cross-government API catalogs.
408-
**Example** | `{"webService":"http://www.agency.gov/vegetables/vegetables.json"}`
409-
410411

411412
Rationale for Metadata Nomenclature
412413
----------------------

0 commit comments

Comments
 (0)