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

Commit e0ba0e8

Browse files
author
Rebecca Williams
committed
more typos adjustements
1 parent f89beee commit e0ba0e8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Diff for: schema.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ Establishing a common vocabulary is the key to communication. The **common core
2626
What to Document -- Datasets and Web APIs
2727
-------------------------------------
2828

29-
A dataset is an identifiable collection of structured data objects unified by some criteria (authorship, subject, scope, spatial or temporal extent...). A catalog is a collection of descriptions of datasets; each description is a metadata record. The intention of a data catalog is to facilitate data access by users who are first interested in a particular kind of data, and upon finding a fit-for-purpose dataset, will next want to know how to get the data.
29+
A dataset is an identifiable collection of structured data objects unified by some criteria (authorship, subject, scope, spatial, or temporal extent...). A catalog is a collection of descriptions of datasets; each description is a metadata record. The intention of a data catalog is to facilitate data access by users who are first interested in a particular kind of data, and upon finding a fit-for-purpose dataset, will next want to know how to get the data.
3030

31-
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](https://explore.data.gov/Agriculture/Farmers-Markets-Geographic-Data/wfna-38ey) 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.
31+
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](https://explore.data.gov/Agriculture/Farmers-Markets-Geographic-Data/wfna-38ey) 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.
3232

3333
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. The **Endpoint** data element is used to indicate which datasets offer Web APIs (see below for more information on Common Core and Extended metadata elements).
3434

@@ -38,7 +38,7 @@ Metadata File Format -- JSON
3838

3939
The [Implementation Guidance](/implementation-guide/) available as a part of Project Open Data describes Agency requirements for the development of metadata as per the Open Data Policy. A quick primer on the file format involved:
4040

41-
[JSON](http://www.json.org) is a lightweight data-exchange format that is very easy to read, parse and generate. Based on a subset of the JavaScript programming language, JSON is a text format that is optimized for data interchange. JSON is built on two structures: (1) a collection of name/value pairs; and (2) an ordered list of values.
41+
[JSON](http://www.json.org) is a lightweight data-exchange format that is very easy to read, parse, and generate. Based on a subset of the JavaScript programming language, JSON is a text format that is optimized for data interchange. JSON is built on two structures: (1) a collection of name/value pairs; and (2) an ordered list of values.
4242

4343
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 (`""`).
4444

@@ -90,7 +90,7 @@ temporal | Temporal | The range of temporal applicability of a dataset (i.
9090

9191
Beyond Common Core -- Extending the Schema
9292
------------------------------------------
93-
"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.
93+
Extensional" and/or domain-specific metadata FIELDS can easily be added using other vocabularies even if the field 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.
9494

9595
Expanded Fields
9696
---------------
@@ -104,7 +104,7 @@ dataDictionary | Data Dictionary | URL to the data dictionary for the data
104104
dataQuality | Data Quality | Whether the dataset meets the agency's Information Quality Guidelines (true/false).
105105
distribution | Distribution | Holds multiple download URLs for datasets composed of multiple files and/or file types
106106
accrualPeriodicity | Frequency | Frequency with which dataset is published.
107-
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.
107+
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.
108108
language | Language | The language of the dataset.
109109
PrimaryITInvestmentUII | Primary IT Investment UII | For linking a dataset with an IT Unique Investment Identifier (UII)
110110
references | Related Documents | Related documents such as technical information about a dataset, developer documentation, etc.

0 commit comments

Comments
 (0)