DCAT-US 3.0: Quality and Governance

Quality and Governance

Supporting classes for standards, documents, catalog records, data services, and attribution used in governance and quality description.

Class Standard #

A standard or specification that another resource conforms to

Type object
Additional properties Any type allowed

Example:

{
    "@type": "Standard",
    "title": "DCAT-US 3.0",
    "description": "Data Catalog Vocabulary - United States Profile version 3.0",
    "issued": "2024-01-15",
    "identifier": {
        "@type": "Identifier",
        "notation": "DCAT-US-3.0",
        "schemaAgency": "U.S. General Services Administration"
    },
    "inScheme": {
        "@type": "ConceptScheme",
        "title": "Federal Data Standards",
        "description": "A collection of data standards used by federal agencies"
    }
}
Property Type Requirement Level Title/Description
@id string Optional  
@type string Optional  
created More than one type Optional The date on which the Standard has been first created
description null or string Recommended Plain-language summary of the standard
identifier More than one type Recommended The unique identifier for the Standard, e.g. the URI or other unique identifier in the context of the Catalog
otherIdentifier null or array of Identifier classes Optional A list of identifiers for the Standard besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog
issued More than one type Recommended The date of formal issuance (e.g., publication) of the Standard
modified More than one type Optional The most recent date on which the Standard was changed or modified
title null or string Recommended Human-readable title of the standard
category null or array of Concept classes Optional List of categories for the Standard
inScheme More than one type Recommended The reference register to which the Standard belongs

Standard > @id #

Requirement: Optional

Type string
Format iri

Example:

"https://example.gov/standards/dcat-us-3"

Standard > @type #

Requirement: Optional

Type string
Default "Standard"

Standard > created #

Title: creation date

Requirement: Optional

The date on which the Standard has been first created

Type combining
Additional properties Any type allowed

Examples:

"2023-01-01"

"2024-01-15T10:30:00Z"

"2024"

"2024-01"
Any of
Null allowed when not required
Date string

Standard > created > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

Standard > created > anyOf > Date string #

Type combining
Additional properties Any type allowed
Any of
item 0
item 1
item 2
item 3

Standard > created > anyOf > Date string > anyOf > item 0 #

Type string
Format date-time

Standard > created > anyOf > Date string > anyOf > item 1 #

Type string
Format date

Standard > created > anyOf > Date string > anyOf > item 2 #

A year in YYYY format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}$ Test

Standard > created > anyOf > Date string > anyOf > item 3 #

A year and month in YYYY-MM format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}-[0-9]{2}$ Test

Standard > description #

Requirement: Recommended

Plain-language summary of the standard

| Type | null or string | | ——– | —————- |

Examples:

"Data Catalog Vocabulary - United States Profile version 3.0"

"The DCAT-US 3.0 schema defines a standard metadata format for data catalogs in the United States government, based on W3C DCAT."

Standard > identifier #

Requirement: Recommended

The unique identifier for the Standard, e.g. the URI or other unique identifier in the context of the Catalog

Type combining
Additional properties Any type allowed
Any of
Null allowed when not required
Identifier

Standard > identifier > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

Standard > identifier > anyOf > Identifier #

inline description of Identifier

Type combining
Additional properties Any type allowed
Defined in Identifier

Standard > otherIdentifier #

Requirement: Optional

A list of identifiers for the Standard besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog

| Type | null or array of Identifier classes | | ——– | ———————————————————————————— |

Each item of this array must be Description
Identifier A unique identifier and optionally it’s scheme and other relevant information

Standard > issued #

Requirement: Recommended

The date of formal issuance (e.g., publication) of the Standard

Type combining
Additional properties Any type allowed

Examples:

"2024-01-15"

"2024-01-15T10:30:00Z"

"2024"

"2024-01"
Any of
Null allowed when not required
Date string

Standard > issued > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

Standard > issued > anyOf > Date string #

Type combining
Additional properties Any type allowed
Any of
item 0
item 1
item 2
item 3

Standard > issued > anyOf > Date string > anyOf > item 0 #

Type string
Format date-time

Standard > issued > anyOf > Date string > anyOf > item 1 #

Type string
Format date

Standard > issued > anyOf > Date string > anyOf > item 2 #

A year in YYYY format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}$ Test

Standard > issued > anyOf > Date string > anyOf > item 3 #

A year and month in YYYY-MM format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}-[0-9]{2}$ Test

Standard > modified #

Title: last modified

Requirement: Optional

The most recent date on which the Standard was changed or modified

Type combining
Additional properties Any type allowed

Examples:

"2024-06-01"

"2024-01-15T10:30:00Z"

"2024"

"2024-01"
Any of
Null allowed when not required
Date string

Standard > modified > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

Standard > modified > anyOf > Date string #

Type combining
Additional properties Any type allowed
Any of
item 0
item 1
item 2
item 3

Standard > modified > anyOf > Date string > anyOf > item 0 #

Type string
Format date-time

Standard > modified > anyOf > Date string > anyOf > item 1 #

Type string
Format date

Standard > modified > anyOf > Date string > anyOf > item 2 #

A year in YYYY format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}$ Test

Standard > modified > anyOf > Date string > anyOf > item 3 #

A year and month in YYYY-MM format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}-[0-9]{2}$ Test

Standard > title #

Requirement: Recommended

Human-readable title of the standard

| Type | null or string | | ——– | —————- |

Examples:

"DCAT-US 3.0"

"DCAT-US 3.0 - Data Catalog Vocabulary United States Profile"

Standard > category #

Requirement: Optional

List of categories for the Standard

| Type | null or array of Concept classes | | ——– | —————————————————————————— |

Each item of this array must be Description
Concept A controlled term or label, optionally drawn from a concept scheme

Standard > inScheme #

Requirement: Recommended

The reference register to which the Standard belongs

Type combining
Additional properties Any type allowed
Any of
Null allowed when not required
ConceptScheme

Standard > inScheme > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

Standard > inScheme > anyOf > ConceptScheme #

inline description of ConceptScheme

Type object
Additional properties Any type allowed
Same definition as ConceptScheme

Class Document #

A publication or other document related to a resource

Type object
Additional properties Any type allowed

Example:

{
    "@type": "Document",
    "title": "Climate Data User Guide",
    "description": "A guide for accessing and using the National Climate Data Center's data products.",
    "accessURL": "https://example.gov/docs/climate-user-guide",
    "mediaType": "application/pdf",
    "identifier": "NCDC-UG-2024-001",
    "issued": "2024-03-15",
    "publisher": [
        {
            "@type": "Organization",
            "name": "National Climate Data Center"
        }
    ],
    "bibliographicCitation": "National Climate Data Center. (2024). Climate Data User Guide. Retrieved from https://example.gov/docs/climate-user-guide"
}
Property Type Requirement Level Title/Description
@id string Optional  
@type string Optional  
accessURL More than one type Optional A URL that gives access to the Document
downloadURL More than one type Optional A URL that is a direct link to a downloadable file of the Document in a given format
creator null or array of Kind classes Optional The individual(s) responsible for creating the Document
mediaType null or string Optional The file format of the Document as defined in the official register of media types managed by IANA: https://www.iana.org/assignments/media-types/media-types.xhtml
abstract null or string Optional Text abstract of the Document
bibliographicCitation null or string Recommended Bibliographic citation as text
conformsTo null or array of Standard classes Optional List of standards or specifications the document follows
corporateCreator null or array of Organization classes Optional The corporate organization(s) responsible for creating the Document
description null or string Recommended Plain-language summary of the document
identifier More than one type Recommended The unique identifier for the Document (e.g. DOI, ISBN)
otherIdentifier null or array of Identifier classes Optional A list of identifiers for the Document besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog
issued More than one type Recommended Publication date of the Document
publisher null or array of Organization classes Recommended The organization(s) that published the Document
title string Mandatory The title of the Document
category null or array of Concept classes Optional List of categories/genres for the Document

Document > @id #

Requirement: Optional

Type string
Format iri

Example:

"https://example.gov/documents/climate-user-guide-001"

Document > @type #

Requirement: Optional

Type string
Default "Document"

Document > accessURL #

Requirement: Optional

A URL that gives access to the Document

Type combining
Additional properties Any type allowed

Example:

"https://example.gov/docs/climate-user-guide"
Any of
Null allowed when not required
URL

Document > accessURL > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

Document > accessURL > anyOf > URL #

reference iri of Document

Type string
Format iri

Document > downloadURL #

Requirement: Optional

A URL that is a direct link to a downloadable file of the Document in a given format

Type combining
Additional properties Any type allowed

Example:

"https://example.gov/docs/climate-user-guide.pdf"
Any of
Null allowed when not required
URL

Document > downloadURL > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

Document > downloadURL > anyOf > URL #

reference iri of Document

Type string
Format iri

Document > creator #

Title: author

Requirement: Optional

The individual(s) responsible for creating the Document

| Type | null or array of Kind classes | | ——– | ————————————————- |

Each item of this array must be Description
Kind Contact information for an individual or entity

Document > mediaType #

Requirement: Optional

The file format of the Document as defined in the official register of media types managed by IANA: https://www.iana.org/assignments/media-types/media-types.xhtml

| Type | null or string | | ——– | —————- |

Example:

"application/pdf"

Document > abstract #

Requirement: Optional

Text abstract of the Document

| Type | null or string | | ——– | —————- |

Example:

"This document provides detailed instructions for using climate data products, including API access, file formats, and data interpretation guidelines."

Document > bibliographicCitation #

Requirement: Recommended

Bibliographic citation as text

| Type | null or string | | ——– | —————- |

Examples:

"National Climate Data Center. (2024). Climate Data User Guide. Retrieved from https://example.gov/docs/climate-user-guide"

"National Climate Data Center. (2024). Climate Data User Guide. U.S. Department of Commerce."

Document > conformsTo #

Requirement: Optional

List of standards or specifications the document follows

| Type | null or array of Standard classes | | ——– | ——————————————————————— |

Each item of this array must be Description
Standard A standard or specification that another resource conforms to

Document > corporateCreator #

Title: corporate author

Requirement: Optional

The corporate organization(s) responsible for creating the Document

| Type | null or array of Organization classes | | ——– | —————————————————————– |

Each item of this array must be Description
Organization An organization involved with a resource, including parent or child organizations

Document > description #

Requirement: Recommended

Plain-language summary of the document

| Type | null or string | | ——– | —————- |

Examples:

"A guide for accessing and using the National Climate Data Center's data products."

"A comprehensive guide for accessing and using the National Climate Data Center's data products and services."

Document > identifier #

Requirement: Recommended

The unique identifier for the Document (e.g. DOI, ISBN)

Type combining
Additional properties Any type allowed
Any of
Null allowed when not required
Identifier

Document > identifier > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

Document > identifier > anyOf > Identifier #

inline description of Identifier

Type combining
Additional properties Any type allowed
Same definition as Identifier

Document > otherIdentifier #

Requirement: Optional

A list of identifiers for the Document besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog

| Type | null or array of Identifier classes | | ——– | ———————————————————————————— |

Each item of this array must be Description
Identifier A unique identifier and optionally it’s scheme and other relevant information

Document > issued #

Title: publication date

Requirement: Recommended

Publication date of the Document

Type combining
Additional properties Any type allowed

Examples:

"2024-01-15"

"2024-01-15T10:30:00Z"

"2024"

"2024-01"
Any of
Null allowed when not required
item 1

Document > issued > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

Document > issued > anyOf > item 1 #

Type combining
Additional properties Any type allowed
Any of
item 0
item 1
item 2
item 3

Document > issued > anyOf > item 1 > anyOf > item 0 #

Type string
Format date-time

Document > issued > anyOf > item 1 > anyOf > item 1 #

Type string
Format date

Document > issued > anyOf > item 1 > anyOf > item 2 #

A year in YYYY format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}$ Test

Document > issued > anyOf > item 1 > anyOf > item 3 #

A year and month in YYYY-MM format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}-[0-9]{2}$ Test

Document > publisher #

Requirement: Recommended

The organization(s) that published the Document

| Type | null or array of Organization classes | | ——– | —————————————————————– |

Each item of this array must be Description
Organization An organization involved with a resource, including parent or child organizations

Document > title #

Requirement: Mandatory

The title of the Document

Type string
Required Yes

Example:

"Climate Data User Guide"

Document > category #

Requirement: Optional

List of categories/genres for the Document

| Type | null or array of Concept classes | | ——– | —————————————————————————— |

Each item of this array must be Description
Concept A controlled term or label, optionally drawn from a concept scheme

Class CatalogRecord #

A record in a catalog, describing the registration of a single resource

Type object
Additional properties Any type allowed

Example:

{
    "@type": "CatalogRecord",
    "modified": "2024-06-15",
    "primaryTopic": "https://example.gov/datasets/climate-data-2024",
    "title": "Climate Data 2024 Catalog Entry",
    "issued": [
        "2024-01-15"
    ],
    "status": "published",
    "conformsTo": {
        "@type": "Standard",
        "title": "DCAT-US 3.0"
    }
}
Property Type Requirement Level Title/Description
@id string Optional  
@type string Optional  
status More than one type Recommended The status of the catalog record in the context of editorial flow of the dataset and data service descriptions
conformsTo More than one type Recommended An Application Profile that the Catalog Record’s metadata conforms to
description null or array of string Optional A list of free-text accounts of the catalog record
issued null or array of object Optional List of dates on which the catalog record was included in the catalog
language More than one type Optional Language code used in catalog record metadata text, using ISO 639-1 values such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html
modified More than one type Mandatory The most recent date on which the catalog record was changed or modified
source null or string Optional The original metadata that was used in creating metadata for the items in the catalog record, either a URL referencing the source metadata or a string of the source metadata itself
title null or string Optional A name given to the Catalog Record
primaryTopic string Mandatory A link to the Dataset, Data service or Catalog described in the Catalog Record

CatalogRecord > @id #

Requirement: Optional

Type string
Format iri

Example:

"https://example.gov/catalog-records/climate-dataset-record-001"

CatalogRecord > @type #

Requirement: Optional

Type string
Default "CatalogRecord"

CatalogRecord > status #

Title: change type

Requirement: Recommended

The status of the catalog record in the context of editorial flow of the dataset and data service descriptions

Type combining
Additional properties Any type allowed
Any of
Null allowed when not required
Concept

CatalogRecord > status > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

CatalogRecord > status > anyOf > Concept #

inline description of status

Type combining
Additional properties Any type allowed
Defined in Concept

CatalogRecord > conformsTo #

Title: application profile

Requirement: Recommended

An Application Profile that the Catalog Record’s metadata conforms to

Type combining
Additional properties Any type allowed
Any of
Null allowed when not required
Standard

CatalogRecord > conformsTo > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

CatalogRecord > conformsTo > anyOf > Standard #

inline description of application profile

Type object
Additional properties Any type allowed
Defined in Standard

CatalogRecord > description #

Title: Descriptions

Requirement: Optional

A list of free-text accounts of the catalog record

| Type | null or array of string | | ——– | ———————– |

Example:

[
    "This catalog record describes the registration of the Climate Data 2023 dataset.",
    "Contains metadata about when the dataset was added and last updated."
]
Each item of this array must be Description
Description string -

Description string #

| Type | string | | ——– | ——– |

CatalogRecord > issued #

Title: listing date

Requirement: Optional

List of dates on which the catalog record was included in the catalog

| Type | null or array of object | | ——– | ———————– |

Examples:

[
    "2024-01-15T10:30:00Z"
]

[
    "2024-01-15"
]

[
    "2024"
]

[
    "2024-01"
]
Each item of this array must be Description
Date string -

Date string #

Type combining
Additional properties Any type allowed
Any of
item 0
item 1
item 2
item 3

CatalogRecord > issued > Date string > anyOf > item 0 #

Type string
Format date-time

CatalogRecord > issued > Date string > anyOf > item 1 #

Type string
Format date

CatalogRecord > issued > Date string > anyOf > item 2 #

A year in YYYY format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}$ Test

CatalogRecord > issued > Date string > anyOf > item 3 #

A year and month in YYYY-MM format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}-[0-9]{2}$ Test

CatalogRecord > language #

Requirement: Optional

Language code used in catalog record metadata text, using ISO 639-1 values such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html

Type combining
Additional properties Any type allowed

Examples:

"en"

[
    "en",
    "es"
]
Any of
Null allowed when not required
Language code
Array of language codes

CatalogRecord > language > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

CatalogRecord > language > anyOf > Language code #

| Type | string | | ——– | ——– |

Restrictions  
Max length 2

CatalogRecord > language > anyOf > Array of language codes #

| Type | array of string | | ——– | ————— |

Each item of this array must be Description
Language code -

Language code #

| Type | string | | ——– | ——– |

Restrictions  
Max length 2

CatalogRecord > modified #

Title: update/modification date

Requirement: Mandatory

The most recent date on which the catalog record was changed or modified

Type combining
Required Yes
Additional properties Any type allowed

Examples:

"2024-06-15"

"2024-01-15T10:30:00Z"

"2024"

"2024-01"
Any of
item 0
item 1
item 2
item 3

CatalogRecord > modified > anyOf > item 0 #

Type string
Format date-time

CatalogRecord > modified > anyOf > item 1 #

Type string
Format date

CatalogRecord > modified > anyOf > item 2 #

A year in YYYY format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}$ Test

CatalogRecord > modified > anyOf > item 3 #

A year and month in YYYY-MM format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}-[0-9]{2}$ Test

CatalogRecord > source #

Title: source metadata

Requirement: Optional

The original metadata that was used in creating metadata for the items in the catalog record, either a URL referencing the source metadata or a string of the source metadata itself

| Type | null or string | | ——– | —————- |

Example:

"Original metadata harvested from NOAA data portal"

CatalogRecord > title #

Requirement: Optional

A name given to the Catalog Record

| Type | null or string | | ——– | —————- |

Examples:

"Climate Data 2024 Catalog Entry"

"Climate Data 2023 Catalog Record"

CatalogRecord > primaryTopic #

Requirement: Mandatory

A link to the Dataset, Data service or Catalog described in the Catalog Record

Type string
Required Yes

Examples:

"https://example.gov/datasets/climate-data-2024"

"https://example.gov/datasets/climate-data-2023"

Class DataService #

A service that provides access to data or data processing functions

Type object
Additional properties Any type allowed

Example:

{
    "@type": "DataService",
    "title": "Climate Data API",
    "description": "RESTful API providing access to historical climate observations.",
    "endpointURL": [
        "https://api.example.gov/climate/v1"
    ],
    "endpointDescription": [
        "https://api.example.gov/climate/v1/openapi.json"
    ],
    "contactPoint": [
        {
            "fn": "API Support Team",
            "hasEmail": "mailto:api-support@example.gov"
        }
    ],
    "publisher": {
        "name": "National Climate Data Center"
    },
    "keyword": [
        "climate",
        "weather",
        "API"
    ],
    "license": "https://creativecommons.org/publicdomain/zero/1.0/",
    "servesDataset": [
        {
            "@id": "https://example.gov/datasets/climate-observations-2024",
            "@type": "Dataset",
            "title": "Climate Observations 2024",
            "description": "Annual climate observation data.",
            "contactPoint": {
                "fn": "Climate Support",
                "hasEmail": "mailto:climate@example.gov"
            },
            "publisher": {
                "name": "National Climate Data Center"
            },
            "identifier": "https://example.gov/datasets/climate-observations-2024"
        }
    ],
    "identifier": "https://example.gov/services/climate-api"
}
Property Type Requirement Level Title/Description
@id string Optional  
@type string Optional  
contactPoint array of Kind classes Mandatory Contact information for questions about the Data Service. Include an email address that is continuously monitored
endpointDescription null or array of string Recommended List of endpoint descriptions with operations and parameters (for example, OpenAPI or similar service documentation)
endpointURL array of string Mandatory A list of root locations or primary endpoints of the service (a Web-resolvable IRI)
keyword null or array of string Optional List of keywords or tags describing the data service
servesDataset null or array of Dataset classes Recommended List of datasets this service provides access to
spatialResolutionInMeters null or string Optional The minimum spatial separation resolvable in a Data Service, measured in meters
temporalResolution null or string Optional The minimum time period resolvable by the Data Service
theme null or array of Concept classes Optional List of themes or categories for the data service
accessRights More than one type Optional Information about whether the data service is publicly accessible, restricted, or not public
conformsTo null or array of Standard classes Optional List of general standards or specifications that the Data Service endpoints implement
created More than one type Optional The date on which the Data Service was first created
creator null or array of Agent classes Optional List of agents primarily responsible for producing the Data Service
description null or string Optional Plain-language summary of the data service
identifier More than one type Optional The unique identifier for the Data Service, e.g. the URI or other unique identifier in the context of the Catalog
otherIdentifier null or array of Identifier classes Optional A list of identifiers for the Data Service besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog
language More than one type Optional ISO 639-1 language code values supported by the data service, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html
license More than one type Recommended License that governs how the data service can be used or reused
modified More than one type Optional The most recent date on which the Data Service was changed or modified
publisher object Mandatory Person or organization responsible for publishing and making the data service available
rights null or array of string Optional Rights statements not already covered by license or accessRights, such as copyright or policy restrictions
rightsHolder null or array of Organization classes Optional A list of Agents (organizations) holding rights on the Data Service
spatial null or array of Location classes Optional A geographic region that is covered by the Data Service
temporal null or array of PeriodOfTime classes Optional Time periods covered by the data service
title string Mandatory Human-readable title of the data service
category null or array of Concept classes Optional List of high-level categories for the data service
hasQualityMeasurement null or array of QualityMeasurement classes Optional Quality measurements for the data service (for example, availability, response time, or reliability)
qualifiedAttribution null or array of Attribution classes Optional List of agents with specific responsibilities for the data service
wasUsedBy null or array of Activity classes Optional List of activities that used or tested the data service

DataService > @id #

Requirement: Optional

Type string
Format iri

Example:

"https://example.gov/data-services/climate-api-001"

DataService > @type #

Requirement: Optional

Type string
Default "DataService"

DataService > contactPoint #

Requirement: Mandatory

Contact information for questions about the Data Service. Include an email address that is continuously monitored

Type array of Kind classes
Required Yes
Each item of this array must be Description
Kind Contact information for an individual or entity

DataService > endpointDescription #

Requirement: Recommended

List of endpoint descriptions with operations and parameters (for example, OpenAPI or similar service documentation)

| Type | null or array of string | | ——– | ———————– |

Examples:

[
    "https://api.example.gov/climate/v1/openapi.json"
]

[
    "https://api.example.gov/climate/docs/openapi.json"
]
Each item of this array must be Description
endpointDescription items -

Array Item #

| Type | string | | ——– | ——– |

DataService > endpointURL #

Requirement: Mandatory

A list of root locations or primary endpoints of the service (a Web-resolvable IRI)

Type array of string
Required Yes

Examples:

[
    "https://api.example.gov/climate/v1"
]

[
    "https://api.example.gov/climate/v1",
    "https://api.example.gov/climate/v2"
]
Each item of this array must be Description
URLs The root location or primary endpoint of the service (a Web-resolvable IRI)

URLs #

The root location or primary endpoint of the service (a Web-resolvable IRI)

Type string
Format iri

DataService > keyword #

Title: keyword/tag

Requirement: Optional

List of keywords or tags describing the data service

| Type | null or array of string | | ——– | ———————– |

Examples:

[
    "climate",
    "weather",
    "API"
]

[
    "climate",
    "weather",
    "temperature",
    "API",
    "REST"
]
Each item of this array must be Description
Non-empty strings -

Non-empty strings #

| Type | string | | ——– | ——– |

Restrictions  
Min length 1

DataService > servesDataset #

Requirement: Recommended

List of datasets this service provides access to

| Type | null or array of Dataset classes | | ——– | —————————————————– |

Each item of this array must be Description
Dataset A collection of data published or curated by one provider

DataService > spatialResolutionInMeters #

Requirement: Optional

The minimum spatial separation resolvable in a Data Service, measured in meters

| Type | null or string | | ——– | —————- |

Example:

"1000"

DataService > temporalResolution #

Requirement: Optional

The minimum time period resolvable by the Data Service

| Type | null or string | | ——– | —————- |

Example:

"P1D"

DataService > theme #

Title: theme/category

Requirement: Optional

List of themes or categories for the data service

| Type | null or array of Concept classes | | ——– | —————————————————————————— |

Each item of this array must be Description
Concept A controlled term or label, optionally drawn from a concept scheme

DataService > accessRights #

Requirement: Optional

Information about whether the data service is publicly accessible, restricted, or not public

Type combining
Additional properties Any type allowed

Example:

"Public access with no restrictions"
Any of
item 0
item 1

DataService > accessRights > anyOf > item 0 #

| Type | null | | ——– | —— |

DataService > accessRights > anyOf > item 1 #

Text description of the access rights

| Type | string | | ——– | ——– |

DataService > conformsTo #

Requirement: Optional

List of general standards or specifications that the Data Service endpoints implement

| Type | null or array of Standard classes | | ——– | ——————————————————————— |

Each item of this array must be Description
Standard A standard or specification that another resource conforms to

DataService > created #

Title: creation date

Requirement: Optional

The date on which the Data Service was first created

Type combining
Additional properties Any type allowed

Examples:

"2020-01-15"

"2024-01-15T10:30:00Z"

"2024"

"2024-01"
Any of
item 0
Date string

DataService > created > anyOf > item 0 #

| Type | null | | ——– | —— |

DataService > created > anyOf > Date string #

Type combining
Additional properties Any type allowed
Any of
item 0
item 1
item 2
item 3

DataService > created > anyOf > Date string > anyOf > item 0 #

Type string
Format date-time

DataService > created > anyOf > Date string > anyOf > item 1 #

Type string
Format date

DataService > created > anyOf > Date string > anyOf > item 2 #

A year in YYYY format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}$ Test

DataService > created > anyOf > Date string > anyOf > item 3 #

A year and month in YYYY-MM format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}-[0-9]{2}$ Test

DataService > creator #

Requirement: Optional

List of agents primarily responsible for producing the Data Service

| Type | null or array of Agent classes | | ——– | ————————————————— |

Each item of this array must be Description
Agent A person, organization, software agent, or other entity involved with a resource

DataService > description #

Requirement: Optional

Plain-language summary of the data service

| Type | null or string | | ——– | —————- |

Example:

"A RESTful API providing access to historical and real-time climate data including temperature, precipitation, and atmospheric conditions."

DataService > identifier #

Requirement: Optional

The unique identifier for the Data Service, e.g. the URI or other unique identifier in the context of the Catalog

Type combining
Additional properties Any type allowed
Any of
item 0
Identifier

DataService > identifier > anyOf > item 0 #

| Type | null | | ——– | —— |

DataService > identifier > anyOf > Identifier #

inline description of Identifier

Type combining
Additional properties Any type allowed
Same definition as Identifier

DataService > otherIdentifier #

Requirement: Optional

A list of identifiers for the Data Service besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog

| Type | null or array of Identifier classes | | ——– | ———————————————————————————— |

Each item of this array must be Description
Identifier A unique identifier and optionally it’s scheme and other relevant information

DataService > language #

Requirement: Optional

ISO 639-1 language code values supported by the data service, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html

Type combining
Additional properties Any type allowed

Examples:

"en"

[
    "en",
    "es"
]
Any of
Null allowed when not required
Language code
List of lanuages

DataService > language > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

DataService > language > anyOf > Language code #

| Type | string | | ——– | ——– |

Restrictions  
Max length 2

DataService > language > anyOf > List of lanuages #

| Type | array of string | | ——– | ————— |

Each item of this array must be Description
Language code -

Language code #

| Type | string | | ——– | ——– |

Restrictions  
Max length 2

DataService > license #

Requirement: Recommended

License that governs how the data service can be used or reused

Type combining
Additional properties Any type allowed

Example:

"https://creativecommons.org/publicdomain/zero/1.0/"
Any of
Null allowed when not required
item 1

DataService > license > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

DataService > license > anyOf > item 1 #

Full text of the license

| Type | string | | ——– | ——– |

DataService > modified #

Title: update/modification date

Requirement: Optional

The most recent date on which the Data Service was changed or modified

Type combining
Additional properties Any type allowed

Examples:

"2024-03-20"

"2024-01-15T10:30:00Z"

"2024"

"2024-01"
Any of
Null allowed when not required
Date string

DataService > modified > anyOf > Null allowed when not required #

| Type | null | | ——– | —— |

DataService > modified > anyOf > Date string #

Type combining
Additional properties Any type allowed
Any of
item 0
item 1
item 2
item 3

DataService > modified > anyOf > Date string > anyOf > item 0 #

Type string
Format date-time

DataService > modified > anyOf > Date string > anyOf > item 1 #

Type string
Format date

DataService > modified > anyOf > Date string > anyOf > item 2 #

A year in YYYY format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}$ Test

DataService > modified > anyOf > Date string > anyOf > item 3 #

A year and month in YYYY-MM format

| Type | string | | ——– | ——– |

Restrictions  
Must match regular expression ^[0-9]{4}-[0-9]{2}$ Test

DataService > publisher #

Requirement: Mandatory

Person or organization responsible for publishing and making the data service available

Type object
Required Yes
Additional properties Any type allowed
Defined in Agent

DataService > rights #

Requirement: Optional

Rights statements not already covered by license or accessRights, such as copyright or policy restrictions

| Type | null or array of string | | ——– | ———————– |

Example:

[
    "Data provided by the National Climate Data Center is in the public domain."
]
Each item of this array must be Description
rights items -

Array Item #

| Type | string | | ——– | ——– |

DataService > rightsHolder #

Requirement: Optional

A list of Agents (organizations) holding rights on the Data Service

| Type | null or array of Organization classes | | ——– | —————————————————————– |

Each item of this array must be Description
Organization An organization involved with a resource, including parent or child organizations

DataService > spatial #

Title: spatial/geographic coverage

Requirement: Optional

A geographic region that is covered by the Data Service

| Type | null or array of Location classes | | ——– | ————————————————————————— |

Each item of this array must be Description
Location A named place or geographic area

DataService > temporal #

Title: temporal coverage

Requirement: Optional

Time periods covered by the data service

| Type | null or array of PeriodOfTime classes | | ——– | ————————————————————————————- |

Each item of this array must be Description
PeriodOfTime Information about a specific time period with a start- and/or end-time

DataService > title #

Requirement: Mandatory

Human-readable title of the data service

Type string
Required Yes

Example:

"Climate Data REST API"

DataService > category #

Requirement: Optional

List of high-level categories for the data service

| Type | null or array of Concept classes | | ——– | —————————————————————————— |

Each item of this array must be Description
Concept A controlled term or label, optionally drawn from a concept scheme

DataService > hasQualityMeasurement #

Title: quality measurement

Requirement: Optional

Quality measurements for the data service (for example, availability, response time, or reliability)

| Type | null or array of QualityMeasurement classes | | ——– | ———————————————————————————————— |

Each item of this array must be Description
QualityMeasurement A measurement of a resource against a specific quality metric

DataService > qualifiedAttribution #

Requirement: Optional

List of agents with specific responsibilities for the data service

| Type | null or array of Attribution classes | | ——– | ————————————————————————— |

Each item of this array must be Description
Attribution A responsibility that an agent has for a resource

DataService > wasUsedBy #

Requirement: Optional

List of activities that used or tested the data service

| Type | null or array of Activity classes | | ——– | ————————————————————————— |

Each item of this array must be Description
Activity An activity related to creating, changing, or using a resource

Class Attribution #

A responsibility that an agent has for a resource

Type object
Additional properties Any type allowed

Example:

{
    "@type": "Attribution",
    "hadRole": "Data Steward",
    "agent": {
        "name": "Environmental Data Management Office"
    }
}
Property Type Requirement Level Title/Description
@id string Optional  
@type string Optional  
hadRole string Mandatory The function of an entity or agent with respect to another entity or resource
agent object Mandatory The agent that plays a role in the resource

Attribution > @id #

Requirement: Optional

Type string
Format iri

Example:

"https://example.gov/attributions/dataset-steward-001"

Attribution > @type #

Requirement: Optional

Type string
Default "Attribution"

Attribution > hadRole #

Title: role

Requirement: Mandatory

The function of an entity or agent with respect to another entity or resource

Type string
Required Yes

Example:

"Data Steward"

Attribution > agent #

Requirement: Mandatory

The agent that plays a role in the resource

Type object
Required Yes
Additional properties Any type allowed
Defined in Agent