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

Commit 6c376cf

Browse files
committed
update format and add mediatype
1 parent 1c93d7f commit 6c376cf

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

Diff for: v1.1/schema.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,9 @@ programCode | Program Code | Federal agencies, list the primary program rel
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.
8383
accessURL | Access URL | URL providing indirect access to a dataset, for example via API or a graphical interface.
8484
downloadURL | Download URL | URL providing direct access to a downloadable file of a dataset.
85-
format | Format | The file format or API type of the distribution.
85+
format | Format | A human-readable description of the file format of a dataset.
8686
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.
8788
spatial | Spatial | The range of spatial applicability of a dataset. Could include a spatial region like a bounding box or a named place.
8889
temporal | Temporal | The range of temporal applicability of a dataset (i.e., a start and end date of applicability for the data).
8990

@@ -224,10 +225,10 @@ Further Metadata Field Guidance (alphabetical by field)
224225
**Field <a class="permalink" href="#format">#</a>** | **<a name="format">format</a>**
225226
----- | -----
226227
**Cardinality** | (0,1)
227-
**Required** | Yes, if the file is available for public download.
228+
**Required** | No
228229
**Accepted Values** | String
229-
**Usage Notes** | This must describe the exact files available at **accessURL** using [MIME Types](http://en.wikipedia.org/wiki/Internet_media_type). _[Also note [Office Open XML MIME types](http://blogs.msdn.com/b/vsofficedeveloper/archive/2008/05/08/office-2007-open-xml-mime-types.aspx)]_
230-
**Example** | `{"format":"application/json"}`
230+
**Usage Notes** | This should be a human-readable description of the file format of the dataset, that provides useful information that might not be apparent from `mediaType`.
231+
**Example** | `{"format":"A CSV spreadsheet compressed in a ZIP file."}`
231232

232233
{: .table .table-striped}
233234
**Field <a class="permalink" href="#identifier">#</a>** | **<a name="identifier">identifier</a>**
@@ -301,6 +302,15 @@ Further Metadata Field Guidance (alphabetical by field)
301302
**Usage Notes** | -
302303
**Example** | `{"mbox":"[email protected]"}`
303304

305+
{: .table .table-striped}
306+
**Field <a class="permalink" href="#mediaType">#</a>** | **<a name="mediaType">mediaType</a>**
307+
----- | -----
308+
**Cardinality** | (0,1)
309+
**Required** | Yes, if the file is available for public download.
310+
**Accepted Values** | String
311+
**Usage Notes** | This must describe the exact files available at **downloadURL** using [MIME Types](http://en.wikipedia.org/wiki/Internet_media_type). _[Also note [Office Open XML MIME types](http://blogs.msdn.com/b/vsofficedeveloper/archive/2008/05/08/office-2007-open-xml-mime-types.aspx)]_
312+
**Example** | `{"mediaType":"application/json"}`
313+
304314
{: .table .table-striped}
305315
**Field <a class="permalink" href="#modified">#</a>** | **<a name="modified">modified</a>**
306316
----- | -----

0 commit comments

Comments
 (0)