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

Commit 23b63f6

Browse files
committed
Clarified that URL values should be strings.
1 parent fdf0d2b commit 23b63f6

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

Diff for: schema.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Field | title
121121
----- | -----
122122
**Cardinality** | (0,1)
123123
**Required** | No (Documentation that is not specifically a data dictionary belongs in "references")
124-
**Accepted Values** | URL
124+
**Accepted Values** | String (URL)
125125
**Usage Notes** | -
126126
**Example** | `{"dataDictionary":"http://www.agency.gov/vegetables/dictionary.html"}`
127127

@@ -130,7 +130,7 @@ Field | title
130130
----- | -----
131131
**Cardinality** | (0,1)
132132
**Required** | Yes, if the file is available for public download.
133-
**Accepted Values** | URL
133+
**Accepted Values** | String (URL)
134134
**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.
135135
**Example** | `{"accessURL":"http://www.agency.gov/vegetables/listofvegetables.csv"}`
136136

@@ -202,7 +202,7 @@ Field | title
202202
----- | -----
203203
**Cardinality** | (1,1)
204204
**Required** | Yes, always
205-
**Accepted Values** | Must be one of the following: public, restricted public, non-public
205+
**Accepted Values** | Must be one of the following: "public", "restricted public", "non-public"
206206
**Usage Notes** | This field refers to degree to which this dataset *could be made available* to the public, regardless of whether it is currently available to the public. For example, if a member of the public can walk into your agency and obtain a dataset, that entry is **public** even if there are no files online. A *restricted public* dataset is one only available under certain conditions or to certain audiences (such as researchers who sign a waiver). A *non-public* dataset is one that could never be made available to the public for privacy, security, or other reasons as determined by your agency.
207207
**Example** | `{"accessLevel":"public"}`
208208

@@ -211,7 +211,7 @@ Field | title
211211
----- | -----
212212
**Cardinality** | (0,1)
213213
**Required** | Yes, if the dataset has an API
214-
**Accepted Values** | URL
214+
**Accepted Values** | String (URL)
215215
**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.
216216
**Example** | `{"webService":"http://www.agency.gov/vegetables/vegetables.json"}`
217217

@@ -302,7 +302,7 @@ Field | title
302302
**Cardinality** | (0,1)
303303
**Required** | No
304304
**Accepted Values** | See Usage Notes
305-
**Usage Notes** | Distribution is a concatenation, as appropriate, of the following elements: **Download URL** and **Format**. If an entry has only one dataset, enter details for that one; if it has multiple datasets (such as a bulk download and an API), separate entry with a comma, as seen below:
305+
**Usage Notes** | Distribution is a concatenation, as appropriate, of the following elements: **accessURL** and **format**. If an entry has only one dataset, enter details for that one; if it has multiple datasets (such as a bulk download and an API), separate entries with a comma, as seen below:
306306

307307
"distribution": [
308308
{
@@ -319,11 +319,12 @@ Field | title
319319
}
320320
]
321321

322+
{: .table .table-striped}
322323
**Field** | **landingPage**
323324
----- | -----
324325
**Cardinality** | (0,1)
325326
**Required** | No
326-
**Accepted Values** | URL
327+
**Accepted Values** | String (URL)
327328
**Usage Notes** | This field is not intended for an agency's homepage (e.g. www.agency.gov), but rather if a dataset has a human-friendly hub or landing page that users should be directed to for all resources tied to the dataset. This allows agencies to better specify what a visitor receives after selecting one of the agency's datasets on Data.gov or in third-party mashups.
328329
**Example** | `{"landingPage":"http://www.agency.gov/vegetables"}`
329330

0 commit comments

Comments
 (0)