Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved guidance for the mediaType property #58

Merged
merged 1 commit into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/data/Distribution/invalid/invalid-mediatype-csv.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Example CSV Distribution description
# The example corresponds to the CSV distribution of the OS CodePoint data
---
identifier: https://api.os.uk/downloads/v1/products/CodePointOpen/downloads?area=GB&format=CSV&redirect
type: dcat:Distribution
title: Code-Point Open - CSV GB
licence: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
mediaType: CSV
8 changes: 8 additions & 0 deletions src/data/Distribution/invalid/invalid-mediatype-uri.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Example CSV Distribution description
# The example corresponds to the CSV distribution of the OS CodePoint data
---
identifier: https://api.os.uk/downloads/v1/products/CodePointOpen/downloads?area=GB&format=CSV&redirect
type: dcat:Distribution
title: Code-Point Open - CSV GB
licence: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
mediaType: https://w3id.org/uri4uri/mime/text/csv
10 changes: 10 additions & 0 deletions src/data/Distribution/invalid/multiple-mediatype.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Example CSV Distribution description
# The example corresponds to the CSV distribution of the OS CodePoint data
---
identifier: https://api.os.uk/downloads/v1/products/CodePointOpen/downloads?area=GB&format=CSV&redirect
type: dcat:Distribution
title: Code-Point Open - CSV GB
licence: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
mediaType:
- text/csv
- application/geopackage+sqlite3
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Example Excel (.xlsx) Distribution description
# The example is based on CSV distribution of the OS CodePoint data
---
identifier: https://api.os.uk/downloads/v1/products/CodePointOpen/downloads?area=GB&format=EXCEL&redirect
type: dcat:Distribution
title: Code-Point Open - Excel GB
licence: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
mediaType: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
15 changes: 12 additions & 3 deletions src/model/uk_cross_government_metadata_exchange_model.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -440,16 +440,25 @@ Note that there could be a security risk in sharing the endpoint URL for interna
The file format or encoding method of the item (file) being described.
The media type of the distribution as defined by IANA [IANA-MEDIA-TYPES](https://www.iana.org/assignments/media-types/media-types.xhtml).
required: true
range: uri
range: string
pattern: ^application/\S+|^audio/\S+|^font/\S+|^image/\S+|^message/\S+|^model/\S+|^multipart/\S+|^text/\S+|^video/\S+
# While the above is equivalent to the below, the tests fail with the expression below.
# pattern: ^[application|audio|font|image|message|model|multipart|text|video]/\S+
comments: |
purpose:
Use of `mediaType` supports retrieval, as well as control, storage, preservation and access management of resources through time. It can alert users to the existence of requirements for software, hardware or equipment other than a web browser to display, use, or manage a resource.
distinctFrom:
- AVAILABILITY: used when the described resource is available in print or in another digital format through another government or non-government source.
- TYPE: describes the business structure of the content of a resource, e.g. fact sheet, policy, report, guide, statistics.
guidance:
`mediaType` refers to the encoding method used to store digital resource and convert it into human-accessible form.
A resource with identical or near-identical intellectual content may have multiple formats. For example, a resource may be available for download in html, pdf and docx formats.
`mediaType` refers to the encoding method used to store the digital resource and convert it into human-accessible form. The value should be provided as per the Template column provided in the [IANA pages](https://www.iana.org/assignments/media-types/media-types.xhtml). Below are some examples:
- CSV: `text/csv`
- Excel (`.xlsx`): `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
- Geopackage: `application/geopackage+sqlite3`
- HTML: `text/html`
- PDF: `application/pdf`
- Word (`.docx`): `application/vnd.openxmlformats-officedocument.wordprocessingml.document`
A resource with identical or near-identical intellectual content may be available in multiple formats. For example, a resource may be available for download in html, pdf and docx formats. These should be captured as separate [distributions](/ukgov-metadata-exchange-model/Distribution) of the Dataset with each distribution having a different mediatype value.
modified:
slot_uri: dct:modified
description: The date, or date and time, on which the content of an information resource is changed.
Expand Down