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

Commit 0755122

Browse files
author
jlberryhill
committed
Merge pull request #408 from project-open-data/adding-links-to-/api
Adding links to /api
2 parents 434c023 + e1b0261 commit 0755122

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

Diff for: index.md

+2
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Implementation guidance for open data practices.
4444

4545
3-3 [Public Data Listing](/catalog/) - The specific guidance for publishing the Open Data Catalog at the agency.gov/data page.
4646

47+
3-4 [Documenting APIs](/v1.1/api/) - The specific guidance for documenting APIs in the data catalogs.
48+
4749
3-4 [Frequently Asked Questions](/faq/) - A growing list of common questions and answers to facilitate adoption of open data projects.
4850

4951
3-5 [Open Data Cross Priority (CAP) Goal](http://goals.performance.gov/opendata) - Information on the development of the Open Data CAP goal as required in the [Open Data Executive Order](http://www.whitehouse.gov/the-press-office/2013/05/09/executive-order-making-open-and-machine-readable-new-default-government).

Diff for: v1.1/schema.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ A dataset is an identifiable collection of structured data objects unified by so
3131

3232
A Web API (**A**pplication **P**rogramming **I**nterface) allows computer programs to dynamically query a dataset using the World Wide Web. For example, a dataset of [farmers markets](http://catalog.data.gov/dataset/farmers-markets-geographic-data) may be made available for download as a single file (e.g., a CSV), or may be made available to developers through a Web API, such that a computer program could use a ZIP Code to retrieve a list of farmers markets in the ZIP Code area.
3333

34-
The catalog file for each agency should list all of the agency's datasets that can be made public, regardless of whether they are distributed by a file download or through a Web API.
34+
The catalog file for each agency should list all of the agency's datasets that can be made public, regardless of whether they are distributed by a file download or a Web API. Please also see the extended guidance on [documenting Web APIs in your data.json files](/v1.1/api/).
3535

3636

3737
Metadata File Format -- JSON
@@ -450,7 +450,7 @@ Dataset Fields {#Dataset}
450450
**Cardinality** | (0,1)
451451
**Required** | Yes, if the file is accessible indirectly, through means other than direct download.
452452
**Accepted Values** | String (URL)
453-
**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. When accessLevel is "restricted public" but the dataset is available online indirectly, this field should be the URL that provides indirect access. This should not be a **direct** download URL. It is usually assumed that accessURL is an HTML webpage.
453+
**Usage Notes** | This should be the URL for an indirect means of accessing the data, such as [API documentation](/v1.1/api/), a 'wizard' or other graphical interface which is used to generate a download, feed, or a request form for the data. When accessLevel is "restricted public" but the dataset is available online indirectly, this field should be the URL that provides indirect access. This should not be a **direct** download URL. It is usually assumed that accessURL is an HTML webpage.
454454
**Example** | `{"accessURL":"http://www.agency.gov/api/vegetables/"}`
455455

456456
{: .table .table-striped .child-field #distribution-conformsTo}

0 commit comments

Comments
 (0)