From b6b326074302a5c34991ce1c8c3a43ec8194d639 Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 17:20:01 -0600 Subject: [PATCH 01/13] Generate docs in a more compact way. condense into smaller format, update formatting for arrays. Co-authored-by: Copilot --- jsonschema/doc_templates/md/section_array.md | 7 + jsonschema/docs/AccessRestriction.md | 131 - jsonschema/docs/Activity.md | 99 - jsonschema/docs/Address.md | 156 - jsonschema/docs/Agent.md | 99 - jsonschema/docs/Attribution.md | 83 - jsonschema/docs/CUIRestriction.md | 125 - jsonschema/docs/CatalogRecord.md | 459 --- jsonschema/docs/Checksum.md | 89 - jsonschema/docs/Concept.md | 139 - jsonschema/docs/ConceptScheme.md | 387 --- jsonschema/docs/DataService.md | 1040 ------- jsonschema/docs/Document.md | 527 ---- jsonschema/docs/Identifier.md | 197 -- jsonschema/docs/Kind.md | 224 -- jsonschema/docs/Location.md | 562 ---- jsonschema/docs/Metric.md | 116 - jsonschema/docs/Organization.md | 190 -- jsonschema/docs/PeriodOfTime.md | 250 -- jsonschema/docs/QualityMeasurement.md | 103 - jsonschema/docs/Relationship.md | 93 - jsonschema/docs/Standard.md | 504 ---- jsonschema/docs/UseRestriction.md | 141 - jsonschema/docs/agents.md | 514 ++++ jsonschema/docs/{Catalog.md => catalog.md} | 135 +- .../docs/constraints-and-restrictions.md | 410 +++ .../{DatasetSeries.md => dataset-series.md} | 51 +- jsonschema/docs/{Dataset.md => dataset.md} | 225 +- .../docs/{Distribution.md => distribution.md} | 105 +- .../docs/identifiers-and-relationships.md | 926 ++++++ jsonschema/docs/index.md | 49 +- jsonschema/docs/quality-governance.md | 2550 +++++++++++++++++ jsonschema/docs/temporal-spatial-metrics.md | 1303 +++++++++ jsonschema/generate_schema_docs.py | 229 +- jsonschema/merge_dcat-us-docs.js | 136 + 35 files changed, 6233 insertions(+), 6121 deletions(-) delete mode 100644 jsonschema/docs/AccessRestriction.md delete mode 100644 jsonschema/docs/Activity.md delete mode 100644 jsonschema/docs/Address.md delete mode 100644 jsonschema/docs/Agent.md delete mode 100644 jsonschema/docs/Attribution.md delete mode 100644 jsonschema/docs/CUIRestriction.md delete mode 100644 jsonschema/docs/CatalogRecord.md delete mode 100644 jsonschema/docs/Checksum.md delete mode 100644 jsonschema/docs/Concept.md delete mode 100644 jsonschema/docs/ConceptScheme.md delete mode 100644 jsonschema/docs/DataService.md delete mode 100644 jsonschema/docs/Document.md delete mode 100644 jsonschema/docs/Identifier.md delete mode 100644 jsonschema/docs/Kind.md delete mode 100644 jsonschema/docs/Location.md delete mode 100644 jsonschema/docs/Metric.md delete mode 100644 jsonschema/docs/Organization.md delete mode 100644 jsonschema/docs/PeriodOfTime.md delete mode 100644 jsonschema/docs/QualityMeasurement.md delete mode 100644 jsonschema/docs/Relationship.md delete mode 100644 jsonschema/docs/Standard.md delete mode 100644 jsonschema/docs/UseRestriction.md create mode 100644 jsonschema/docs/agents.md rename jsonschema/docs/{Catalog.md => catalog.md} (88%) create mode 100644 jsonschema/docs/constraints-and-restrictions.md rename jsonschema/docs/{DatasetSeries.md => dataset-series.md} (92%) rename jsonschema/docs/{Dataset.md => dataset.md} (88%) rename jsonschema/docs/{Distribution.md => distribution.md} (88%) create mode 100644 jsonschema/docs/identifiers-and-relationships.md create mode 100644 jsonschema/docs/quality-governance.md create mode 100644 jsonschema/docs/temporal-spatial-metrics.md create mode 100644 jsonschema/merge_dcat-us-docs.js diff --git a/jsonschema/doc_templates/md/section_array.md b/jsonschema/doc_templates/md/section_array.md index 2c4d6bff..e20ddc16 100644 --- a/jsonschema/doc_templates/md/section_array.md +++ b/jsonschema/doc_templates/md/section_array.md @@ -5,13 +5,20 @@ {% endif %} {% if schema.array_items_def %} +{% set is_linked_array_item = schema.array_items_def.should_be_a_link(config) or schema.array_items_def.refers_to %} {% filter md_heading(depth+1, schema.array_items_def.html_id) %} {% with schema=schema.array_items_def %}{%- include "breadcrumbs.md" %}{% endwith %} {% endfilter %} +{% if is_linked_array_item %} +{% with schema=schema.array_items_def, skip_headers=True, depth=depth+1, skip_required=True %} + {% include "content.md" %} +{% endwith %} +{% else %} {% with schema=schema.array_items_def, skip_headers=False, depth=depth+1, skip_required=True %} {% include "content.md" %} {% endwith %} {% endif %} +{% endif %} {% if schema.tuple_validation_items %} {% for item in schema.tuple_validation_items %} diff --git a/jsonschema/docs/AccessRestriction.md b/jsonschema/docs/AccessRestriction.md deleted file mode 100644 index 333d326d..00000000 --- a/jsonschema/docs/AccessRestriction.md +++ /dev/null @@ -1,131 +0,0 @@ - - -**Title:** AccessRestriction - -Rules or indicators that describe who can access a resource - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "AccessRestriction", - "restrictionStatus": "Restricted - Fully", - "specificRestriction": "PRMPA - National Security Classified (B)", - "restrictionNote": "Access restricted to authorized personnel only." -} -``` - -| Property | Type | Title/Description | -| ---------------------------------------------- | ------------------ | -------------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [restrictionNote](#restrictionNote ) | null or string | restriction note | -| + [restrictionStatus](#restrictionStatus ) | object | restriction status | -| - [specificRestriction](#specificRestriction ) | More than one type | specific restriction | - -## [Optional] Property `AccessRestriction > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -## [Optional] Property `AccessRestriction > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | --------------------- | -| **Default** | `"AccessRestriction"` | - -## [Optional] Property `AccessRestriction > restrictionNote` - -**Title:** restriction note - -**Requirement:** Optional - -A note related to the access restriction - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"Access restricted to authorized personnel only." -``` - -## [Optional] Property `AccessRestriction > restrictionStatus` - -**Title:** restriction status - -**Requirement:** Optional - -The indication of whether or not there are access restrictions on the item, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/access-restriction-status - -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | -| **Defined in** | [Concept](./Concept.md) | - -**Examples:** - -```json -"Restricted - Fully" -``` - -```json -"Unrestricted" -``` - -## [Optional] Property `AccessRestriction > specificRestriction` - -**Title:** specific restriction - -**Requirement:** Optional - -Authority, code list entry, or policy reference that defines the specific access restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-access-restriction - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"CRCCRCA 4(1)(A)" -``` - -```json -"PRMPA - National Security Classified (B)" -``` - -| Any of(Option) | -| --------------------------------------------------------------- | -| [Null allowed when not required](#specificRestriction_anyOf_i0) | -| [Concept](#specificRestriction_anyOf_i1) | - -### Property `AccessRestriction > specificRestriction > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `AccessRestriction > specificRestriction > anyOf > Concept` - -**Title:** Concept - -inline description of the specific restriction - -| **Type** | More than one type | -| ------------------------- | --------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [restrictionStatus](#restrictionStatus) | - diff --git a/jsonschema/docs/Activity.md b/jsonschema/docs/Activity.md deleted file mode 100644 index 77bab59f..00000000 --- a/jsonschema/docs/Activity.md +++ /dev/null @@ -1,99 +0,0 @@ - - -**Title:** Activity - -An activity related to creating, changing, or using a resource - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "Activity", - "label": "Data Collection", - "category": [ - "https://example.gov/concepts/data-collection" - ] -} -``` - -| Property | Type | Title/Description | -| ------------------------ | ------------- | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [category](#category ) | null or array | category | -| + [label](#label ) | string | label | - -## [Optional] Property `Activity > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/activities/data-processing-001" -``` - -## [Optional] Property `Activity > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ------------ | -| **Default** | `"Activity"` | - -## [Optional] Property `Activity > category` - -**Title:** category - -**Requirement:** Optional - -List of categories for the Activity - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Activity > category > Concept - -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Concept](./Concept.md) | - -## [Optional] Property `Activity > label` - -**Title:** label - -**Requirement:** Optional - -A human-readable label for the activity - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"Data Collection" -``` - -```json -"Data Processing and Quality Assurance" -``` - diff --git a/jsonschema/docs/Address.md b/jsonschema/docs/Address.md deleted file mode 100644 index 6b9bd7fb..00000000 --- a/jsonschema/docs/Address.md +++ /dev/null @@ -1,156 +0,0 @@ - - -**Title:** Address - -A single physical address - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "Address", - "street-address": "151 Patton Avenue", - "locality": "Asheville", - "region": "NC", - "postal-code": "28801", - "country-name": "United States" -} -``` - -| Property | Type | Title/Description | -| ------------------------------------ | -------------- | ------------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [country-name](#country-name ) | null or string | country | -| - [locality](#locality ) | null or string | locality | -| - [postal-code](#postal-code ) | null or string | postal code | -| - [region](#region ) | null or string | administrative area | -| - [street-address](#street-address ) | null or string | street address | - -## [Optional] Property `Address > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/addresses/hq-001" -``` - -## [Optional] Property `Address > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ----------- | -| **Default** | `"Address"` | - -## [Optional] Property `Address > country-name` - -**Title:** country - -**Requirement:** Optional - -The country of the Address - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"United States" -``` - -## [Optional] Property `Address > locality` - -**Title:** locality - -**Requirement:** Optional - -The city of the Address - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"Asheville" -``` - -```json -"Washington" -``` - -## [Optional] Property `Address > postal-code` - -**Title:** postal code - -**Requirement:** Optional - -The postal code of the Address - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"28801" -``` - -```json -"20230" -``` - -## [Optional] Property `Address > region` - -**Title:** administrative area - -**Requirement:** Optional - -The administrative area of the Address. Depending on the country, this corresponds to a province, a county, a region, or a state - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"NC" -``` - -```json -"DC" -``` - -## [Optional] Property `Address > street-address` - -**Title:** street address - -**Requirement:** Optional - -The street name and civic number of an Address - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"151 Patton Avenue" -``` - -```json -"1401 Constitution Ave NW" -``` - diff --git a/jsonschema/docs/Agent.md b/jsonschema/docs/Agent.md deleted file mode 100644 index 12eb9ce7..00000000 --- a/jsonschema/docs/Agent.md +++ /dev/null @@ -1,99 +0,0 @@ - - -**Title:** Agent - -A person, organization, software agent, or other entity involved with a resource - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "Agent", - "name": "National Climate Data Center", - "category": [ - "https://example.gov/concepts/federal-agency" - ] -} -``` - -| Property | Type | Title/Description | -| ------------------------ | ------------- | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [category](#category ) | null or array | category | -| + [name](#name ) | string | name | - -## [Optional] Property `Agent > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/agents/data-steward-001" -``` - -## [Optional] Property `Agent > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | --------- | -| **Default** | `"Agent"` | - -## [Optional] Property `Agent > category` - -**Title:** category - -**Requirement:** Optional - -The type of the agent that makes the item available - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Agent > category > Concept - -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Concept](./Concept.md) | - -## [Optional] Property `Agent > name` - -**Title:** name - -**Requirement:** Optional - -The name of the agent - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"National Climate Data Center" -``` - -```json -"U.S. Department of Commerce Data Stewardship Office" -``` - diff --git a/jsonschema/docs/Attribution.md b/jsonschema/docs/Attribution.md deleted file mode 100644 index 9650ea6a..00000000 --- a/jsonschema/docs/Attribution.md +++ /dev/null @@ -1,83 +0,0 @@ - - -**Title:** Attribution - -A responsibility that an agent has for a resource - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "Attribution", - "hadRole": "Data Steward", - "agent": { - "name": "Environmental Data Management Office" - } -} -``` - -| Property | Type | Title/Description | -| ---------------------- | ------ | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| + [hadRole](#hadRole ) | string | role | -| + [agent](#agent ) | object | agent | - -## [Optional] Property `Attribution > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/attributions/dataset-steward-001" -``` - -## [Optional] Property `Attribution > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | --------------- | -| **Default** | `"Attribution"` | - -## [Optional] Property `Attribution > hadRole` - -**Title:** role - -**Requirement:** Optional - -The function of an entity or agent with respect to another entity or resource - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Example:** - -```json -"Data Steward" -``` - -## [Optional] Property `Attribution > agent` - -**Title:** agent - -**Requirement:** Optional - -The agent that plays a role in the resource - -| **Type** | `object` | -| ------------------------- | ------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | -| **Defined in** | [Agent](./Agent.md) | - diff --git a/jsonschema/docs/CUIRestriction.md b/jsonschema/docs/CUIRestriction.md deleted file mode 100644 index 9949d825..00000000 --- a/jsonschema/docs/CUIRestriction.md +++ /dev/null @@ -1,125 +0,0 @@ - - -**Title:** CUIRestriction - -Information describing Controlled Unclassified Information (CUI) restrictions for a resource - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "CUIRestriction", - "cuiBannerMarking": "CUI//SP-CTI", - "designationIndicator": "Controlled by: Agency XYZ" -} -``` - -| Property | Type | Title/Description | -| ------------------------------------------------------------------ | ----------------------- | -------------------------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| + [cuiBannerMarking](#cuiBannerMarking ) | string | CUI banner marking | -| + [designationIndicator](#designationIndicator ) | string | CUI designation indicator | -| - [requiredIndicatorPerAuthority](#requiredIndicatorPerAuthority ) | null or array of string | required indicator per authority | - -## [Optional] Property `CUIRestriction > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/cui-restrictions/dataset-001" -``` - -## [Optional] Property `CUIRestriction > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ------------------ | -| **Default** | `"CUIRestriction"` | - -## [Optional] Property `CUIRestriction > cuiBannerMarking` - -**Title:** CUI banner marking - -**Requirement:** Optional - -CUI (Controlled Unclassified Information) banner marking is required for any unclassified information that is deemed sensitive and requires protection; see information at https://www.archives.gov/cui/registry/category-marking-list - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"CUI//SP-CTI" -``` - -```json -"CUI//SP-PRVCY//SP-LEGAL" -``` - -## [Optional] Property `CUIRestriction > designationIndicator` - -**Title:** CUI designation indicator - -**Requirement:** Optional - -Agency that designated the information as CUI; include at least "Controlled by:" and, when possible, contact information - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"Controlled by: Agency XYZ" -``` - -```json -"Controlled by: DOC; POC: Jane Smith, mailto:jane.smith@example.gov, XXX-XXX-XXXX" -``` - -## [Optional] Property `CUIRestriction > requiredIndicatorPerAuthority` - -**Title:** required indicator per authority - -**Requirement:** Optional - -List of free-text required indicators from the applicable authority (for example, category descriptions or distribution statements) - -| **Type** | `null or array of string` | -| -------- | ------------------------- | - -**Example:** - -```json -[ - "Privacy Act of 1974", - "Federal Records Act" -] -``` - -| Each item of this array must be | Description | -| -------------------------------------------------------- | ----------- | -| [Indicator string](#requiredIndicatorPerAuthority_items) | - | - -### CUIRestriction > requiredIndicatorPerAuthority > Indicator string - -**Title:** Indicator string - -| **Type** | `string` | -| -------- | -------- | - diff --git a/jsonschema/docs/CatalogRecord.md b/jsonschema/docs/CatalogRecord.md deleted file mode 100644 index 73a9e0dd..00000000 --- a/jsonschema/docs/CatalogRecord.md +++ /dev/null @@ -1,459 +0,0 @@ - - -**Title:** CatalogRecord - -A record in a catalog, describing the registration of a single resource - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@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 | Title/Description | -| -------------------------------- | ----------------------- | ------------------------ | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [status](#status ) | More than one type | change type | -| - [conformsTo](#conformsTo ) | More than one type | application profile | -| - [description](#description ) | null or array of string | Descriptions | -| - [issued](#issued ) | null or array | listing date | -| - [language](#language ) | More than one type | language | -| + [modified](#modified ) | More than one type | update/modification date | -| - [source](#source ) | null or string | source metadata | -| - [title](#title ) | null or string | title | -| + [primaryTopic](#primaryTopic ) | string | primary topic | - -## [Optional] Property `CatalogRecord > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/catalog-records/climate-dataset-record-001" -``` - -## [Optional] Property `CatalogRecord > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ----------------- | -| **Default** | `"CatalogRecord"` | - -## [Optional] Property `CatalogRecord > status` - -**Title:** change type - -**Requirement:** Optional - -The status of the catalog record in the context of editorial flow of the dataset and data service descriptions - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| -------------------------------------------------- | -| [Null allowed when not required](#status_anyOf_i0) | -| [Concept](#status_anyOf_i1) | - -### Property `CatalogRecord > status > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `CatalogRecord > status > anyOf > Concept` - -**Title:** Concept - -inline description of status - -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Concept](./Concept.md) | - -## [Optional] Property `CatalogRecord > conformsTo` - -**Title:** application profile - -**Requirement:** Optional - -An Application Profile that the Catalog Record's metadata conforms to - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------------------------ | -| [Null allowed when not required](#conformsTo_anyOf_i0) | -| [Standard](#conformsTo_anyOf_i1) | - -### Property `CatalogRecord > conformsTo > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `CatalogRecord > conformsTo > anyOf > Standard` - -**Title:** Standard - -inline description of application profile - -| **Type** | `object` | -| ------------------------- | ------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Standard](./Standard.md) | - -## [Optional] Property `CatalogRecord > description` - -**Title:** Descriptions - -**Requirement:** Optional - -A list of free-text accounts of the catalog record - -| **Type** | `null or array of string` | -| -------- | ------------------------- | - -**Example:** - -```json -[ - "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_items) | - | - -### CatalogRecord > description > Description string - -**Title:** Description string - -| **Type** | `string` | -| -------- | -------- | - -## [Optional] Property `CatalogRecord > issued` - -**Title:** listing date - -**Requirement:** Optional - -List of dates on which the catalog record was included in the catalog - -| **Type** | `null or array` | -| -------- | --------------- | - -**Examples:** - -```json -[ - "2024-01-15T10:30:00Z" -] -``` - -```json -[ - "2024-01-15" -] -``` - -```json -[ - "2024" -] -``` - -```json -[ - "2024-01" -] -``` - -| Each item of this array must be | Description | -| ------------------------------- | ----------- | -| [Date string](#issued_items) | - | - -### CatalogRecord > issued > Date string - -**Title:** Date string - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| -------------------------------- | -| [item 0](#issued_items_anyOf_i0) | -| [item 1](#issued_items_anyOf_i1) | -| [item 2](#issued_items_anyOf_i2) | -| [item 3](#issued_items_anyOf_i3) | - -#### Property `CatalogRecord > issued > Date string > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `CatalogRecord > issued > Date string > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `CatalogRecord > issued > Date string > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `CatalogRecord > language` - -**Title:** 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** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"en" -``` - -```json -[ - "en", - "es" -] -``` - -| Any of(Option) | -| ---------------------------------------------------- | -| [Null allowed when not required](#language_anyOf_i0) | -| [Language code](#language_anyOf_i1) | -| [Array of language codes](#language_anyOf_i2) | - -### Property `CatalogRecord > language > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `CatalogRecord > language > anyOf > Language code` - -**Title:** Language code - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| -------------- | - | -| **Max length** | 2 | - -### Property `CatalogRecord > language > anyOf > Array of language codes` - -**Title:** Array of language codes - -| **Type** | `array of string` | -| -------- | ----------------- | - -| Each item of this array must be | Description | -| ----------------------------------------- | ----------- | -| [Language code](#language_anyOf_i2_items) | - | - -#### CatalogRecord > language > anyOf > Array of language codes > Language code - -**Title:** Language code - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| -------------- | - | -| **Max length** | 2 | - -## [Optional] Property `CatalogRecord > modified` - -**Title:** update/modification date - -**Requirement:** Optional - -The most recent date on which the catalog record was changed or modified - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Required** | Yes | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2024-06-15" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| ---------------------------- | -| [item 0](#modified_anyOf_i0) | -| [item 1](#modified_anyOf_i1) | -| [item 2](#modified_anyOf_i2) | -| [item 3](#modified_anyOf_i3) | - -### Property `CatalogRecord > modified > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -### Property `CatalogRecord > modified > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -### Property `CatalogRecord > modified > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `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:** - -```json -"Original metadata harvested from NOAA data portal" -``` - -## [Optional] Property `CatalogRecord > title` - -**Title:** title - -**Requirement:** Optional - -A name given to the Catalog Record - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"Climate Data 2024 Catalog Entry" -``` - -```json -"Climate Data 2023 Catalog Record" -``` - -## [Optional] Property `CatalogRecord > primaryTopic` - -**Title:** primary topic - -**Requirement:** Optional - -A link to the Dataset, Data service or Catalog described in the Catalog Record - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"https://example.gov/datasets/climate-data-2024" -``` - -```json -"https://example.gov/datasets/climate-data-2023" -``` - diff --git a/jsonschema/docs/Checksum.md b/jsonschema/docs/Checksum.md deleted file mode 100644 index eba6b9af..00000000 --- a/jsonschema/docs/Checksum.md +++ /dev/null @@ -1,89 +0,0 @@ - - -**Title:** Checksum - -A mechanism that can be used to verify that the contents of a distribution have not changed - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "Checksum", - "algorithm": "SHA-256", - "checksumValue": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456" -} -``` - -| Property | Type | Title/Description | -| ---------------------------------- | ------ | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| + [algorithm](#algorithm ) | string | algorithm | -| + [checksumValue](#checksumValue ) | string | checksum value | - -## [Optional] Property `Checksum > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/checksums/dataset-001-sha256" -``` - -## [Optional] Property `Checksum > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ------------ | -| **Default** | `"Checksum"` | - -## [Optional] Property `Checksum > algorithm` - -**Title:** algorithm - -**Requirement:** Optional - -The algorithm used to produce the checksum - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Example:** - -```json -"SHA-256" -``` - -## [Optional] Property `Checksum > checksumValue` - -**Title:** checksum value - -**Requirement:** Optional - -A lower case hexadecimal encoded digest value produced using a specific algorithm - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456" -``` - -```json -"a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e" -``` - diff --git a/jsonschema/docs/Concept.md b/jsonschema/docs/Concept.md deleted file mode 100644 index 91b6aaf1..00000000 --- a/jsonschema/docs/Concept.md +++ /dev/null @@ -1,139 +0,0 @@ - - -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| -------------------- | -| [Concept](#anyOf_i0) | -| [item 1](#anyOf_i1) | - -## Property `Concept > anyOf > Concept` - -**Title:** Concept - -The value of the concept, expressed as a string. This is only used when the concept is not further described by the properties of the Concept object and is not linked to a concept scheme. - -| **Type** | `string` | -| -------- | -------- | - -## Property `Concept > anyOf > item 1` - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -| Property | Type | Title/Description | -| ------------------------------------- | ------------------ | ----------------- | -| - [@id](#anyOf_i1_@id ) | string | - | -| - [@type](#anyOf_i1_@type ) | string | - | -| - [altLabel](#anyOf_i1_altLabel ) | null or string | alternate label | -| - [definition](#anyOf_i1_definition ) | null or string | definition | -| - [inScheme](#anyOf_i1_inScheme ) | object | in scheme | -| - [notation](#anyOf_i1_notation ) | More than one type | notation | -| + [prefLabel](#anyOf_i1_prefLabel ) | string | preferred label | - -### Property `Concept > anyOf > item 1 > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -### Property `Concept > anyOf > item 1 > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ----------- | -| **Default** | `"Concept"` | - -### Property `Concept > anyOf > item 1 > altLabel` - -**Title:** alternate label - -**Requirement:** Optional - -Alternative label for a concept - -| **Type** | `null or string` | -| -------- | ---------------- | - -### Property `Concept > anyOf > item 1 > definition` - -**Title:** definition - -**Requirement:** Optional - -Definition of the controlled vocabulary term - -| **Type** | `null or string` | -| -------- | ---------------- | - -### Property `Concept > anyOf > item 1 > inScheme` - -**Title:** in scheme - -**Requirement:** Optional - -Concept scheme defining this concept - -| **Type** | `object` | -| ------------------------- | ----------------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Conceptscheme](./Conceptscheme.md) | - -### Property `Concept > anyOf > item 1 > notation` - -**Title:** notation - -**Requirement:** Optional - -List of abbreviations or codes from code lists for the Concept - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------- | -| [item 0](#anyOf_i1_notation_anyOf_i0) | -| [item 1](#anyOf_i1_notation_anyOf_i1) | - -#### Property `Concept > anyOf > item 1 > notation > anyOf > item 0` - -| **Type** | `null` | -| -------- | ------ | - -#### Property `Concept > anyOf > item 1 > notation > anyOf > item 1` - -| **Type** | `array of string` | -| -------- | ----------------- | - -| Each item of this array must be | Description | -| ------------------------------------------------- | ----------- | -| [item 1 items](#anyOf_i1_notation_anyOf_i1_items) | - | - -##### Concept > anyOf > item 1 > notation > anyOf > item 1 > item 1 items - -| **Type** | `string` | -| -------- | -------- | - -### Property `Concept > anyOf > item 1 > prefLabel` - -**Title:** preferred label - -**Requirement:** Optional - -Preferred label for the term - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - diff --git a/jsonschema/docs/ConceptScheme.md b/jsonschema/docs/ConceptScheme.md deleted file mode 100644 index c1dc1f9b..00000000 --- a/jsonschema/docs/ConceptScheme.md +++ /dev/null @@ -1,387 +0,0 @@ - - -**Title:** ConceptScheme - -A controlled vocabulary or other list of approved terms for a concept - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "ConceptScheme", - "title": "Science Domains", - "description": "A classification scheme for scientific research domains.", - "issued": "2020-01-01" -} -``` - -| Property | Type | Title/Description | -| ------------------------------ | ------------------ | ------------------------ | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [version](#version ) | null or string | version info | -| - [created](#created ) | More than one type | creation date | -| - [description](#description ) | null or string | description | -| - [issued](#issued ) | More than one type | publication date | -| - [modified](#modified ) | More than one type | update/modification date | -| + [title](#title ) | string | title | - -## [Optional] Property `ConceptScheme > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/concept-schemes/data-classification" -``` - -## [Optional] Property `ConceptScheme > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ----------------- | -| **Default** | `"ConceptScheme"` | - -## [Optional] Property `ConceptScheme > version` - -**Title:** version info - -**Requirement:** Optional - -A version number or other version designation of the concept scheme - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"2.0.1" -``` - -## [Optional] Property `ConceptScheme > created` - -**Title:** creation date - -**Requirement:** Optional - -The date on which the Concept Scheme was first created - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2020" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024-01-15" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| --------------------------------------------------- | -| [Null allowed when not required](#created_anyOf_i0) | -| [Date string](#created_anyOf_i1) | - -### Property `ConceptScheme > created > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `ConceptScheme > created > anyOf > Date string` - -**Title:** Date string - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------ | -| [item 0](#created_anyOf_i1_anyOf_i0) | -| [item 1](#created_anyOf_i1_anyOf_i1) | -| [item 2](#created_anyOf_i1_anyOf_i2) | -| [item 3](#created_anyOf_i1_anyOf_i3) | - -#### Property `ConceptScheme > created > anyOf > Date string > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `ConceptScheme > created > anyOf > Date string > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `ConceptScheme > created > anyOf > Date string > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `ConceptScheme > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `ConceptScheme > description` - -**Title:** description - -**Requirement:** Optional - -A description of the concept scheme - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"A classification scheme for scientific research domains." -``` - -```json -"A controlled vocabulary for classifying federal government data assets by sensitivity and access requirements." -``` - -## [Optional] Property `ConceptScheme > issued` - -**Title:** publication date - -**Requirement:** Optional - -The date of formal issuance (e.g., publication) of the concept scheme - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2020-01-01" -``` - -```json -"2020" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| -------------------------------------------------- | -| [Null allowed when not required](#issued_anyOf_i0) | -| [Date string](#issued_anyOf_i1) | - -### Property `ConceptScheme > issued > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `ConceptScheme > issued > anyOf > Date string` - -**Title:** Date string - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ----------------------------------- | -| [item 0](#issued_anyOf_i1_anyOf_i0) | -| [item 1](#issued_anyOf_i1_anyOf_i1) | -| [item 2](#issued_anyOf_i1_anyOf_i2) | -| [item 3](#issued_anyOf_i1_anyOf_i3) | - -#### Property `ConceptScheme > issued > anyOf > Date string > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `ConceptScheme > issued > anyOf > Date string > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `ConceptScheme > issued > anyOf > Date string > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `ConceptScheme > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `ConceptScheme > modified` - -**Title:** update/modification date - -**Requirement:** Optional - -The most recent date at which the concept scheme was changed or modified - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2024" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024-01-15" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| ---------------------------------------------------- | -| [Null allowed when not required](#modified_anyOf_i0) | -| [Date string](#modified_anyOf_i1) | - -### Property `ConceptScheme > modified > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `ConceptScheme > modified > anyOf > Date string` - -**Title:** Date string - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------- | -| [item 0](#modified_anyOf_i1_anyOf_i0) | -| [item 1](#modified_anyOf_i1_anyOf_i1) | -| [item 2](#modified_anyOf_i1_anyOf_i2) | -| [item 3](#modified_anyOf_i1_anyOf_i3) | - -#### Property `ConceptScheme > modified > anyOf > Date string > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `ConceptScheme > modified > anyOf > Date string > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `ConceptScheme > modified > anyOf > Date string > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `ConceptScheme > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `ConceptScheme > title` - -**Title:** title - -**Requirement:** Optional - -The title of the concept scheme - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"Science Domains" -``` - -```json -"Federal Data Classification Scheme" -``` - diff --git a/jsonschema/docs/DataService.md b/jsonschema/docs/DataService.md deleted file mode 100644 index 996a5fc5..00000000 --- a/jsonschema/docs/DataService.md +++ /dev/null @@ -1,1040 +0,0 @@ - - -**Title:** DataService - -A service that provides access to data or data processing functions - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@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 | Title/Description | -| ---------------------------------------------------------- | ----------------------- | ---------------------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| + [contactPoint](#contactPoint ) | array | contact point | -| - [endpointDescription](#endpointDescription ) | null or array of string | endpoint description | -| + [endpointURL](#endpointURL ) | array of string | endpoint URL | -| - [keyword](#keyword ) | null or array of string | keyword/tag | -| - [servesDataset](#servesDataset ) | null or array | serves dataset | -| - [spatialResolutionInMeters](#spatialResolutionInMeters ) | null or string | spatial resolution in meters | -| - [temporalResolution](#temporalResolution ) | null or string | temporal resolution | -| - [theme](#theme ) | null or array | theme/category | -| - [accessRights](#accessRights ) | More than one type | access rights | -| - [conformsTo](#conformsTo ) | null or array | conforms to | -| - [created](#created ) | More than one type | creation date | -| - [creator](#creator ) | null or array | creator | -| - [description](#description ) | null or string | description | -| - [identifier](#identifier ) | More than one type | identifier | -| - [otherIdentifier](#otherIdentifier ) | null or array | other identifier | -| - [language](#language ) | More than one type | language | -| - [license](#license ) | More than one type | license | -| - [modified](#modified ) | More than one type | update/modification date | -| + [publisher](#publisher ) | object | publisher | -| - [rights](#rights ) | null or array of string | rights | -| - [rightsHolder](#rightsHolder ) | null or array | rights holder | -| - [spatial](#spatial ) | null or array | spatial/geographic coverage | -| - [temporal](#temporal ) | null or array | temporal coverage | -| + [title](#title ) | string | title | -| - [category](#category ) | null or array | category | -| - [hasQualityMeasurement](#hasQualityMeasurement ) | null or array | quality measurement | -| - [qualifiedAttribution](#qualifiedAttribution ) | null or array | qualified attribution | -| - [wasUsedBy](#wasUsedBy ) | null or array | was used by | - -## [Optional] Property `DataService > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/data-services/climate-api-001" -``` - -## [Optional] Property `DataService > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | --------------- | -| **Default** | `"DataService"` | - -## [Optional] Property `DataService > contactPoint` - -**Title:** contact point - -**Requirement:** Optional - -Contact information for questions about the Data Service. Include an email address that is continuously monitored - -| **Type** | `array` | -| ------------ | ------- | -| **Required** | Yes | - -| Each item of this array must be | Description | -| ------------------------------- | ----------------------------------------------- | -| [Kind](#contactPoint_items) | Contact information for an individual or entity | - -### DataService > contactPoint > Kind - -**Title:** Kind - -Contact information for an individual or entity - -| **Type** | `object` | -| ------------------------- | ----------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Kind](./Kind.md) | - -## [Optional] Property `DataService > endpointDescription` - -**Title:** endpoint description - -**Requirement:** Optional - -List of endpoint descriptions with operations and parameters (for example, OpenAPI or similar service documentation) - -| **Type** | `null or array of string` | -| -------- | ------------------------- | - -**Examples:** - -```json -[ - "https://api.example.gov/climate/v1/openapi.json" -] -``` - -```json -[ - "https://api.example.gov/climate/docs/openapi.json" -] -``` - -| Each item of this array must be | Description | -| ------------------------------------------------------- | ----------- | -| [endpointDescription items](#endpointDescription_items) | - | - -### DataService > endpointDescription > endpointDescription items - -| **Type** | `string` | -| -------- | -------- | - -## [Optional] Property `DataService > endpointURL` - -**Title:** endpoint URL - -**Requirement:** Optional - -A list of root locations or primary endpoints of the service (a Web-resolvable IRI) - -| **Type** | `array of string` | -| ------------ | ----------------- | -| **Required** | Yes | - -**Examples:** - -```json -[ - "https://api.example.gov/climate/v1" -] -``` - -```json -[ - "https://api.example.gov/climate/v1", - "https://api.example.gov/climate/v2" -] -``` - -| Each item of this array must be | Description | -| ------------------------------- | --------------------------------------------------------------------------- | -| [URLs](#endpointURL_items) | The root location or primary endpoint of the service (a Web-resolvable IRI) | - -### DataService > endpointURL > URLs - -**Title:** URLs - -The root location or primary endpoint of the service (a Web-resolvable IRI) - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -## [Optional] Property `DataService > keyword` - -**Title:** keyword/tag - -**Requirement:** Optional - -List of keywords or tags describing the data service - -| **Type** | `null or array of string` | -| -------- | ------------------------- | - -**Examples:** - -```json -[ - "climate", - "weather", - "API" -] -``` - -```json -[ - "climate", - "weather", - "temperature", - "API", - "REST" -] -``` - -| Each item of this array must be | Description | -| ----------------------------------- | ----------- | -| [Non-empty strings](#keyword_items) | - | - -### DataService > keyword > Non-empty strings - -**Title:** Non-empty strings - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| -------------- | - | -| **Min length** | 1 | - -## [Optional] Property `DataService > servesDataset` - -**Title:** serves dataset - -**Requirement:** Optional - -List of datasets this service provides access to - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | --------------------------------------------------------- | -| [Dataset](#servesDataset_items) | A collection of data published or curated by one provider | - -### DataService > servesDataset > Dataset - -**Title:** Dataset - -A collection of data published or curated by one provider - -| **Type** | `object` | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Dataset](./Dataset.md) | - -## [Optional] Property `DataService > spatialResolutionInMeters` - -**Title:** spatial resolution in meters - -**Requirement:** Optional - -The minimum spatial separation resolvable in a Data Service, measured in meters - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"1000" -``` - -## [Optional] Property `DataService > temporalResolution` - -**Title:** temporal resolution - -**Requirement:** Optional - -The minimum time period resolvable by the Data Service - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"P1D" -``` - -## [Optional] Property `DataService > theme` - -**Title:** theme/category - -**Requirement:** Optional - -List of themes or categories for the data service - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#theme_items) | A controlled term or label, optionally drawn from a concept scheme | - -### DataService > theme > Concept - -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - -| **Type** | More than one type | -| ------------------------- | ----------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#servesDataset_items_sample_items_representationTechnique_anyOf_i1) | - -## [Optional] Property `DataService > accessRights` - -**Title:** access rights - -**Requirement:** Optional - -Information about whether the data service is publicly accessible, restricted, or not public - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -"Public access with no restrictions" -``` - -| Any of(Option) | -| -------------------------------- | -| [item 0](#accessRights_anyOf_i0) | -| [item 1](#accessRights_anyOf_i1) | - -### Property `DataService > accessRights > anyOf > item 0` - -| **Type** | `null` | -| -------- | ------ | - -### Property `DataService > accessRights > anyOf > item 1` - -Text description of the access rights - -| **Type** | `string` | -| -------- | -------- | - -## [Optional] Property `DataService > conformsTo` - -**Title:** conforms to - -**Requirement:** Optional - -List of general standards or specifications that the Data Service endpoints implement - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------- | -| [Standard](#conformsTo_items) | A standard or specification that another resource conforms to | - -### DataService > conformsTo > Standard - -**Title:** Standard - -A standard or specification that another resource conforms to - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Standard](#servesDataset_items_sample_items_accessService_items_conformsTo_items) | - -## [Optional] Property `DataService > created` - -**Title:** creation date - -**Requirement:** Optional - -The date on which the Data Service was first created - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2020-01-15" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| -------------------------------- | -| [item 0](#created_anyOf_i0) | -| [Date string](#created_anyOf_i1) | - -### Property `DataService > created > anyOf > item 0` - -| **Type** | `null` | -| -------- | ------ | - -### Property `DataService > created > anyOf > Date string` - -**Title:** Date string - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------ | -| [item 0](#created_anyOf_i1_anyOf_i0) | -| [item 1](#created_anyOf_i1_anyOf_i1) | -| [item 2](#created_anyOf_i1_anyOf_i2) | -| [item 3](#created_anyOf_i1_anyOf_i3) | - -#### Property `DataService > created > anyOf > Date string > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `DataService > created > anyOf > Date string > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `DataService > created > anyOf > Date string > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `DataService > creator` - -**Title:** creator - -**Requirement:** Optional - -List of agents primarily responsible for producing the Data Service - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | -------------------------------------------------------------------------------- | -| [Agent](#creator_items) | A person, organization, software agent, or other entity involved with a resource | - -### DataService > creator > Agent - -**Title:** Agent - -A person, organization, software agent, or other entity involved with a resource - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Agent](#servesDataset_items_sample_items_accessService_items_creator_items) | - -## [Optional] Property `DataService > description` - -**Title:** description - -**Requirement:** Optional - -Plain-language summary of the data service - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"A RESTful API providing access to historical and real-time climate data including temperature, precipitation, and atmospheric conditions." -``` - -## [Optional] Property `DataService > identifier` - -**Title:** 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** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ---------------------------------- | -| [item 0](#identifier_anyOf_i0) | -| [Identifier](#identifier_anyOf_i1) | - -### Property `DataService > identifier > anyOf > item 0` - -| **Type** | `null` | -| -------- | ------ | - -### Property `DataService > identifier > anyOf > Identifier` - -**Title:** Identifier - -inline description of Identifier - -| **Type** | More than one type | -| ------------------------- | -------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#servesDataset_items_otherIdentifier_items) | - -## [Optional] Property `DataService > otherIdentifier` - -**Title:** other identifier - -**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` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### DataService > otherIdentifier > Identifier - -**Title:** Identifier - -A unique identifier and optionally it's scheme and other relevant information - -| **Type** | More than one type | -| ------------------------- | -------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#servesDataset_items_otherIdentifier_items) | - -## [Optional] Property `DataService > language` - -**Title:** 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** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"en" -``` - -```json -[ - "en", - "es" -] -``` - -| Any of(Option) | -| ---------------------------------------------------- | -| [Null allowed when not required](#language_anyOf_i0) | -| [Language code](#language_anyOf_i1) | -| [List of lanuages](#language_anyOf_i2) | - -### Property `DataService > language > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `DataService > language > anyOf > Language code` - -**Title:** Language code - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| -------------- | - | -| **Max length** | 2 | - -### Property `DataService > language > anyOf > List of lanuages` - -**Title:** List of lanuages - -| **Type** | `array of string` | -| -------- | ----------------- | - -| Each item of this array must be | Description | -| ----------------------------------------- | ----------- | -| [Language code](#language_anyOf_i2_items) | - | - -#### DataService > language > anyOf > List of lanuages > Language code - -**Title:** Language code - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| -------------- | - | -| **Max length** | 2 | - -## [Optional] Property `DataService > license` - -**Title:** license - -**Requirement:** Optional - -License that governs how the data service can be used or reused - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -"https://creativecommons.org/publicdomain/zero/1.0/" -``` - -| Any of(Option) | -| --------------------------------------------------- | -| [Null allowed when not required](#license_anyOf_i0) | -| [item 1](#license_anyOf_i1) | - -### Property `DataService > license > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `DataService > license > anyOf > item 1` - -Full text of the license - -| **Type** | `string` | -| -------- | -------- | - -## [Optional] Property `DataService > modified` - -**Title:** update/modification date - -**Requirement:** Optional - -The most recent date on which the Data Service was changed or modified - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2024-03-20" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| ---------------------------------------------------- | -| [Null allowed when not required](#modified_anyOf_i0) | -| [Date string](#modified_anyOf_i1) | - -### Property `DataService > modified > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `DataService > modified > anyOf > Date string` - -**Title:** Date string - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------- | -| [item 0](#modified_anyOf_i1_anyOf_i0) | -| [item 1](#modified_anyOf_i1_anyOf_i1) | -| [item 2](#modified_anyOf_i1_anyOf_i2) | -| [item 3](#modified_anyOf_i1_anyOf_i3) | - -#### Property `DataService > modified > anyOf > Date string > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `DataService > modified > anyOf > Date string > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `DataService > modified > anyOf > Date string > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `DataService > publisher` - -**Title:** publisher - -**Requirement:** Optional - -Person or organization responsible for publishing and making the data service available - -| **Type** | `object` | -| ------------------------- | ------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | -| **Defined in** | [Agent](./Agent.md) | - -## [Optional] Property `DataService > rights` - -**Title:** 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:** - -```json -[ - "Data provided by the National Climate Data Center is in the public domain." -] -``` - -| Each item of this array must be | Description | -| ------------------------------- | ----------- | -| [rights items](#rights_items) | - | - -### DataService > rights > rights items - -| **Type** | `string` | -| -------- | -------- | - -## [Optional] Property `DataService > rightsHolder` - -**Title:** rights holder - -**Requirement:** Optional - -A list of Agents (organizations) holding rights on the Data Service - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ----------------------------------- | --------------------------------------------------------------------------------- | -| [Organization](#rightsHolder_items) | An organization involved with a resource, including parent or child organizations | - -### DataService > rightsHolder > Organization - -**Title:** Organization - -An organization involved with a resource, including parent or child organizations - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Organization](#servesDataset_items_otherIdentifier_items_anyOf_i1_creator_anyOf_i1) | - -## [Optional] Property `DataService > spatial` - -**Title:** spatial/geographic coverage - -**Requirement:** Optional - -A geographic region that is covered by the Data Service - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | -------------------------------- | -| [Location](#spatial_items) | A named place or geographic area | - -### DataService > spatial > Location - -**Title:** Location - -A named place or geographic area - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Location](#servesDataset_items_sample_items_accessService_items_spatial_items) | - -## [Optional] Property `DataService > temporal` - -**Title:** temporal coverage - -**Requirement:** Optional - -Time periods covered by the data service - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ---------------------------------------------------------------------- | -| [PeriodOfTime](#temporal_items) | Information about a specific time period with a start- and/or end-time | - -### DataService > temporal > PeriodOfTime - -**Title:** PeriodOfTime - -Information about a specific time period with a start- and/or end-time - -| **Type** | More than one type | -| ------------------------- | ------------------------------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [PeriodOfTime](#servesDataset_items_sample_items_accessService_items_temporal_items) | - -## [Optional] Property `DataService > title` - -**Title:** title - -**Requirement:** Optional - -Human-readable title of the data service - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Example:** - -```json -"Climate Data REST API" -``` - -## [Optional] Property `DataService > category` - -**Title:** category - -**Requirement:** Optional - -List of high-level categories for the data service - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### DataService > category > Concept - -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - -| **Type** | More than one type | -| ------------------------- | ----------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#servesDataset_items_sample_items_representationTechnique_anyOf_i1) | - -## [Optional] Property `DataService > hasQualityMeasurement` - -**Title:** quality measurement - -**Requirement:** Optional - -Quality measurements for the data service (for example, availability, response time, or reliability) - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| -------------------------------------------------- | ------------------------------------------------------------- | -| [QualityMeasurement](#hasQualityMeasurement_items) | A measurement of a resource against a specific quality metric | - -### DataService > hasQualityMeasurement > QualityMeasurement - -**Title:** QualityMeasurement - -A measurement of a resource against a specific quality metric - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [QualityMeasurement](#servesDataset_items_sample_items_accessService_items_hasQualityMeasurement_items) | - -## [Optional] Property `DataService > qualifiedAttribution` - -**Title:** qualified attribution - -**Requirement:** Optional - -List of agents with specific responsibilities for the data service - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------------------ | ------------------------------------------------- | -| [Attribution](#qualifiedAttribution_items) | A responsibility that an agent has for a resource | - -### DataService > qualifiedAttribution > Attribution - -**Title:** Attribution - -A responsibility that an agent has for a resource - -| **Type** | `object` | -| ------------------------- | ----------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Attribution](#servesDataset_items_sample_items_accessService_items_qualifiedAttribution_items) | - -## [Optional] Property `DataService > wasUsedBy` - -**Title:** was used by - -**Requirement:** Optional - -List of activities that used or tested the data service - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | -------------------------------------------------------------- | -| [Activity](#wasUsedBy_items) | An activity related to creating, changing, or using a resource | - -### DataService > wasUsedBy > Activity - -**Title:** Activity - -An activity related to creating, changing, or using a resource - -| **Type** | `object` | -| ------------------------- | --------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Activity](#servesDataset_items_sample_items_accessService_items_wasUsedBy_items) | - diff --git a/jsonschema/docs/Document.md b/jsonschema/docs/Document.md deleted file mode 100644 index 83a2a0fb..00000000 --- a/jsonschema/docs/Document.md +++ /dev/null @@ -1,527 +0,0 @@ - - -**Title:** Document - -A publication or other document related to a resource - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@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 | Title/Description | -| -------------------------------------------------- | ------------------ | ---------------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [accessURL](#accessURL ) | More than one type | access URL | -| - [downloadURL](#downloadURL ) | More than one type | download URL | -| - [creator](#creator ) | null or array | author | -| - [mediaType](#mediaType ) | null or string | media type | -| - [abstract](#abstract ) | null or string | abstract | -| - [bibliographicCitation](#bibliographicCitation ) | null or string | bibliographic citation | -| - [conformsTo](#conformsTo ) | null or array | conforms to | -| - [corporateCreator](#corporateCreator ) | null or array | corporate author | -| - [description](#description ) | null or string | description | -| - [identifier](#identifier ) | More than one type | identifier | -| - [otherIdentifier](#otherIdentifier ) | null or array | other identifier | -| - [issued](#issued ) | More than one type | publication date | -| - [publisher](#publisher ) | null or array | publisher | -| + [title](#title ) | string | title | -| - [category](#category ) | null or array | category | - -## [Optional] Property `Document > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/documents/climate-user-guide-001" -``` - -## [Optional] Property `Document > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ------------ | -| **Default** | `"Document"` | - -## [Optional] Property `Document > accessURL` - -**Title:** access URL - -**Requirement:** Optional - -A URL that gives access to the Document - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -"https://example.gov/docs/climate-user-guide" -``` - -| Any of(Option) | -| ----------------------------------------------------- | -| [Null allowed when not required](#accessURL_anyOf_i0) | -| [URL](#accessURL_anyOf_i1) | - -### Property `Document > accessURL > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `Document > accessURL > anyOf > URL` - -**Title:** URL - -reference iri of Document - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -## [Optional] Property `Document > downloadURL` - -**Title:** download URL - -**Requirement:** Optional - -A URL that is a direct link to a downloadable file of the Document in a given format - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -"https://example.gov/docs/climate-user-guide.pdf" -``` - -| Any of(Option) | -| ------------------------------------------------------- | -| [Null allowed when not required](#downloadURL_anyOf_i0) | -| [URL](#downloadURL_anyOf_i1) | - -### Property `Document > downloadURL > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `Document > downloadURL > anyOf > URL` - -**Title:** URL - -reference iri of Document - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -## [Optional] Property `Document > creator` - -**Title:** author - -**Requirement:** Optional - -The individual(s) responsible for creating the Document - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ----------------------------------------------- | -| [Kind](#creator_items) | Contact information for an individual or entity | - -### Document > creator > Kind - -**Title:** Kind - -Contact information for an individual or entity - -| **Type** | `object` | -| ------------------------- | ----------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Kind](./Kind.md) | - -## [Optional] Property `Document > mediaType` - -**Title:** media type - -**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:** - -```json -"application/pdf" -``` - -## [Optional] Property `Document > abstract` - -**Title:** abstract - -**Requirement:** Optional - -Text abstract of the Document - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"This document provides detailed instructions for using climate data products, including API access, file formats, and data interpretation guidelines." -``` - -## [Optional] Property `Document > bibliographicCitation` - -**Title:** bibliographic citation - -**Requirement:** Optional - -Bibliographic citation as text - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"National Climate Data Center. (2024). Climate Data User Guide. Retrieved from https://example.gov/docs/climate-user-guide" -``` - -```json -"National Climate Data Center. (2024). Climate Data User Guide. U.S. Department of Commerce." -``` - -## [Optional] Property `Document > conformsTo` - -**Title:** conforms to - -**Requirement:** Optional - -List of standards or specifications the document follows - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------- | -| [Standard](#conformsTo_items) | A standard or specification that another resource conforms to | - -### Document > conformsTo > Standard - -**Title:** Standard - -A standard or specification that another resource conforms to - -| **Type** | `object` | -| ------------------------- | ------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Standard](./Standard.md) | - -## [Optional] Property `Document > corporateCreator` - -**Title:** corporate author - -**Requirement:** Optional - -The corporate organization(s) responsible for creating the Document - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| --------------------------------------- | --------------------------------------------------------------------------------- | -| [Organization](#corporateCreator_items) | An organization involved with a resource, including parent or child organizations | - -### Document > corporateCreator > Organization - -**Title:** Organization - -An organization involved with a resource, including parent or child organizations - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Organization](#conformsTo_items_identifier_anyOf_i1_anyOf_i1_creator_anyOf_i1) | - -## [Optional] Property `Document > description` - -**Title:** description - -**Requirement:** Optional - -Plain-language summary of the document - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"A guide for accessing and using the National Climate Data Center's data products." -``` - -```json -"A comprehensive guide for accessing and using the National Climate Data Center's data products and services." -``` - -## [Optional] Property `Document > identifier` - -**Title:** identifier - -**Requirement:** Optional - -The unique identifier for the Document (e.g. DOI, ISBN) - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------------------------ | -| [Null allowed when not required](#identifier_anyOf_i0) | -| [Identifier](#identifier_anyOf_i1) | - -### Property `Document > identifier > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `Document > identifier > anyOf > Identifier` - -**Title:** Identifier - -inline description of Identifier - -| **Type** | More than one type | -| ------------------------- | --------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#conformsTo_items_identifier_anyOf_i1) | - -## [Optional] Property `Document > otherIdentifier` - -**Title:** other identifier - -**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` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### Document > otherIdentifier > Identifier - -**Title:** Identifier - -A unique identifier and optionally it's scheme and other relevant information - -| **Type** | More than one type | -| ------------------------- | --------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#conformsTo_items_identifier_anyOf_i1) | - -## [Optional] Property `Document > issued` - -**Title:** publication date - -**Requirement:** Optional - -Publication date of the Document - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2024-01-15" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| -------------------------------------------------- | -| [Null allowed when not required](#issued_anyOf_i0) | -| [item 1](#issued_anyOf_i1) | - -### Property `Document > issued > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `Document > issued > anyOf > item 1` - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ----------------------------------- | -| [item 0](#issued_anyOf_i1_anyOf_i0) | -| [item 1](#issued_anyOf_i1_anyOf_i1) | -| [item 2](#issued_anyOf_i1_anyOf_i2) | -| [item 3](#issued_anyOf_i1_anyOf_i3) | - -#### Property `Document > issued > anyOf > item 1 > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `Document > issued > anyOf > item 1 > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `Document > issued > anyOf > item 1 > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `Document > publisher` - -**Title:** publisher - -**Requirement:** Optional - -The organization(s) that published the Document - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| -------------------------------- | --------------------------------------------------------------------------------- | -| [Organization](#publisher_items) | An organization involved with a resource, including parent or child organizations | - -### Document > publisher > Organization - -**Title:** Organization - -An organization involved with a resource, including parent or child organizations - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Organization](#conformsTo_items_identifier_anyOf_i1_anyOf_i1_creator_anyOf_i1) | - -## [Optional] Property `Document > title` - -**Title:** title - -**Requirement:** Optional - -The title of the Document - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Example:** - -```json -"Climate Data User Guide" -``` - -## [Optional] Property `Document > category` - -**Title:** category - -**Requirement:** Optional - -List of categories/genres for the Document - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Document > category > Concept - -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - -| **Type** | More than one type | -| ------------------------- | ------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#conformsTo_items_category_items) | - diff --git a/jsonschema/docs/Identifier.md b/jsonschema/docs/Identifier.md deleted file mode 100644 index 0f3f72c0..00000000 --- a/jsonschema/docs/Identifier.md +++ /dev/null @@ -1,197 +0,0 @@ - - -**Title:** Identifier - -A unique identifier and optionally it's scheme and other relevant information - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------------- | -| [Simple string identifier](#anyOf_i0) | -| [Identifier as a complex object](#anyOf_i1) | - -## Property `Identifier > anyOf > Simple string identifier` - -**Title:** Simple string identifier - -| **Type** | `string` | -| -------- | -------- | - -## Property `Identifier > anyOf > Identifier as a complex object` - -**Title:** Identifier as a complex object - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -| Property | Type | Title/Description | -| ----------------------------------------- | ------------------ | ----------------- | -| - [@id](#anyOf_i1_@id ) | string | - | -| - [@type](#anyOf_i1_@type ) | string | - | -| - [schemaAgency](#anyOf_i1_schemaAgency ) | null or string | schema agency | -| - [creator](#anyOf_i1_creator ) | More than one type | creator | -| - [issued](#anyOf_i1_issued ) | More than one type | issued | -| - [version](#anyOf_i1_version ) | null or string | version | -| - [notation](#anyOf_i1_notation ) | null or string | notation | - -### Property `Identifier > anyOf > Identifier as a complex object > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -### Property `Identifier > anyOf > Identifier as a complex object > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | -------------- | -| **Default** | `"Identifier"` | - -### Property `Identifier > anyOf > Identifier as a complex object > schemaAgency` - -**Title:** schema agency - -**Requirement:** Optional - -The name of the agency that issued the identifier - -| **Type** | `null or string` | -| -------- | ---------------- | - -### Property `Identifier > anyOf > Identifier as a complex object > creator` - -**Title:** creator - -**Requirement:** Optional - -the agency that manages the identifier scheme - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------------------------------ | -| [Null allowed when not required](#anyOf_i1_creator_anyOf_i0) | -| [Organization](#anyOf_i1_creator_anyOf_i1) | - -#### Property `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -#### Property `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Organization` - -**Title:** Organization - -inline description of the creator - -| **Type** | `object` | -| ------------------------- | --------------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Organization](./Organization.md) | - -### Property `Identifier > anyOf > Identifier as a complex object > issued` - -**Title:** issued - -**Requirement:** Optional - -The date of formal issuance (e.g., publication) of the Identifier - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ----------------------------------------------------------- | -| [Null allowed when not required](#anyOf_i1_issued_anyOf_i0) | -| [Date string](#anyOf_i1_issued_anyOf_i1) | - -#### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -#### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string` - -**Title:** Date string - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| -------------------------------------------- | -| [item 0](#anyOf_i1_issued_anyOf_i1_anyOf_i0) | -| [item 1](#anyOf_i1_issued_anyOf_i1_anyOf_i1) | -| [item 2](#anyOf_i1_issued_anyOf_i1_anyOf_i2) | -| [item 3](#anyOf_i1_issued_anyOf_i1_anyOf_i3) | - -##### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -##### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -##### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -##### Property `Identifier > anyOf > Identifier as a complex object > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -### Property `Identifier > anyOf > Identifier as a complex object > version` - -**Title:** version - -**Requirement:** Optional - -version of the identifier scheme - -| **Type** | `null or string` | -| -------- | ---------------- | - -### Property `Identifier > anyOf > Identifier as a complex object > notation` - -**Title:** notation - -**Requirement:** Optional - -abbreviation or code from code lists for an identifier - -| **Type** | `null or string` | -| -------- | ---------------- | - diff --git a/jsonschema/docs/Kind.md b/jsonschema/docs/Kind.md deleted file mode 100644 index 75de63c0..00000000 --- a/jsonschema/docs/Kind.md +++ /dev/null @@ -1,224 +0,0 @@ - - -**Title:** Kind - -Contact information for an individual or entity - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -{ - "@type": "Kind", - "fn": "Climate Data Support Team", - "hasEmail": "mailto:climate-support@example.gov", - "organization-name": "National Climate Data Center", - "tel": "+1-555-123-4567" -} -``` - -```json -{ - "@type": "Kind", - "fn": "Dr. Jane Smith", - "hasEmail": "mailto:jane.smith@example.gov" -} -``` - -| Property | Type | Title/Description | -| ------------------------------------------ | -------------- | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [address](#address ) | null or array | address | -| + [hasEmail](#hasEmail ) | string | Email | -| - [family-name](#family-name ) | null or string | family name | -| + [fn](#fn ) | string | formatted name | -| - [given-name](#given-name ) | null or string | given name | -| - [organization-name](#organization-name ) | null or string | organization name | -| - [tel](#tel ) | null or string | telephone | -| - [title](#title ) | null or string | position title | - -## [Optional] Property `Kind > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/contacts/climate-support-001" -``` - -## [Optional] Property `Kind > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | -------- | -| **Default** | `"Kind"` | - -## [Optional] Property `Kind > address` - -**Title:** address - -**Requirement:** Optional - -The address of the contact - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ------------------------- | -| [Address](#address_items) | A single physical address | - -### Kind > address > Address - -**Title:** Address - -A single physical address - -| **Type** | `object` | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Address](./Address.md) | - -## [Optional] Property `Kind > hasEmail` - -**Title:** Email - -**Requirement:** Optional - -Email address for the contact in mailto: format (for example, mailto:support@example.gov) - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"mailto:climate-support@example.gov" -``` - -```json -"mailto:jane.smith@example.gov" -``` - -| Restrictions | | -| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Must match regular expression** | ```^mailto:[\w\_\~\!\$\&\'\(\)\*\+\,\;\=\:.-]+@[\w.-]+\.[\w.-]+?$``` [Test](https://regex101.com/?regex=%5Emailto%3A%5B%5Cw%5C_%5C~%5C%21%5C%24%5C%26%5C%27%5C%28%5C%29%5C%2A%5C%2B%5C%2C%5C%3B%5C%3D%5C%3A.-%5D%2B%40%5B%5Cw.-%5D%2B%5C.%5B%5Cw.-%5D%2B%3F%24&testString=%22mailto%3Aclimate-support%40example.gov%22) | - -## [Optional] Property `Kind > family-name` - -**Title:** family name - -**Requirement:** Optional - -The family name of the contact - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"Smith" -``` - -## [Optional] Property `Kind > fn` - -**Title:** formatted name - -**Requirement:** Optional - -The formatted text of the name of the contact - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"Climate Data Support Team" -``` - -```json -"Dr. Jane Smith" -``` - -## [Optional] Property `Kind > given-name` - -**Title:** given name - -**Requirement:** Optional - -The given name of the contact - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"Jane" -``` - -## [Optional] Property `Kind > organization-name` - -**Title:** organization name - -**Requirement:** Optional - -The name of the organization to contact - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"National Climate Data Center" -``` - -## [Optional] Property `Kind > tel` - -**Title:** telephone - -**Requirement:** Optional - -The telephone number for the contact - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"+1-555-123-4567" -``` - -## [Optional] Property `Kind > title` - -**Title:** position title - -**Requirement:** Optional - -The position role of the person to contact - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"Senior Climate Data Scientist" -``` - diff --git a/jsonschema/docs/Location.md b/jsonschema/docs/Location.md deleted file mode 100644 index 115f8062..00000000 --- a/jsonschema/docs/Location.md +++ /dev/null @@ -1,562 +0,0 @@ - - -**Title:** Location - -A named place or geographic area - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -{ - "@type": "Location", - "prefLabel": "Continental United States", - "bbox": "POLYGON((-125 24, -66 24, -66 50, -125 50, -125 24))" -} -``` - -```json -{ - "@type": "Location", - "prefLabel": "Continental United States", - "bbox": { - "type": "Polygon", - "coordinates": [ - [ - [ - -77.119759, - 38.791645 - ], - [ - -76.909393, - 38.791645 - ], - [ - -76.909393, - 38.99538 - ], - [ - -77.119759, - 38.99538 - ], - [ - -77.119759, - 38.791645 - ] - ] - ] - } -} -``` - -```json -{ - "@type": "Location", - "prefLabel": "Null Island", - "bbox": "POINT (0.0 0.0)" -} -``` - -```json -{ - "@type": "Location", - "prefLabel": "Random object", - "geometry": { - "type": "Polygon", - "coordinates": [ - [ - [ - -77.0402, - 38.7916 - ], - [ - -76.9094, - 38.8921 - ], - [ - -76.9115, - 38.9355 - ], - [ - -76.9286, - 38.9784 - ], - [ - -77.0024, - 38.9657 - ], - [ - -77.0389, - 38.9939 - ], - [ - -77.0672, - 38.9687 - ], - [ - -77.0782, - 38.9143 - ], - [ - -77.1198, - 38.9342 - ], - [ - -77.1198, - 38.8456 - ], - [ - -77.0402, - 38.7916 - ] - ] - ] - } -} -``` - -| Property | Type | Title/Description | -| -------------------------------------- | ------------------ | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [bbox](#bbox ) | More than one type | bounding box | -| - [centroid](#centroid ) | More than one type | centroid | -| - [identifier](#identifier ) | More than one type | identifier | -| - [otherIdentifier](#otherIdentifier ) | null or array | other identifier | -| - [geometry](#geometry ) | More than one type | geometry | -| - [inScheme](#inScheme ) | More than one type | gazetteer | -| - [altLabel](#altLabel ) | null or string | alternative name | -| - [prefLabel](#prefLabel ) | null or string | geographic name | - -## [Optional] Property `Location > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/locations/washington-dc" -``` - -## [Optional] Property `Location > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ------------ | -| **Default** | `"Location"` | - -## [Optional] Property `Location > bbox` - -**Title:** bounding box - -**Requirement:** Optional - -Bounding box for the location, described in WKT, GeoJSON, or GML format - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"POLYGON((-125 24, -66 24, -66 50, -125 50, -125 24))" -``` - -```json -{ - "type": "Polygon", - "coordinates": [ - [ - [ - -77.119759, - 38.791645 - ], - [ - -76.909393, - 38.791645 - ], - [ - -76.909393, - 38.99538 - ], - [ - -77.119759, - 38.99538 - ], - [ - -77.119759, - 38.791645 - ] - ] - ] -} -``` - -| Any of(Option) | -| ------------------------ | -| [item 0](#bbox_anyOf_i0) | -| [item 1](#bbox_anyOf_i1) | -| [item 2](#bbox_anyOf_i2) | - -### Property `Location > bbox > anyOf > item 0` - -| **Type** | `null` | -| -------- | ------ | - -### Property `Location > bbox > anyOf > item 1` - -Bounding box represented in WKT, GeoJSON (stringified), or GML format - -| **Type** | `string` | -| -------- | -------- | - -### Property `Location > bbox > anyOf > item 2` - -Bounding box represented in GeoJSON format, either as a Polygon or in bbox array format - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -| Property | Type | Title/Description | -| -------------------------------------------- | ----- | ----------------- | -| + [coordinates](#bbox_anyOf_i2_coordinates ) | array | - | -| + [type](#bbox_anyOf_i2_type ) | const | - | - -#### Property `Location > bbox > anyOf > item 2 > coordinates` - -**Requirement:** Optional - -| **Type** | `array` | -| ------------ | ------- | -| **Required** | Yes | - -#### Property `Location > bbox > anyOf > item 2 > type` - -**Requirement:** Optional - -| **Type** | `const` | -| ------------ | ------- | -| **Required** | Yes | - -Specific value: `"Polygon"` - -## [Optional] Property `Location > centroid` - -**Title:** centroid - -**Requirement:** Optional - -The geographic center (centroid) of a location described in WKT, GeoJSON, or GML format - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "type": "Point", - "coordinates": [ - -77.0369, - 38.9072 - ] -} -``` - -| Any of(Option) | -| ---------------------------- | -| [item 0](#centroid_anyOf_i0) | -| [item 1](#centroid_anyOf_i1) | -| [item 2](#centroid_anyOf_i2) | - -### Property `Location > centroid > anyOf > item 0` - -| **Type** | `null` | -| -------- | ------ | - -### Property `Location > centroid > anyOf > item 1` - -Center point represented in WKT, GeoJSON (stringified), or GML format - -| **Type** | `string` | -| -------- | -------- | - -### Property `Location > centroid > anyOf > item 2` - -Centroid represented in GeoJSON format; force point usage with coordinates of longitude and latitude - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -| Property | Type | Title/Description | -| ------------------------------------------------ | --------------- | ----------------- | -| + [coordinates](#centroid_anyOf_i2_coordinates ) | array of number | - | -| + [type](#centroid_anyOf_i2_type ) | const | - | - -#### Property `Location > centroid > anyOf > item 2 > coordinates` - -**Requirement:** Optional - -| **Type** | `array of number` | -| ------------ | ----------------- | -| **Required** | Yes | - -| Each item of this array must be | Description | -| --------------------------------------------------------- | ----------- | -| [coordinates items](#centroid_anyOf_i2_coordinates_items) | - | - -##### Location > centroid > anyOf > item 2 > coordinates > coordinates items - -| **Type** | `number` | -| -------- | -------- | - -#### Property `Location > centroid > anyOf > item 2 > type` - -**Requirement:** Optional - -| **Type** | `const` | -| ------------ | ------- | -| **Required** | Yes | - -Specific value: `"Point"` - -## [Optional] Property `Location > identifier` - -**Title:** identifier - -**Requirement:** Optional - -The unique geographic identifier for the Location, e.g., the URI or other unique identifier in the context of the relevant gazetteer - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ---------------------------------- | -| [item 0](#identifier_anyOf_i0) | -| [Identifier](#identifier_anyOf_i1) | - -### Property `Location > identifier > anyOf > item 0` - -| **Type** | `null` | -| -------- | ------ | - -### Property `Location > identifier > anyOf > Identifier` - -**Title:** Identifier - -inline description of Identifier - -| **Type** | More than one type | -| ------------------------- | ----------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Identifier](./Identifier.md) | - -## [Optional] Property `Location > otherIdentifier` - -**Title:** other identifier - -**Requirement:** Optional - -A list of geographic identifiers for the Location besides the main identifier, e.g. the URI or other unique identifiers in the context of the relevant gazetteer - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### Location > otherIdentifier > Identifier - -**Title:** Identifier - -A unique identifier and optionally it's scheme and other relevant information - -| **Type** | More than one type | -| ------------------------- | ---------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#identifier_anyOf_i1) | - -## [Optional] Property `Location > geometry` - -**Title:** geometry - -**Requirement:** Optional - -Associates a location with a corresponding geometry described in WKT, GeoJSON, or GML format - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "type": "Polygon", - "coordinates": [ - [ - [ - -77.0402, - 38.7916 - ], - [ - -76.9094, - 38.8921 - ], - [ - -76.9115, - 38.9355 - ], - [ - -76.9286, - 38.9784 - ], - [ - -77.0024, - 38.9657 - ], - [ - -77.0389, - 38.9939 - ], - [ - -77.0672, - 38.9687 - ], - [ - -77.0782, - 38.9143 - ], - [ - -77.1198, - 38.9342 - ], - [ - -77.1198, - 38.8456 - ], - [ - -77.0402, - 38.7916 - ] - ] - ] -} -``` - -| Any of(Option) | -| ---------------------------- | -| [item 0](#geometry_anyOf_i0) | -| [item 1](#geometry_anyOf_i1) | -| [item 2](#geometry_anyOf_i2) | - -### Property `Location > geometry > anyOf > item 0` - -| **Type** | `null` | -| -------- | ------ | - -### Property `Location > geometry > anyOf > item 1` - -String format of the full geometry of the location in WKT, GeoJSON, or GML format - -| **Type** | `string` | -| -------- | -------- | - -### Property `Location > geometry > anyOf > item 2` - -Geometry represented in GeoJSON format - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -#### The following properties are required -* type -* coordinates - -## [Optional] Property `Location > inScheme` - -**Title:** gazetteer - -**Requirement:** Optional - -The gazetteer to which the location belongs - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ----------------------------------- | -| [item 0](#inScheme_anyOf_i0) | -| [ConceptScheme](#inScheme_anyOf_i1) | - -### Property `Location > inScheme > anyOf > item 0` - -| **Type** | `null` | -| -------- | ------ | - -### Property `Location > inScheme > anyOf > ConceptScheme` - -**Title:** ConceptScheme - -inline description of the gazetteer - -| **Type** | `object` | -| ------------------------- | ----------------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Conceptscheme](./Conceptscheme.md) | - -## [Optional] Property `Location > altLabel` - -**Title:** alternative name - -**Requirement:** Optional - -An alternative label or name for a location - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"DC" -``` - -## [Optional] Property `Location > prefLabel` - -**Title:** geographic name - -**Requirement:** Optional - -Preferred label or name of the Location - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"Continental United States" -``` - -```json -"Washington, D.C." -``` - diff --git a/jsonschema/docs/Metric.md b/jsonschema/docs/Metric.md deleted file mode 100644 index 64bf5c70..00000000 --- a/jsonschema/docs/Metric.md +++ /dev/null @@ -1,116 +0,0 @@ - - -**Title:** Metric - -A standard used to measure one aspect of data quality - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "Metric", - "expectedDataType": "xsd:decimal", - "inDimension": "https://example.gov/dimensions/completeness", - "definition": "Percentage of non-null values in the dataset." -} -``` - -| Property | Type | Title/Description | -| ---------------------------------------- | -------------- | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| + [expectedDataType](#expectedDataType ) | string | expected datatype | -| + [inDimension](#inDimension ) | string | in dimension | -| - [definition](#definition ) | null or string | definition | - -## [Optional] Property `Metric > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/metrics/record-completeness" -``` - -## [Optional] Property `Metric > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ---------- | -| **Default** | `"Metric"` | - -## [Optional] Property `Metric > expectedDataType` - -**Title:** expected datatype - -**Requirement:** Optional - -Represents the expected data type for the metric's observed value (e.g., xsd:boolean, xsd:double etc...) - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"xsd:decimal" -``` - -```json -"xsd:double" -``` - -## [Optional] Property `Metric > inDimension` - -**Title:** in dimension - -**Requirement:** Optional - -Represents the dimensions a quality metric, certificate and annotation allow a measurement of. - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"https://example.gov/dimensions/completeness" -``` - -```json -"https://www.w3.org/TR/vocab-dqv/#dqv:completeness" -``` - -## [Optional] Property `Metric > definition` - -**Title:** definition - -**Requirement:** Optional - -Definition of the metric. - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"Percentage of non-null values in the dataset." -``` - -```json -"The percentage of non-null values for required fields in a dataset. A value of 1.0 indicates 100% completeness." -``` - diff --git a/jsonschema/docs/Organization.md b/jsonschema/docs/Organization.md deleted file mode 100644 index 4deb6c9c..00000000 --- a/jsonschema/docs/Organization.md +++ /dev/null @@ -1,190 +0,0 @@ - - -**Title:** Organization - -An organization involved with a resource, including parent or child organizations - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -{ - "@type": "Organization", - "name": "National Climate Data Center", - "altLabel": "NCDC" -} -``` - -```json -{ - "@id": "https://example.gov/organizations/census-bureau", - "@type": "Organization", - "name": "U.S. Census Bureau", - "prefLabel": "United States Census Bureau", - "altLabel": "Census Bureau", - "notation": [ - "USCB", - "CB" - ], - "subOrganizationOf": [ - { - "@id": "https://example.gov/organizations/doc", - "@type": "Organization", - "name": "U.S. Department of Commerce" - } - ] -} -``` - -| Property | Type | Title/Description | -| ------------------------------------------ | ----------------------- | ------------------ | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| + [name](#name ) | string | name | -| - [subOrganizationOf](#subOrganizationOf ) | null or array | suborganization of | -| - [altLabel](#altLabel ) | null or string | alternative label | -| - [notation](#notation ) | null or array of string | notation | -| - [prefLabel](#prefLabel ) | null or string | preferred label | - -## [Optional] Property `Organization > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/organizations/census-bureau" -``` - -## [Optional] Property `Organization > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ---------------- | -| **Default** | `"Organization"` | - -## [Optional] Property `Organization > name` - -**Title:** name - -**Requirement:** Optional - -The full name of the Organization - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"National Climate Data Center" -``` - -```json -"U.S. Census Bureau" -``` - -## [Optional] Property `Organization > subOrganizationOf` - -**Title:** suborganization of - -**Requirement:** Optional - -Represents hierarchical containment of Organizations or OrganizationalUnits; indicates an Organization which contains this Organization - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ---------------------------------------- | --------------------------------------------------------------------------------- | -| [Organization](#subOrganizationOf_items) | An organization involved with a resource, including parent or child organizations | - -### Organization > subOrganizationOf > Organization - -**Title:** Organization - -An organization involved with a resource, including parent or child organizations - -| **Type** | `object` | -| ------------------------- | --------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Organization](#root) | - -## [Optional] Property `Organization > altLabel` - -**Title:** alternative label - -**Requirement:** Optional - -alternative name (trading name, colloquial name) for an organization - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"NCDC" -``` - -```json -"Census Bureau" -``` - -## [Optional] Property `Organization > notation` - -**Title:** notation - -**Requirement:** Optional - -List of abbreviations or codes from code lists for an organization (e.g. DOI, DOD) - -| **Type** | `null or array of string` | -| -------- | ------------------------- | - -**Example:** - -```json -[ - "USCB", - "CB" -] -``` - -| Each item of this array must be | Description | -| ------------------------------- | ----------- | -| [Abbreviation](#notation_items) | - | - -### Organization > notation > Abbreviation - -**Title:** Abbreviation - -| **Type** | `string` | -| -------- | -------- | - -## [Optional] Property `Organization > prefLabel` - -**Title:** preferred label - -**Requirement:** Optional - -Preferred or legal name of the organization - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"United States Census Bureau" -``` - diff --git a/jsonschema/docs/PeriodOfTime.md b/jsonschema/docs/PeriodOfTime.md deleted file mode 100644 index fd4b63ca..00000000 --- a/jsonschema/docs/PeriodOfTime.md +++ /dev/null @@ -1,250 +0,0 @@ - - -**Title:** PeriodOfTime - -Information about a specific time period with a start- and/or end-time - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "PeriodOfTime", - "startDate": "2024-01-01", - "endDate": "2024-12-31" -} -``` - -| Property | Type | Title/Description | -| -------------------------- | ------------------ | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [endDate](#endDate ) | More than one type | end date | -| - [startDate](#startDate ) | More than one type | start date | - -| Any of(Option) | -| ------------------- | -| [item 0](#anyOf_i0) | -| [item 1](#anyOf_i1) | - -## Property `PeriodOfTime > anyOf > item 0` - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -### The following properties are required -* startDate - -## Property `PeriodOfTime > anyOf > item 1` - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -### The following properties are required -* endDate - -## [Optional] Property `PeriodOfTime > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/periods/fiscal-year-2024" -``` - -## [Optional] Property `PeriodOfTime > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ---------------- | -| **Default** | `"PeriodOfTime"` | - -## [Optional] Property `PeriodOfTime > endDate` - -**Title:** end date - -**Requirement:** Optional - -The end date of the period of time - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2024-12-31" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| --------------------------------------------------- | -| [Null allowed when not required](#endDate_anyOf_i0) | -| [item 1](#endDate_anyOf_i1) | - -### Property `PeriodOfTime > endDate > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `PeriodOfTime > endDate > anyOf > item 1` - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------ | -| [item 0](#endDate_anyOf_i1_anyOf_i0) | -| [item 1](#endDate_anyOf_i1_anyOf_i1) | -| [item 2](#endDate_anyOf_i1_anyOf_i2) | -| [item 3](#endDate_anyOf_i1_anyOf_i3) | - -#### Property `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `PeriodOfTime > endDate > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `PeriodOfTime > startDate` - -**Title:** start date - -**Requirement:** Optional - -The start date of the period of time - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2023-10-01" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| ----------------------------------------------------- | -| [Null allowed when not required](#startDate_anyOf_i0) | -| [item 1](#startDate_anyOf_i1) | - -### Property `PeriodOfTime > startDate > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `PeriodOfTime > startDate > anyOf > item 1` - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| -------------------------------------- | -| [item 0](#startDate_anyOf_i1_anyOf_i0) | -| [item 1](#startDate_anyOf_i1_anyOf_i1) | -| [item 2](#startDate_anyOf_i1_anyOf_i2) | -| [item 3](#startDate_anyOf_i1_anyOf_i3) | - -#### Property `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `PeriodOfTime > startDate > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - diff --git a/jsonschema/docs/QualityMeasurement.md b/jsonschema/docs/QualityMeasurement.md deleted file mode 100644 index 57f847a0..00000000 --- a/jsonschema/docs/QualityMeasurement.md +++ /dev/null @@ -1,103 +0,0 @@ - - -**Title:** QualityMeasurement - -A measurement of a resource against a specific quality metric - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "QualityMeasurement", - "isMeasurementOf": { - "expectedDataType": "xsd:decimal", - "inDimension": "https://example.gov/dimensions/completeness" - }, - "value": "98.5", - "unitMeasure": "percent" -} -``` - -| Property | Type | Title/Description | -| -------------------------------------- | -------------- | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| + [isMeasurementOf](#isMeasurementOf ) | object | is measurement of | -| + [value](#value ) | string | value | -| - [unitMeasure](#unitMeasure ) | null or string | unit of measure | - -## [Optional] Property `QualityMeasurement > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/quality-measurements/completeness-001" -``` - -## [Optional] Property `QualityMeasurement > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ---------------------- | -| **Default** | `"QualityMeasurement"` | - -## [Optional] Property `QualityMeasurement > isMeasurementOf` - -**Title:** is measurement of - -**Requirement:** Optional - -The metric being observed - -| **Type** | `object` | -| ------------------------- | --------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | -| **Defined in** | [Metric](./Metric.md) | - -## [Optional] Property `QualityMeasurement > value` - -**Title:** value - -**Requirement:** Optional - -The value computed by metric - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Example:** - -```json -"98.5" -``` - -## [Optional] Property `QualityMeasurement > unitMeasure` - -**Title:** unit of measure - -**Requirement:** Optional - -Unit of measure associated with the value - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Example:** - -```json -"percent" -``` - diff --git a/jsonschema/docs/Relationship.md b/jsonschema/docs/Relationship.md deleted file mode 100644 index 0c754e1f..00000000 --- a/jsonschema/docs/Relationship.md +++ /dev/null @@ -1,93 +0,0 @@ - - -**Title:** Relationship - -Additional information about how one resource is related to another - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "Relationship", - "hadRole": "isInputTo", - "relation": "https://example.gov/models/climate-prediction" -} -``` - -| Property | Type | Title/Description | -| ------------------------ | ------ | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| + [hadRole](#hadRole ) | string | role | -| + [relation](#relation ) | string | relation | - -## [Optional] Property `Relationship > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/relationships/dataset-001-data-provider" -``` - -## [Optional] Property `Relationship > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ---------------- | -| **Default** | `"Relationship"` | - -## [Optional] Property `Relationship > hadRole` - -**Title:** role - -**Requirement:** Optional - -The function of an entity or agent with respect to a dataset - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"isInputTo" -``` - -```json -"dataProvider" -``` - -## [Optional] Property `Relationship > relation` - -**Title:** relation - -**Requirement:** Optional - -The entity related to the dataset. This string should unambiguously identify the related resource using an appropriate identifier. - -| **Type** | `string` | -| ------------ | -------- | -| **Required** | Yes | - -**Examples:** - -```json -"https://example.gov/models/climate-prediction" -``` - -```json -"https://example.gov/organizations/national-weather-service" -``` - diff --git a/jsonschema/docs/Standard.md b/jsonschema/docs/Standard.md deleted file mode 100644 index 0ab4d831..00000000 --- a/jsonschema/docs/Standard.md +++ /dev/null @@ -1,504 +0,0 @@ - - -**Title:** Standard - -A standard or specification that another resource conforms to - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@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 | Title/Description | -| -------------------------------------- | ------------------ | ----------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [created](#created ) | More than one type | creation date | -| - [description](#description ) | null or string | description | -| - [identifier](#identifier ) | More than one type | identifier | -| - [otherIdentifier](#otherIdentifier ) | null or array | other identifier | -| - [issued](#issued ) | More than one type | issued | -| - [modified](#modified ) | More than one type | last modified | -| - [title](#title ) | null or string | title | -| - [category](#category ) | null or array | category | -| - [inScheme](#inScheme ) | More than one type | in scheme | - -## [Optional] Property `Standard > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/standards/dcat-us-3" -``` - -## [Optional] Property `Standard > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ------------ | -| **Default** | `"Standard"` | - -## [Optional] Property `Standard > created` - -**Title:** creation date - -**Requirement:** Optional - -The date on which the Standard has been first created - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2023-01-01" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| --------------------------------------------------- | -| [Null allowed when not required](#created_anyOf_i0) | -| [Date string](#created_anyOf_i1) | - -### Property `Standard > created > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `Standard > created > anyOf > Date string` - -**Title:** Date string - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------ | -| [item 0](#created_anyOf_i1_anyOf_i0) | -| [item 1](#created_anyOf_i1_anyOf_i1) | -| [item 2](#created_anyOf_i1_anyOf_i2) | -| [item 3](#created_anyOf_i1_anyOf_i3) | - -#### Property `Standard > created > anyOf > Date string > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `Standard > created > anyOf > Date string > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `Standard > created > anyOf > Date string > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `Standard > description` - -**Title:** description - -**Requirement:** Optional - -Plain-language summary of the standard - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"Data Catalog Vocabulary - United States Profile version 3.0" -``` - -```json -"The DCAT-US 3.0 schema defines a standard metadata format for data catalogs in the United States government, based on W3C DCAT." -``` - -## [Optional] Property `Standard > identifier` - -**Title:** identifier - -**Requirement:** Optional - -The unique identifier for the Standard, e.g. the URI or other unique identifier in the context of the Catalog - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------------------------ | -| [Null allowed when not required](#identifier_anyOf_i0) | -| [Identifier](#identifier_anyOf_i1) | - -### Property `Standard > identifier > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `Standard > identifier > anyOf > Identifier` - -**Title:** Identifier - -inline description of Identifier - -| **Type** | More than one type | -| ------------------------- | ----------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Identifier](./Identifier.md) | - -## [Optional] Property `Standard > otherIdentifier` - -**Title:** other identifier - -**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` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### Standard > otherIdentifier > Identifier - -**Title:** Identifier - -A unique identifier and optionally it's scheme and other relevant information - -| **Type** | More than one type | -| ------------------------- | ---------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#identifier_anyOf_i1) | - -## [Optional] Property `Standard > issued` - -**Title:** issued - -**Requirement:** Optional - -The date of formal issuance (e.g., publication) of the Standard - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2024-01-15" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| -------------------------------------------------- | -| [Null allowed when not required](#issued_anyOf_i0) | -| [Date string](#issued_anyOf_i1) | - -### Property `Standard > issued > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `Standard > issued > anyOf > Date string` - -**Title:** Date string - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ----------------------------------- | -| [item 0](#issued_anyOf_i1_anyOf_i0) | -| [item 1](#issued_anyOf_i1_anyOf_i1) | -| [item 2](#issued_anyOf_i1_anyOf_i2) | -| [item 3](#issued_anyOf_i1_anyOf_i3) | - -#### Property `Standard > issued > anyOf > Date string > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `Standard > issued > anyOf > Date string > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `Standard > issued > anyOf > Date string > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `Standard > modified` - -**Title:** last modified - -**Requirement:** Optional - -The most recent date on which the Standard was changed or modified - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"2024-06-01" -``` - -```json -"2024-01-15T10:30:00Z" -``` - -```json -"2024" -``` - -```json -"2024-01" -``` - -| Any of(Option) | -| ---------------------------------------------------- | -| [Null allowed when not required](#modified_anyOf_i0) | -| [Date string](#modified_anyOf_i1) | - -### Property `Standard > modified > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `Standard > modified > anyOf > Date string` - -**Title:** Date string - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ------------------------------------- | -| [item 0](#modified_anyOf_i1_anyOf_i0) | -| [item 1](#modified_anyOf_i1_anyOf_i1) | -| [item 2](#modified_anyOf_i1_anyOf_i2) | -| [item 3](#modified_anyOf_i1_anyOf_i3) | - -#### Property `Standard > modified > anyOf > Date string > anyOf > item 0` - -| **Type** | `string` | -| ---------- | ----------- | -| **Format** | `date-time` | - -#### Property `Standard > modified > anyOf > Date string > anyOf > item 1` - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `date` | - -#### Property `Standard > modified > anyOf > Date string > anyOf > item 2` - -A year in YYYY format - -| **Type** | `string` | -| -------- | -------- | - -| Restrictions | | -| --------------------------------- | --------------------------------------------------------------------------- | -| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | - -#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | - -## [Optional] Property `Standard > title` - -**Title:** title - -**Requirement:** Optional - -Human-readable title of the standard - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"DCAT-US 3.0" -``` - -```json -"DCAT-US 3.0 - Data Catalog Vocabulary United States Profile" -``` - -## [Optional] Property `Standard > category` - -**Title:** category - -**Requirement:** Optional - -List of categories for the Standard - -| **Type** | `null or array` | -| -------- | --------------- | - -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Standard > category > Concept - -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Concept](./Concept.md) | - -## [Optional] Property `Standard > inScheme` - -**Title:** in scheme - -**Requirement:** Optional - -The reference register to which the Standard belongs - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -| Any of(Option) | -| ---------------------------------------------------- | -| [Null allowed when not required](#inScheme_anyOf_i0) | -| [ConceptScheme](#inScheme_anyOf_i1) | - -### Property `Standard > inScheme > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `Standard > inScheme > anyOf > ConceptScheme` - -**Title:** ConceptScheme - -inline description of ConceptScheme - -| **Type** | `object` | -| ------------------------- | --------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [inScheme](#category_items_anyOf_i1_inScheme) | - diff --git a/jsonschema/docs/UseRestriction.md b/jsonschema/docs/UseRestriction.md deleted file mode 100644 index a9362561..00000000 --- a/jsonschema/docs/UseRestriction.md +++ /dev/null @@ -1,141 +0,0 @@ - - -**Title:** UseRestriction - -Rules or legal limits on how a resource may be used - -| **Type** | `object` | -| ------------------------- | ---------------- | -| **Additional properties** | Any type allowed | - -**Example:** - -```json -{ - "@type": "UseRestriction", - "restrictionStatus": "Restricted - Fully", - "specificRestriction": "Trademark", - "restrictionNote": "This data may be used for any purpose without restriction." -} -``` - -| Property | Type | Title/Description | -| ---------------------------------------------- | ------------------ | -------------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [restrictionNote](#restrictionNote ) | null or string | restriction note | -| + [restrictionStatus](#restrictionStatus ) | object | restriction status | -| - [specificRestriction](#specificRestriction ) | More than one type | specific restriction | - -## [Optional] Property `UseRestriction > @id` - -**Requirement:** Optional - -| **Type** | `string` | -| ---------- | -------- | -| **Format** | `iri` | - -**Example:** - -```json -"https://example.gov/restrictions/use-restriction-001" -``` - -## [Optional] Property `UseRestriction > @type` - -**Requirement:** Optional - -| **Type** | `string` | -| ----------- | ------------------ | -| **Default** | `"UseRestriction"` | - -## [Optional] Property `UseRestriction > restrictionNote` - -**Title:** restriction note - -**Requirement:** Optional - -Significant information pertaining to the use or reproduction of the data - -| **Type** | `null or string` | -| -------- | ---------------- | - -**Examples:** - -```json -"This data may be used for any purpose without restriction." -``` - -```json -"This data may be used for research purposes. Commercial use requires written permission from the data steward." -``` - -## [Optional] Property `UseRestriction > restrictionStatus` - -**Title:** restriction status - -**Requirement:** Optional - -Indication of whether or not there are use restrictions on the archival materials, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/use-restriction-status - -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | -| **Defined in** | [Concept](./Concept.md) | - -**Examples:** - -```json -"Restricted - Fully" -``` - -```json -"Unrestricted" -``` - -## [Optional] Property `UseRestriction > specificRestriction` - -**Title:** specific restriction - -**Requirement:** Optional - -Authority, code list entry, or policy reference that defines the specific use restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-use-restriction - -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | - -**Examples:** - -```json -"Copyright" -``` - -```json -"Trademark" -``` - -| Any of(Option) | -| --------------------------------------------------------------- | -| [Null allowed when not required](#specificRestriction_anyOf_i0) | -| [Concept](#specificRestriction_anyOf_i1) | - -### Property `UseRestriction > specificRestriction > anyOf > Null allowed when not required` - -**Title:** Null allowed when not required - -| **Type** | `null` | -| -------- | ------ | - -### Property `UseRestriction > specificRestriction > anyOf > Concept` - -**Title:** Concept - -inline description of the specific restriction - -| **Type** | More than one type | -| ------------------------- | --------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [restrictionStatus](#restrictionStatus) | - diff --git a/jsonschema/docs/agents.md b/jsonschema/docs/agents.md new file mode 100644 index 00000000..5f777f69 --- /dev/null +++ b/jsonschema/docs/agents.md @@ -0,0 +1,514 @@ +# Agents + +This page combines supporting DCAT-US 3 classes used with the main schema classes. + + + +## Agent + +**Title:** Agent + +A person, organization, software agent, or other entity involved with a resource + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "Agent", + "name": "National Climate Data Center", + "category": [ + "https://example.gov/concepts/federal-agency" + ] +} +``` + +| Property | Type | Title/Description | +| ------------------------ | ------------- | ----------------- | +| - [@id](#agent--@id) | string | - | +| - [@type](#agent--@type) | string | - | +| - [category](#agent--category) | null or array | category | +| + [name](#agent--name) | string | name | + +## [Optional] Property `Agent > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/agents/data-steward-001" +``` + +## [Optional] Property `Agent > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | --------- | +| **Default** | `"Agent"` | + +## [Optional] Property `Agent > category` + +**Title:** category + +**Requirement:** Optional + +The type of the agent that makes the item available + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ------------------------------------------------------------------ | +| [Concept](#agent--category_items) | A controlled term or label, optionally drawn from a concept scheme | + +### Agent > category > Concept + +| **Type** | More than one type | +| ------------------------- | ----------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | + +## [Optional] Property `Agent > name` + +**Title:** name + +**Requirement:** Optional + +The name of the agent + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"National Climate Data Center" +``` + +```json +"U.S. Department of Commerce Data Stewardship Office" +``` + +--- + + + +## Organization + +**Title:** Organization + +An organization involved with a resource, including parent or child organizations + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +{ + "@type": "Organization", + "name": "National Climate Data Center", + "altLabel": "NCDC" +} +``` + +```json +{ + "@id": "https://example.gov/organizations/census-bureau", + "@type": "Organization", + "name": "U.S. Census Bureau", + "prefLabel": "United States Census Bureau", + "altLabel": "Census Bureau", + "notation": [ + "USCB", + "CB" + ], + "subOrganizationOf": [ + { + "@id": "https://example.gov/organizations/doc", + "@type": "Organization", + "name": "U.S. Department of Commerce" + } + ] +} +``` + +| Property | Type | Title/Description | +| ------------------------------------------ | ----------------------- | ------------------ | +| - [@id](#organization--@id) | string | - | +| - [@type](#organization--@type) | string | - | +| + [name](#organization--name) | string | name | +| - [subOrganizationOf](#organization--subOrganizationOf) | null or array | suborganization of | +| - [altLabel](#organization--altLabel) | null or string | alternative label | +| - [notation](#organization--notation) | null or array of string | notation | +| - [prefLabel](#organization--prefLabel) | null or string | preferred label | + +## [Optional] Property `Organization > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/organizations/census-bureau" +``` + +## [Optional] Property `Organization > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ---------------- | +| **Default** | `"Organization"` | + +## [Optional] Property `Organization > name` + +**Title:** name + +**Requirement:** Optional + +The full name of the Organization + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"National Climate Data Center" +``` + +```json +"U.S. Census Bureau" +``` + +## [Optional] Property `Organization > subOrganizationOf` + +**Title:** suborganization of + +**Requirement:** Optional + +Represents hierarchical containment of Organizations or OrganizationalUnits; indicates an Organization which contains this Organization + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ---------------------------------------- | --------------------------------------------------------------------------------- | +| [Organization](#organization--subOrganizationOf_items) | An organization involved with a resource, including parent or child organizations | + +### Organization > subOrganizationOf > Organization + +| **Type** | `object` | +| ------------------------- | --------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Organization](#organization) | + +## [Optional] Property `Organization > altLabel` + +**Title:** alternative label + +**Requirement:** Optional + +alternative name (trading name, colloquial name) for an organization + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"NCDC" +``` + +```json +"Census Bureau" +``` + +## [Optional] Property `Organization > notation` + +**Title:** notation + +**Requirement:** Optional + +List of abbreviations or codes from code lists for an organization (e.g. DOI, DOD) + +| **Type** | `null or array of string` | +| -------- | ------------------------- | + +**Example:** + +```json +[ + "USCB", + "CB" +] +``` + +| Each item of this array must be | Description | +| ------------------------------- | ----------- | +| [Abbreviation](#organization--notation_items) | - | + +### Organization > notation > Abbreviation + +**Title:** Abbreviation + +| **Type** | `string` | +| -------- | -------- | + +## [Optional] Property `Organization > prefLabel` + +**Title:** preferred label + +**Requirement:** Optional + +Preferred or legal name of the organization + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"United States Census Bureau" +``` + +--- + + + +## Kind + +**Title:** Kind + +Contact information for an individual or entity + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +{ + "@type": "Kind", + "fn": "Climate Data Support Team", + "hasEmail": "mailto:climate-support@example.gov", + "organization-name": "National Climate Data Center", + "tel": "+1-555-123-4567" +} +``` + +```json +{ + "@type": "Kind", + "fn": "Dr. Jane Smith", + "hasEmail": "mailto:jane.smith@example.gov" +} +``` + +| Property | Type | Title/Description | +| ------------------------------------------ | -------------- | ----------------- | +| - [@id](#kind--@id) | string | - | +| - [@type](#kind--@type) | string | - | +| - [address](#kind--address) | null or array | address | +| + [hasEmail](#kind--hasEmail) | string | Email | +| - [family-name](#kind--family-name) | null or string | family name | +| + [fn](#kind--fn) | string | formatted name | +| - [given-name](#kind--given-name) | null or string | given name | +| - [organization-name](#kind--organization-name) | null or string | organization name | +| - [tel](#kind--tel) | null or string | telephone | +| - [title](#kind--title) | null or string | position title | + +## [Optional] Property `Kind > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/contacts/climate-support-001" +``` + +## [Optional] Property `Kind > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | -------- | +| **Default** | `"Kind"` | + +## [Optional] Property `Kind > address` + +**Title:** address + +**Requirement:** Optional + +The address of the contact + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ------------------------- | +| [Address](#kind--address_items) | A single physical address | + +### Kind > address > Address + +| **Type** | `object` | +| ------------------------- | ----------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Address](./temporal-spatial-metrics.md#address) | + +## [Optional] Property `Kind > hasEmail` + +**Title:** Email + +**Requirement:** Optional + +Email address for the contact in mailto: format (for example, mailto:support@example.gov) + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"mailto:climate-support@example.gov" +``` + +```json +"mailto:jane.smith@example.gov" +``` + +| Restrictions | | +| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Must match regular expression** | ```^mailto:[\w\_\~\!\$\&\'\(\)\*\+\,\;\=\:.-]+@[\w.-]+\.[\w.-]+?$``` [Test](https://regex101.com/?regex=%5Emailto%3A%5B%5Cw%5C_%5C~%5C%21%5C%24%5C%26%5C%27%5C%28%5C%29%5C%2A%5C%2B%5C%2C%5C%3B%5C%3D%5C%3A.-%5D%2B%40%5B%5Cw.-%5D%2B%5C.%5B%5Cw.-%5D%2B%3F%24&testString=%22mailto%3Aclimate-support%40example.gov%22) | + +## [Optional] Property `Kind > family-name` + +**Title:** family name + +**Requirement:** Optional + +The family name of the contact + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"Smith" +``` + +## [Optional] Property `Kind > fn` + +**Title:** formatted name + +**Requirement:** Optional + +The formatted text of the name of the contact + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"Climate Data Support Team" +``` + +```json +"Dr. Jane Smith" +``` + +## [Optional] Property `Kind > given-name` + +**Title:** given name + +**Requirement:** Optional + +The given name of the contact + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"Jane" +``` + +## [Optional] Property `Kind > organization-name` + +**Title:** organization name + +**Requirement:** Optional + +The name of the organization to contact + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"National Climate Data Center" +``` + +## [Optional] Property `Kind > tel` + +**Title:** telephone + +**Requirement:** Optional + +The telephone number for the contact + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"+1-555-123-4567" +``` + +## [Optional] Property `Kind > title` + +**Title:** position title + +**Requirement:** Optional + +The position role of the person to contact + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"Senior Climate Data Scientist" +``` diff --git a/jsonschema/docs/Catalog.md b/jsonschema/docs/catalog.md similarity index 88% rename from jsonschema/docs/Catalog.md rename to jsonschema/docs/catalog.md index 34362a62..2a6288ee 100644 --- a/jsonschema/docs/Catalog.md +++ b/jsonschema/docs/catalog.md @@ -1,4 +1,4 @@ - + **Title:** DCAT-US 3 Catalog @@ -69,37 +69,37 @@ A curated collection of metadata about datasets, data services, or other resourc | Property | Type | Title/Description | | ------------------------------------------------ | ----------------------- | --------------------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [catalog](#catalog ) | null or array | Related catalogs | -| - [contactPoint](#contactPoint ) | null or array | Contact points | -| + [dataset](#dataset ) | array | dataset | -| - [keyword](#keyword ) | null or array of string | keyword/tag | -| - [record](#record ) | null or array | catalog record | -| - [service](#service ) | null or array | service | -| - [theme](#theme ) | null or array | theme/category | -| - [themeTaxonomy](#themeTaxonomy ) | null or array | themes | -| - [accessRights](#accessRights ) | More than one type | access rights | -| - [conformsTo](#conformsTo ) | More than one type | schema version | -| - [creator](#creator ) | null or array | creator | -| - [description](#description ) | null or string | description | -| - [hasPart](#hasPart ) | null or array | has part | -| - [identifier](#identifier ) | More than one type | identifier | -| - [otherIdentifier](#otherIdentifier ) | null or array | other identifier | -| - [issued](#issued ) | More than one type | release date | -| - [language](#language ) | More than one type | language | -| - [license](#license ) | More than one type | license | -| - [modified](#modified ) | More than one type | update/modification date | -| - [publisher](#publisher ) | More than one type | publisher | -| - [rights](#rights ) | null or array of string | rights | -| - [rightsHolder](#rightsHolder ) | null or array | rights holder | -| - [spatial](#spatial ) | null or array | spatial/geographic coverage | -| - [subject](#subject ) | null or array | subject | -| - [temporal](#temporal ) | null or array | temporal coverage | -| - [title](#title ) | null or string | title | -| - [category](#category ) | null or array | category | -| - [homepage](#homepage ) | More than one type | homepage | -| - [qualifiedAttribution](#qualifiedAttribution ) | null or array | qualified attribution | +| - [@id](#@id) | string | - | +| - [@type](#@type) | string | - | +| - [catalog](#catalog) | null or array | Related catalogs | +| - [contactPoint](#contactPoint) | null or array | Contact points | +| + [dataset](#dataset) | array | dataset | +| - [keyword](#keyword) | null or array of string | keyword/tag | +| - [record](#record) | null or array | catalog record | +| - [service](#service) | null or array | service | +| - [theme](#theme) | null or array | theme/category | +| - [themeTaxonomy](#themeTaxonomy) | null or array | themes | +| - [accessRights](#accessRights) | More than one type | access rights | +| - [conformsTo](#conformsTo) | More than one type | schema version | +| - [creator](#creator) | null or array | creator | +| - [description](#description) | null or string | description | +| - [hasPart](#hasPart) | null or array | has part | +| - [identifier](#identifier) | More than one type | identifier | +| - [otherIdentifier](#otherIdentifier) | null or array | other identifier | +| - [issued](#issued) | More than one type | release date | +| - [language](#language) | More than one type | language | +| - [license](#license) | More than one type | license | +| - [modified](#modified) | More than one type | update/modification date | +| - [publisher](#publisher) | More than one type | publisher | +| - [rights](#rights) | null or array of string | rights | +| - [rightsHolder](#rightsHolder) | null or array | rights holder | +| - [spatial](#spatial) | null or array | spatial/geographic coverage | +| - [subject](#subject) | null or array | subject | +| - [temporal](#temporal) | null or array | temporal coverage | +| - [title](#title) | null or string | title | +| - [category](#category) | null or array | category | +| - [homepage](#homepage) | More than one type | homepage | +| - [qualifiedAttribution](#qualifiedAttribution) | null or array | qualified attribution | ## [Optional] Property `DCAT-US 3 Catalog > @id` @@ -140,10 +140,6 @@ List of related catalogs that are useful in the context of this catalog ### DCAT-US 3 Catalog > catalog > DCAT-US 3 Catalog -**Title:** DCAT-US 3 Catalog - -A curated collection of metadata about datasets, data services, or other resources - | **Type** | `object` | | ------------------------- | -------------------------- | | **Additional properties** | Any type allowed | @@ -166,14 +162,10 @@ Contact information people can use to ask questions or send feedback about the c ### DCAT-US 3 Catalog > contactPoint > Kind -**Title:** Kind - -Contact information for an individual or entity - | **Type** | `object` | | ------------------------- | ----------------- | | **Additional properties** | Any type allowed | -| **Defined in** | [Kind](./Kind.md) | +| **Defined in** | [Kind](./agents.md#kind) | ## [Optional] Property `DCAT-US 3 Catalog > dataset` @@ -193,14 +185,10 @@ List of datasets included in the catalog. Use this together with service so the ### DCAT-US 3 Catalog > dataset > Dataset -**Title:** Dataset - -A collection of data published or curated by one provider - | **Type** | `object` | | ------------------------- | ----------------------- | | **Additional properties** | Any type allowed | -| **Defined in** | [Dataset](./Dataset.md) | +| **Defined in** | [Dataset](./dataset.md#root) | ## [Optional] Property `DCAT-US 3 Catalog > keyword` @@ -254,14 +242,10 @@ A catalog record describing how a single resource (such as a dataset or data ser ### DCAT-US 3 Catalog > record > CatalogRecord -**Title:** CatalogRecord - -A record in a catalog, describing the registration of a single resource - | **Type** | `object` | | ------------------------- | ----------------------------------- | | **Additional properties** | Any type allowed | -| **Defined in** | [Catalogrecord](./Catalogrecord.md) | +| **Defined in** | [Catalogrecord](./quality-governance.md#catalog-record) | ## [Optional] Property `DCAT-US 3 Catalog > service` @@ -280,10 +264,6 @@ List of data services included in the catalog. Use this together with dataset so ### DCAT-US 3 Catalog > service > DataService -**Title:** DataService - -A service that provides access to data or data processing functions - | **Type** | `object` | | ------------------------- | -------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -306,10 +286,6 @@ List of themes or categories for the catalog. A catalog can have more than one t ### DCAT-US 3 Catalog > theme > Concept -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - | **Type** | More than one type | | ------------------------- | ----------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -332,10 +308,6 @@ Controlled vocabulary or taxonomy used to classify catalog resources, such as da ### DCAT-US 3 Catalog > themeTaxonomy > ConceptScheme -**Title:** ConceptScheme - -A controlled vocabulary or other list of approved terms for a concept - | **Type** | `object` | | ------------------------- | ------------------------------------------------------------------------------------------ | | **Additional properties** | Any type allowed | @@ -430,10 +402,6 @@ Person or organization responsible for creating the catalog metadata ### DCAT-US 3 Catalog > creator > Agent -**Title:** Agent - -A person, organization, software agent, or other entity involved with a resource - | **Type** | `object` | | ------------------------- | ---------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -477,10 +445,6 @@ List of catalogs that are contained within this catalog ### DCAT-US 3 Catalog > hasPart > DCAT-US 3 Catalog -**Title:** DCAT-US 3 Catalog - -A curated collection of metadata about datasets, data services, or other resources - | **Type** | `object` | | ------------------------- | -------------------------- | | **Additional properties** | Any type allowed | @@ -538,10 +502,6 @@ A list of identifiers for the Catalog besides the main identifier, e.g. the URI ### DCAT-US 3 Catalog > otherIdentifier > Identifier -**Title:** Identifier - -A unique identifier and optionally it's scheme and other relevant information - | **Type** | More than one type | | ------------------------- | -------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -928,10 +888,6 @@ Organizations that hold rights in the catalog ### DCAT-US 3 Catalog > rightsHolder > Organization -**Title:** Organization - -An organization involved with a resource, including parent or child organizations - | **Type** | `object` | | ------------------------- | ------------------------------------------------------------------------------ | | **Additional properties** | Any type allowed | @@ -954,10 +910,6 @@ Geographic area covered by the catalog ### DCAT-US 3 Catalog > spatial > Location -**Title:** Location - -A named place or geographic area - | **Type** | `object` | | ------------------------- | ------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -980,10 +932,6 @@ List of subjects of the catalog ### DCAT-US 3 Catalog > subject > Concept -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - | **Type** | More than one type | | ------------------------- | ----------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1006,10 +954,6 @@ Time periods covered by the catalog ### DCAT-US 3 Catalog > temporal > PeriodOfTime -**Title:** PeriodOfTime - -Information about a specific time period with a start- and/or end-time - | **Type** | More than one type | | ------------------------- | ------------------------------------------------------------------------------ | | **Additional properties** | Any type allowed | @@ -1053,10 +997,6 @@ List of high-level categories for the catalog ### DCAT-US 3 Catalog > category > Concept -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - | **Type** | More than one type | | ------------------------- | ----------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1114,12 +1054,7 @@ List of agents with specific responsibilities for the catalog ### DCAT-US 3 Catalog > qualifiedAttribution > Attribution -**Title:** Attribution - -A responsibility that an agent has for a resource - | **Type** | `object` | | ------------------------- | ----------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Attribution](#dataset_items_sample_items_accessService_items_qualifiedAttribution_items) | - diff --git a/jsonschema/docs/constraints-and-restrictions.md b/jsonschema/docs/constraints-and-restrictions.md new file mode 100644 index 00000000..f290fd1f --- /dev/null +++ b/jsonschema/docs/constraints-and-restrictions.md @@ -0,0 +1,410 @@ +# Constraints and Restrictions + +This page combines supporting DCAT-US 3 classes used with the main schema classes. + + + +## AccessRestriction + +**Title:** AccessRestriction + +Rules or indicators that describe who can access a resource + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "AccessRestriction", + "restrictionStatus": "Restricted - Fully", + "specificRestriction": "PRMPA - National Security Classified (B)", + "restrictionNote": "Access restricted to authorized personnel only." +} +``` + +| Property | Type | Title/Description | +| ---------------------------------------------- | ------------------ | -------------------- | +| - [@id](#access-restriction--@id) | string | - | +| - [@type](#access-restriction--@type) | string | - | +| - [restrictionNote](#access-restriction--restrictionNote) | null or string | restriction note | +| + [restrictionStatus](#access-restriction--restrictionStatus) | object | restriction status | +| - [specificRestriction](#access-restriction--specificRestriction) | More than one type | specific restriction | + +## [Optional] Property `AccessRestriction > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +## [Optional] Property `AccessRestriction > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | --------------------- | +| **Default** | `"AccessRestriction"` | + +## [Optional] Property `AccessRestriction > restrictionNote` + +**Title:** restriction note + +**Requirement:** Optional + +A note related to the access restriction + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"Access restricted to authorized personnel only." +``` + +## [Optional] Property `AccessRestriction > restrictionStatus` + +**Title:** restriction status + +**Requirement:** Optional + +The indication of whether or not there are access restrictions on the item, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/access-restriction-status + +| **Type** | More than one type | +| ------------------------- | ----------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | +| **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | + +**Examples:** + +```json +"Restricted - Fully" +``` + +```json +"Unrestricted" +``` + +## [Optional] Property `AccessRestriction > specificRestriction` + +**Title:** specific restriction + +**Requirement:** Optional + +Authority, code list entry, or policy reference that defines the specific access restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-access-restriction + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"CRCCRCA 4(1)(A)" +``` + +```json +"PRMPA - National Security Classified (B)" +``` + +| Any of(Option) | +| --------------------------------------------------------------- | +| [Null allowed when not required](#access-restriction--specificRestriction_anyOf_i0) | +| [Concept](#access-restriction--specificRestriction_anyOf_i1) | + +### Property `AccessRestriction > specificRestriction > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `AccessRestriction > specificRestriction > anyOf > Concept` + +**Title:** Concept + +inline description of the specific restriction + +| **Type** | More than one type | +| ------------------------- | --------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [restrictionStatus](#access-restriction--restrictionStatus) | + +--- + + + +## CUIRestriction + +**Title:** CUIRestriction + +Information describing Controlled Unclassified Information (CUI) restrictions for a resource + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "CUIRestriction", + "cuiBannerMarking": "CUI//SP-CTI", + "designationIndicator": "Controlled by: Agency XYZ" +} +``` + +| Property | Type | Title/Description | +| ------------------------------------------------------------------ | ----------------------- | -------------------------------- | +| - [@id](#cui-restriction--@id) | string | - | +| - [@type](#cui-restriction--@type) | string | - | +| + [cuiBannerMarking](#cui-restriction--cuiBannerMarking) | string | CUI banner marking | +| + [designationIndicator](#cui-restriction--designationIndicator) | string | CUI designation indicator | +| - [requiredIndicatorPerAuthority](#cui-restriction--requiredIndicatorPerAuthority) | null or array of string | required indicator per authority | + +## [Optional] Property `CUIRestriction > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/cui-restrictions/dataset-001" +``` + +## [Optional] Property `CUIRestriction > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ------------------ | +| **Default** | `"CUIRestriction"` | + +## [Optional] Property `CUIRestriction > cuiBannerMarking` + +**Title:** CUI banner marking + +**Requirement:** Optional + +CUI (Controlled Unclassified Information) banner marking is required for any unclassified information that is deemed sensitive and requires protection; see information at https://www.archives.gov/cui/registry/category-marking-list + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"CUI//SP-CTI" +``` + +```json +"CUI//SP-PRVCY//SP-LEGAL" +``` + +## [Optional] Property `CUIRestriction > designationIndicator` + +**Title:** CUI designation indicator + +**Requirement:** Optional + +Agency that designated the information as CUI; include at least "Controlled by:" and, when possible, contact information + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"Controlled by: Agency XYZ" +``` + +```json +"Controlled by: DOC; POC: Jane Smith, mailto:jane.smith@example.gov, XXX-XXX-XXXX" +``` + +## [Optional] Property `CUIRestriction > requiredIndicatorPerAuthority` + +**Title:** required indicator per authority + +**Requirement:** Optional + +List of free-text required indicators from the applicable authority (for example, category descriptions or distribution statements) + +| **Type** | `null or array of string` | +| -------- | ------------------------- | + +**Example:** + +```json +[ + "Privacy Act of 1974", + "Federal Records Act" +] +``` + +| Each item of this array must be | Description | +| -------------------------------------------------------- | ----------- | +| [Indicator string](#cui-restriction--requiredIndicatorPerAuthority_items) | - | + +### CUIRestriction > requiredIndicatorPerAuthority > Indicator string + +**Title:** Indicator string + +| **Type** | `string` | +| -------- | -------- | + +--- + + + +## UseRestriction + +**Title:** UseRestriction + +Rules or legal limits on how a resource may be used + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "UseRestriction", + "restrictionStatus": "Restricted - Fully", + "specificRestriction": "Trademark", + "restrictionNote": "This data may be used for any purpose without restriction." +} +``` + +| Property | Type | Title/Description | +| ---------------------------------------------- | ------------------ | -------------------- | +| - [@id](#use-restriction--@id) | string | - | +| - [@type](#use-restriction--@type) | string | - | +| - [restrictionNote](#use-restriction--restrictionNote) | null or string | restriction note | +| + [restrictionStatus](#use-restriction--restrictionStatus) | object | restriction status | +| - [specificRestriction](#use-restriction--specificRestriction) | More than one type | specific restriction | + +## [Optional] Property `UseRestriction > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/restrictions/use-restriction-001" +``` + +## [Optional] Property `UseRestriction > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ------------------ | +| **Default** | `"UseRestriction"` | + +## [Optional] Property `UseRestriction > restrictionNote` + +**Title:** restriction note + +**Requirement:** Optional + +Significant information pertaining to the use or reproduction of the data + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"This data may be used for any purpose without restriction." +``` + +```json +"This data may be used for research purposes. Commercial use requires written permission from the data steward." +``` + +## [Optional] Property `UseRestriction > restrictionStatus` + +**Title:** restriction status + +**Requirement:** Optional + +Indication of whether or not there are use restrictions on the archival materials, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/use-restriction-status + +| **Type** | More than one type | +| ------------------------- | ----------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | +| **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | + +**Examples:** + +```json +"Restricted - Fully" +``` + +```json +"Unrestricted" +``` + +## [Optional] Property `UseRestriction > specificRestriction` + +**Title:** specific restriction + +**Requirement:** Optional + +Authority, code list entry, or policy reference that defines the specific use restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-use-restriction + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"Copyright" +``` + +```json +"Trademark" +``` + +| Any of(Option) | +| --------------------------------------------------------------- | +| [Null allowed when not required](#use-restriction--specificRestriction_anyOf_i0) | +| [Concept](#use-restriction--specificRestriction_anyOf_i1) | + +### Property `UseRestriction > specificRestriction > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `UseRestriction > specificRestriction > anyOf > Concept` + +**Title:** Concept + +inline description of the specific restriction + +| **Type** | More than one type | +| ------------------------- | --------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [restrictionStatus](#use-restriction--restrictionStatus) | diff --git a/jsonschema/docs/DatasetSeries.md b/jsonschema/docs/dataset-series.md similarity index 92% rename from jsonschema/docs/DatasetSeries.md rename to jsonschema/docs/dataset-series.md index 00876ddd..951efff7 100644 --- a/jsonschema/docs/DatasetSeries.md +++ b/jsonschema/docs/dataset-series.md @@ -1,4 +1,4 @@ - + **Title:** DatasetSeries @@ -143,20 +143,20 @@ A group of related datasets that are published separately | Property | Type | Title/Description | | -------------------------------------------- | ------------------ | --------------------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [contactPoint](#contactPoint ) | null or array | contact point | -| - [first](#first ) | More than one type | first | -| - [last](#last ) | More than one type | last | -| - [seriesMember](#seriesMember ) | null or array | series member | -| - [accrualPeriodicity](#accrualPeriodicity ) | More than one type | frequency | -| + [description](#description ) | string | description | -| - [issued](#issued ) | More than one type | release date | -| - [modified](#modified ) | More than one type | update/modification date | -| - [publisher](#publisher ) | More than one type | publisher | -| - [spatial](#spatial ) | null or array | spatial/geographic coverage | -| - [temporal](#temporal ) | null or array | temporal coverage | -| + [title](#title ) | string | title | +| - [@id](#@id) | string | - | +| - [@type](#@type) | string | - | +| - [contactPoint](#contactPoint) | null or array | contact point | +| - [first](#first) | More than one type | first | +| - [last](#last) | More than one type | last | +| - [seriesMember](#seriesMember) | null or array | series member | +| - [accrualPeriodicity](#accrualPeriodicity) | More than one type | frequency | +| + [description](#description) | string | description | +| - [issued](#issued) | More than one type | release date | +| - [modified](#modified) | More than one type | update/modification date | +| - [publisher](#publisher) | More than one type | publisher | +| - [spatial](#spatial) | null or array | spatial/geographic coverage | +| - [temporal](#temporal) | null or array | temporal coverage | +| + [title](#title) | string | title | ## [Optional] Property `DatasetSeries > @id` @@ -197,14 +197,10 @@ List of contacts people can use to ask questions or send feedback about the data ### DatasetSeries > contactPoint > Kind -**Title:** Kind - -Contact information for an individual or entity - | **Type** | `object` | | ------------------------- | ----------------- | | **Additional properties** | Any type allowed | -| **Defined in** | [Kind](./Kind.md) | +| **Defined in** | [Kind](./agents.md#kind) | ## [Optional] Property `DatasetSeries > first` @@ -239,7 +235,7 @@ inline description of the first dataset | **Type** | `object` | | ------------------------- | ----------------------- | | **Additional properties** | Any type allowed | -| **Defined in** | [Dataset](./Dataset.md) | +| **Defined in** | [Dataset](./dataset.md#root) | ## [Optional] Property `DatasetSeries > last` @@ -293,10 +289,6 @@ List of members of the Dataset Series ### DatasetSeries > seriesMember > Dataset -**Title:** Dataset - -A collection of data published or curated by one provider - | **Type** | `object` | | ------------------------- | -------------------------- | | **Additional properties** | Any type allowed | @@ -648,10 +640,6 @@ A geographic region that is covered by the Dataset Series ### DatasetSeries > spatial > Location -**Title:** Location - -A named place or geographic area - | **Type** | `object` | | ------------------------- | -------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -674,10 +662,6 @@ Time periods covered by the dataset series ### DatasetSeries > temporal > PeriodOfTime -**Title:** PeriodOfTime - -Information about a specific time period with a start- and/or end-time - | **Type** | More than one type | | ------------------------- | ------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -704,4 +688,3 @@ Human-readable title of the dataset series ```json "Annual National Climate Observations Series" ``` - diff --git a/jsonschema/docs/Dataset.md b/jsonschema/docs/dataset.md similarity index 88% rename from jsonschema/docs/Dataset.md rename to jsonschema/docs/dataset.md index 4c07cf26..b33f28ed 100644 --- a/jsonschema/docs/Dataset.md +++ b/jsonschema/docs/dataset.md @@ -1,4 +1,4 @@ - + **Title:** Dataset @@ -99,64 +99,64 @@ A collection of data published or curated by one provider | Property | Type | Title/Description | | ---------------------------------------------------------- | ----------------------- | --------------------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [otherIdentifier](#otherIdentifier ) | null or array | other identifier | -| - [sample](#sample ) | null or array | sample | -| - [status](#status ) | More than one type | lifecycle status | -| - [supportedSchema](#supportedSchema ) | More than one type | supported schema | -| - [versionNotes](#versionNotes ) | null or string | version notes | -| + [contactPoint](#contactPoint ) | More than one type | contact point | -| - [distribution](#distribution ) | null or array | dataset distribution | -| - [first](#first ) | More than one type | first | -| - [hasCurrentVersion](#hasCurrentVersion ) | More than one type | current version | -| - [hasVersion](#hasVersion ) | null or array | has version | -| - [inSeries](#inSeries ) | null or array | in series | -| - [keyword](#keyword ) | null or array of string | keyword/tag | -| - [landingPage](#landingPage ) | More than one type | landing page | -| - [previousVersion](#previousVersion ) | More than one type | previous version | -| - [qualifiedRelation](#qualifiedRelation ) | null or array | qualified relation | -| - [spatialResolutionInMeters](#spatialResolutionInMeters ) | null or string | Spatial resolution (meters) | -| - [temporalResolution](#temporalResolution ) | null or string | temporal resolution | -| - [theme](#theme ) | null or array | theme/category | -| - [version](#version ) | null or string | version | -| - [describedBy](#describedBy ) | More than one type | data dictionary | -| - [liabilityStatement](#liabilityStatement ) | More than one type | liability statement | -| - [metadataDistribution](#metadataDistribution ) | null or array | metadata distribution | -| - [purpose](#purpose ) | null or string | purpose | -| - [accessRights](#accessRights ) | More than one type | access rights | -| - [accrualPeriodicity](#accrualPeriodicity ) | More than one type | frequency | -| - [conformsTo](#conformsTo ) | null or array | conforms to | -| - [contributor](#contributor ) | null or array | contributor | -| - [created](#created ) | More than one type | creation date | -| - [creator](#creator ) | More than one type | creator | -| + [description](#description ) | string | description | -| - [hasPart](#hasPart ) | null or array | has part | -| + [identifier](#identifier ) | More than one type | identifier | -| - [isReferencedBy](#isReferencedBy ) | null or array of string | is referenced by | -| - [issued](#issued ) | More than one type | release date | -| - [language](#language ) | More than one type | language | -| - [modified](#modified ) | More than one type | last modified | -| - [provenance](#provenance ) | null or array of string | provenance | -| + [publisher](#publisher ) | object | publisher | -| - [relation](#relation ) | null or array of string | related resource | -| - [replaces](#replaces ) | null or array | replaces | -| - [rights](#rights ) | null or array of string | rights | -| - [rightsHolder](#rightsHolder ) | null or array | rights holder | -| - [source](#source ) | null or array | data source | -| - [spatial](#spatial ) | More than one type | spatial/geographic coverage | -| - [subject](#subject ) | null or array | subject | -| - [temporal](#temporal ) | null or array | temporal coverage | -| + [title](#title ) | string | title | -| - [category](#category ) | null or array | category | -| - [hasQualityMeasurement](#hasQualityMeasurement ) | null or array | quality measurement | -| - [page](#page ) | null or array | documentation | -| - [qualifiedAttribution](#qualifiedAttribution ) | null or array | qualified attribution | -| - [wasAttributedTo](#wasAttributedTo ) | null or array | attribution | -| - [wasGeneratedBy](#wasGeneratedBy ) | null or array | was generated by | -| - [wasUsedBy](#wasUsedBy ) | null or array | used by | -| - [image](#image ) | More than one type | image | -| - [scopeNote](#scopeNote ) | null or string | usage note | +| - [@id](#@id) | string | - | +| - [@type](#@type) | string | - | +| - [otherIdentifier](#otherIdentifier) | null or array | other identifier | +| - [sample](#sample) | null or array | sample | +| - [status](#status) | More than one type | lifecycle status | +| - [supportedSchema](#supportedSchema) | More than one type | supported schema | +| - [versionNotes](#versionNotes) | null or string | version notes | +| + [contactPoint](#contactPoint) | More than one type | contact point | +| - [distribution](#distribution) | null or array | dataset distribution | +| - [first](#first) | More than one type | first | +| - [hasCurrentVersion](#hasCurrentVersion) | More than one type | current version | +| - [hasVersion](#hasVersion) | null or array | has version | +| - [inSeries](#inSeries) | null or array | in series | +| - [keyword](#keyword) | null or array of string | keyword/tag | +| - [landingPage](#landingPage) | More than one type | landing page | +| - [previousVersion](#previousVersion) | More than one type | previous version | +| - [qualifiedRelation](#qualifiedRelation) | null or array | qualified relation | +| - [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Spatial resolution (meters) | +| - [temporalResolution](#temporalResolution) | null or string | temporal resolution | +| - [theme](#theme) | null or array | theme/category | +| - [version](#version) | null or string | version | +| - [describedBy](#describedBy) | More than one type | data dictionary | +| - [liabilityStatement](#liabilityStatement) | More than one type | liability statement | +| - [metadataDistribution](#metadataDistribution) | null or array | metadata distribution | +| - [purpose](#purpose) | null or string | purpose | +| - [accessRights](#accessRights) | More than one type | access rights | +| - [accrualPeriodicity](#accrualPeriodicity) | More than one type | frequency | +| - [conformsTo](#conformsTo) | null or array | conforms to | +| - [contributor](#contributor) | null or array | contributor | +| - [created](#created) | More than one type | creation date | +| - [creator](#creator) | More than one type | creator | +| + [description](#description) | string | description | +| - [hasPart](#hasPart) | null or array | has part | +| + [identifier](#identifier) | More than one type | identifier | +| - [isReferencedBy](#isReferencedBy) | null or array of string | is referenced by | +| - [issued](#issued) | More than one type | release date | +| - [language](#language) | More than one type | language | +| - [modified](#modified) | More than one type | last modified | +| - [provenance](#provenance) | null or array of string | provenance | +| + [publisher](#publisher) | object | publisher | +| - [relation](#relation) | null or array of string | related resource | +| - [replaces](#replaces) | null or array | replaces | +| - [rights](#rights) | null or array of string | rights | +| - [rightsHolder](#rightsHolder) | null or array | rights holder | +| - [source](#source) | null or array | data source | +| - [spatial](#spatial) | More than one type | spatial/geographic coverage | +| - [subject](#subject) | null or array | subject | +| - [temporal](#temporal) | null or array | temporal coverage | +| + [title](#title) | string | title | +| - [category](#category) | null or array | category | +| - [hasQualityMeasurement](#hasQualityMeasurement) | null or array | quality measurement | +| - [page](#page) | null or array | documentation | +| - [qualifiedAttribution](#qualifiedAttribution) | null or array | qualified attribution | +| - [wasAttributedTo](#wasAttributedTo) | null or array | attribution | +| - [wasGeneratedBy](#wasGeneratedBy) | null or array | was generated by | +| - [wasUsedBy](#wasUsedBy) | null or array | used by | +| - [image](#image) | More than one type | image | +| - [scopeNote](#scopeNote) | null or string | usage note | ## [Optional] Property `Dataset > @id` @@ -197,14 +197,10 @@ Additional identifiers for the dataset besides the main identifier, such as a DO ### Dataset > otherIdentifier > Identifier -**Title:** Identifier - -A unique identifier and optionally it's scheme and other relevant information - | **Type** | More than one type | | ------------------------- | ----------------------------- | | **Additional properties** | Any type allowed | -| **Defined in** | [Identifier](./Identifier.md) | +| **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | ## [Optional] Property `Dataset > sample` @@ -223,14 +219,10 @@ List of sample distributions for the dataset ### Dataset > sample > Distribution -**Title:** Distribution - -A specific representation of a dataset, such as a file, feed, or API response - | **Type** | `object` | | ------------------------- | --------------------------------- | | **Additional properties** | Any type allowed | -| **Defined in** | [Distribution](./Distribution.md) | +| **Defined in** | [Distribution](./distribution.md#root) | ## [Optional] Property `Dataset > status` @@ -361,10 +353,6 @@ inline description of Kind #### Dataset > contactPoint > anyOf > List of contacts > Kind -**Title:** Kind - -Contact information for an individual or entity - | **Type** | `object` | | ------------------------- | ------------------------------------------------------------ | | **Additional properties** | Any type allowed | @@ -387,10 +375,6 @@ List of available distributions for the dataset. This can be omitted when no dis ### Dataset > distribution > Distribution -**Title:** Distribution - -A specific representation of a dataset, such as a file, feed, or API response - | **Type** | `object` | | ------------------------- | ----------------------------- | | **Additional properties** | Any type allowed | @@ -483,10 +467,6 @@ List of related Datasets that are a version, edition, or adaptation of the descr ### Dataset > hasVersion > Dataset -**Title:** Dataset - -A collection of data published or curated by one provider - | **Type** | `object` | | ------------------------- | ---------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -509,10 +489,6 @@ Dataset series this dataset belongs to ### Dataset > inSeries > DatasetSeries -**Title:** DatasetSeries - -A group of related datasets that are published separately - | **Type** | `object` | | ------------------------- | ------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -654,10 +630,6 @@ Detailed relationship between the dataset and another resource, including the ro ### Dataset > qualifiedRelation > Relationship -**Title:** Relationship - -Additional information about how one resource is related to another - | **Type** | `object` | | ------------------------- | --------------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -714,10 +686,6 @@ List of themes or categories for the dataset ### Dataset > theme > Concept -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - | **Type** | More than one type | | ------------------------- | --------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -829,10 +797,6 @@ Distribution of the original metadata document this dataset was derived from ### Dataset > metadataDistribution > Distribution -**Title:** Distribution - -A specific representation of a dataset, such as a file, feed, or API response - | **Type** | `object` | | ------------------------- | ----------------------------- | | **Additional properties** | Any type allowed | @@ -1003,10 +967,6 @@ List of standards, schemas, or profiles the dataset follows ### Dataset > conformsTo > Standard -**Title:** Standard - -A standard or specification that another resource conforms to - | **Type** | `object` | | ------------------------- | ------------------------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1029,10 +989,6 @@ List of agents contributing to the Dataset ### Dataset > contributor > Agent -**Title:** Agent - -A person, organization, software agent, or other entity involved with a resource - | **Type** | `object` | | ------------------------- | ------------------------------------------------------------------------------------------------ | | **Additional properties** | Any type allowed | @@ -1203,10 +1159,6 @@ List of related datasets that are part of the described dataset ### Dataset > hasPart > Dataset -**Title:** Dataset - -A collection of data published or curated by one provider - | **Type** | `object` | | ------------------------- | ---------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1572,7 +1524,7 @@ Organization responsible for publishing and making the dataset available | ------------------------- | --------------------------------- | | **Required** | Yes | | **Additional properties** | Any type allowed | -| **Defined in** | [Organization](./Organization.md) | +| **Defined in** | [Organization](./agents.md#organization) | ## [Optional] Property `Dataset > relation` @@ -1624,10 +1576,6 @@ List of Datasets replaced by this Dataset ### Dataset > replaces > Dataset -**Title:** Dataset - -A collection of data published or curated by one provider - | **Type** | `object` | | ------------------------- | ---------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1686,10 +1634,6 @@ List of agents (organizations) holding rights on the Dataset ### Dataset > rightsHolder > Organization -**Title:** Organization - -An organization involved with a resource, including parent or child organizations - | **Type** | `object` | | ------------------------- | ---------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1712,10 +1656,6 @@ List of related Datasets from which the described Dataset is derived ### Dataset > source > Dataset -**Title:** Dataset - -A collection of data published or curated by one provider - | **Type** | `object` | | ------------------------- | ---------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1770,10 +1710,6 @@ inline description of Location #### Dataset > spatial > anyOf > List of geographic regions > Location -**Title:** Location - -A named place or geographic area - | **Type** | `object` | | ------------------------- | ---------------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1796,10 +1732,6 @@ List of primary subjects for the dataset, usually narrower than broad theme cate ### Dataset > subject > Concept -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - | **Type** | More than one type | | ------------------------- | --------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1822,10 +1754,6 @@ Time periods covered by the dataset ### Dataset > temporal > PeriodOfTime -**Title:** PeriodOfTime - -Information about a specific time period with a start- and/or end-time - | **Type** | More than one type | | ------------------------- | --------------------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1870,10 +1798,6 @@ List of high-level categories for the dataset ### Dataset > category > Concept -**Title:** Concept - -A controlled term or label, optionally drawn from a concept scheme - | **Type** | More than one type | | ------------------------- | --------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1896,10 +1820,6 @@ List of quality measurements for the dataset (for example, completeness, accurac ### Dataset > hasQualityMeasurement > QualityMeasurement -**Title:** QualityMeasurement - -A measurement of a resource against a specific quality metric - | **Type** | `object` | | ------------------------- | ------------------------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1922,10 +1842,6 @@ List of pages or documents about this dataset ### Dataset > page > Document -**Title:** Document - -A publication or other document related to a resource - | **Type** | `object` | | ------------------------- | -------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1948,10 +1864,6 @@ List of agents with specific responsibilities for the dataset ### Dataset > qualifiedAttribution > Attribution -**Title:** Attribution - -A responsibility that an agent has for a resource - | **Type** | `object` | | ------------------------- | ----------------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1974,10 +1886,6 @@ List of agents attributed to this dataset ### Dataset > wasAttributedTo > Agent -**Title:** Agent - -A person, organization, software agent, or other entity involved with a resource - | **Type** | `object` | | ------------------------- | ------------------------------------------------------------------------------------------------ | | **Additional properties** | Any type allowed | @@ -2000,10 +1908,6 @@ List of activities that generated, or provide the business context for the creat ### Dataset > wasGeneratedBy > Activity -**Title:** Activity - -An activity related to creating, changing, or using a resource - | **Type** | `object` | | ------------------------- | -------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -2026,10 +1930,6 @@ List of activities that used the Dataset ### Dataset > wasUsedBy > Activity -**Title:** Activity - -An activity related to creating, changing, or using a resource - | **Type** | `object` | | ------------------------- | -------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -2085,4 +1985,3 @@ usage note for the dataset ```json "This dataset contains raw observational data. For derived products such as monthly averages or climate normals, see related datasets." ``` - diff --git a/jsonschema/docs/Distribution.md b/jsonschema/docs/distribution.md similarity index 88% rename from jsonschema/docs/Distribution.md rename to jsonschema/docs/distribution.md index 833aaf06..1de9db33 100644 --- a/jsonschema/docs/Distribution.md +++ b/jsonschema/docs/distribution.md @@ -1,4 +1,4 @@ - + **Title:** Distribution @@ -38,41 +38,41 @@ A specific representation of a dataset, such as a file, feed, or API response | Property | Type | Title/Description | | ---------------------------------------------------------- | ----------------------- | --------------------------- | -| - [@id](#@id ) | string | - | -| - [@type](#@type ) | string | - | -| - [representationTechnique](#representationTechnique ) | More than one type | representation technique | -| - [status](#status ) | More than one type | lifecycle status | -| - [characterEncoding](#characterEncoding ) | More than one type | character encoding | -| - [accessService](#accessService ) | null or array | access service | -| - [accessURL](#accessURL ) | More than one type | access URL | -| - [byteSize](#byteSize ) | null or string | byte size | -| - [compressFormat](#compressFormat ) | null or string | compression format | -| - [downloadURL](#downloadURL ) | More than one type | download URL | -| - [mediaType](#mediaType ) | null or string | media type | -| - [packageFormat](#packageFormat ) | null or string | packaging format | -| - [spatialResolutionInMeters](#spatialResolutionInMeters ) | null or string | Spatial resolution (meters) | -| - [temporalResolution](#temporalResolution ) | null or string | termporal resolution | -| - [availability](#availability ) | More than one type | availability | -| - [accessRestriction](#accessRestriction ) | null or array | access restriction | -| - [cuiRestriction](#cuiRestriction ) | More than one type | CUI restriction | -| - [describedBy](#describedBy ) | More than one type | data dictionary | -| - [useRestriction](#useRestriction ) | null or array | use restriction | -| - [accessRights](#accessRights ) | More than one type | access rights | -| - [conformsTo](#conformsTo ) | null or array | linked schemas | -| - [description](#description ) | null or string | description | -| - [format](#format ) | null or string | format | -| - [identifier](#identifier ) | More than one type | identifier | -| - [otherIdentifier](#otherIdentifier ) | null or array | other identifier | -| - [issued](#issued ) | More than one type | release date | -| - [language](#language ) | More than one type | language | -| - [license](#license ) | More than one type | license | -| - [modified](#modified ) | More than one type | last modified | -| - [rights](#rights ) | null or array of string | rights | -| - [title](#title ) | null or string | title | -| - [hasQualityMeasurement](#hasQualityMeasurement ) | null or array | quality measurement | -| - [page](#page ) | null or array | documentation | -| - [image](#image ) | More than one type | image | -| - [checksum](#checksum ) | More than one type | checksum | +| - [@id](#@id) | string | - | +| - [@type](#@type) | string | - | +| - [representationTechnique](#representationTechnique) | More than one type | representation technique | +| - [status](#status) | More than one type | lifecycle status | +| - [characterEncoding](#characterEncoding) | More than one type | character encoding | +| - [accessService](#accessService) | null or array | access service | +| - [accessURL](#accessURL) | More than one type | access URL | +| - [byteSize](#byteSize) | null or string | byte size | +| - [compressFormat](#compressFormat) | null or string | compression format | +| - [downloadURL](#downloadURL) | More than one type | download URL | +| - [mediaType](#mediaType) | null or string | media type | +| - [packageFormat](#packageFormat) | null or string | packaging format | +| - [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Spatial resolution (meters) | +| - [temporalResolution](#temporalResolution) | null or string | termporal resolution | +| - [availability](#availability) | More than one type | availability | +| - [accessRestriction](#accessRestriction) | null or array | access restriction | +| - [cuiRestriction](#cuiRestriction) | More than one type | CUI restriction | +| - [describedBy](#describedBy) | More than one type | data dictionary | +| - [useRestriction](#useRestriction) | null or array | use restriction | +| - [accessRights](#accessRights) | More than one type | access rights | +| - [conformsTo](#conformsTo) | null or array | linked schemas | +| - [description](#description) | null or string | description | +| - [format](#format) | null or string | format | +| - [identifier](#identifier) | More than one type | identifier | +| - [otherIdentifier](#otherIdentifier) | null or array | other identifier | +| - [issued](#issued) | More than one type | release date | +| - [language](#language) | More than one type | language | +| - [license](#license) | More than one type | license | +| - [modified](#modified) | More than one type | last modified | +| - [rights](#rights) | null or array of string | rights | +| - [title](#title) | null or string | title | +| - [hasQualityMeasurement](#hasQualityMeasurement) | null or array | quality measurement | +| - [page](#page) | null or array | documentation | +| - [image](#image) | More than one type | image | +| - [checksum](#checksum) | More than one type | checksum | ## [Optional] Property `Distribution > @id` @@ -129,7 +129,7 @@ inline description of Concept | **Type** | More than one type | | ------------------------- | ----------------------- | | **Additional properties** | Any type allowed | -| **Defined in** | [Concept](./Concept.md) | +| **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | ## [Optional] Property `Distribution > status` @@ -233,14 +233,10 @@ A data service that gives access to the distribution of the dataset ### Distribution > accessService > DataService -**Title:** DataService - -A service that provides access to data or data processing functions - | **Type** | `object` | | ------------------------- | ------------------------------- | | **Additional properties** | Any type allowed | -| **Defined in** | [Dataservice](./Dataservice.md) | +| **Defined in** | [Dataservice](./quality-governance.md#data-service) | ## [Optional] Property `Distribution > accessURL` @@ -480,10 +476,6 @@ List of access restrictions related to the distribution ### Distribution > accessRestriction > AccessRestriction -**Title:** AccessRestriction - -Rules or indicators that describe who can access a resource - | **Type** | `object` | | ------------------------- | -------------------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -576,10 +568,6 @@ Use restriction related to the distribution ### Distribution > useRestriction > UseRestriction -**Title:** UseRestriction - -Rules or legal limits on how a resource may be used - | **Type** | `object` | | ------------------------- | -------------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -639,10 +627,6 @@ List of standards, schemas, or reference systems the Distribution follows (prefe ### Distribution > conformsTo > Standard -**Title:** Standard - -A standard or specification that another resource conforms to - | **Type** | `object` | | ------------------------- | ---------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -738,10 +722,6 @@ A list of identifiers for the Distribution besides the main identifier, e.g. the ### Distribution > otherIdentifier > Identifier -**Title:** Identifier - -A unique identifier and optionally it's scheme and other relevant information - | **Type** | More than one type | | ------------------------- | ---------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1111,10 +1091,6 @@ Quality measurements for the distribution (for example, completeness, accuracy, ### Distribution > hasQualityMeasurement > QualityMeasurement -**Title:** QualityMeasurement - -A measurement of a resource against a specific quality metric - | **Type** | `object` | | ------------------------- | ------------------------------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1137,10 +1113,6 @@ A page or document about this Distribution ### Distribution > page > Document -**Title:** Document - -A publication or other document related to a resource - | **Type** | `object` | | ------------------------- | ---------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | @@ -1214,4 +1186,3 @@ inline description of Checksum | ------------------------- | ----------------------------------------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Checksum](#accessService_items_servesDataset_items_sample_items_checksum_anyOf_i1) | - diff --git a/jsonschema/docs/identifiers-and-relationships.md b/jsonschema/docs/identifiers-and-relationships.md new file mode 100644 index 00000000..8181b1ed --- /dev/null +++ b/jsonschema/docs/identifiers-and-relationships.md @@ -0,0 +1,926 @@ +# Identifiers and Relationships + +This page combines supporting DCAT-US 3 classes used with the main schema classes. + + + +## Identifier + +**Title:** Identifier + +A unique identifier and optionally it's scheme and other relevant information + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------------- | +| [Simple string identifier](#identifier--anyOf_i0) | +| [Identifier as a complex object](#identifier--anyOf_i1) | + +## Property `Identifier > anyOf > Simple string identifier` + +**Title:** Simple string identifier + +| **Type** | `string` | +| -------- | -------- | + +## Property `Identifier > anyOf > Identifier as a complex object` + +**Title:** Identifier as a complex object + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +| Property | Type | Title/Description | +| ----------------------------------------- | ------------------ | ----------------- | +| - [@id](#identifier--anyOf_i1_@id) | string | - | +| - [@type](#identifier--anyOf_i1_@type) | string | - | +| - [schemaAgency](#identifier--anyOf_i1_schemaAgency) | null or string | schema agency | +| - [creator](#identifier--anyOf_i1_creator) | More than one type | creator | +| - [issued](#identifier--anyOf_i1_issued) | More than one type | issued | +| - [version](#identifier--anyOf_i1_version) | null or string | version | +| - [notation](#identifier--anyOf_i1_notation) | null or string | notation | + +### Property `Identifier > anyOf > Identifier as a complex object > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +### Property `Identifier > anyOf > Identifier as a complex object > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | -------------- | +| **Default** | `"Identifier"` | + +### Property `Identifier > anyOf > Identifier as a complex object > schemaAgency` + +**Title:** schema agency + +**Requirement:** Optional + +The name of the agency that issued the identifier + +| **Type** | `null or string` | +| -------- | ---------------- | + +### Property `Identifier > anyOf > Identifier as a complex object > creator` + +**Title:** creator + +**Requirement:** Optional + +the agency that manages the identifier scheme + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------------------------------ | +| [Null allowed when not required](#identifier--anyOf_i1_creator_anyOf_i0) | +| [Organization](#identifier--anyOf_i1_creator_anyOf_i1) | + +#### Property `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +#### Property `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Organization` + +**Title:** Organization + +inline description of the creator + +| **Type** | `object` | +| ------------------------- | --------------------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Organization](./agents.md#organization) | + +### Property `Identifier > anyOf > Identifier as a complex object > issued` + +**Title:** issued + +**Requirement:** Optional + +The date of formal issuance (e.g., publication) of the Identifier + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ----------------------------------------------------------- | +| [Null allowed when not required](#identifier--anyOf_i1_issued_anyOf_i0) | +| [Date string](#identifier--anyOf_i1_issued_anyOf_i1) | + +#### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +#### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string` + +**Title:** Date string + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| -------------------------------------------- | +| [item 0](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i0) | +| [item 1](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i1) | +| [item 2](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i2) | +| [item 3](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i3) | + +##### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +##### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +##### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +##### Property `Identifier > anyOf > Identifier as a complex object > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +### Property `Identifier > anyOf > Identifier as a complex object > version` + +**Title:** version + +**Requirement:** Optional + +version of the identifier scheme + +| **Type** | `null or string` | +| -------- | ---------------- | + +### Property `Identifier > anyOf > Identifier as a complex object > notation` + +**Title:** notation + +**Requirement:** Optional + +abbreviation or code from code lists for an identifier + +| **Type** | `null or string` | +| -------- | ---------------- | + +--- + + + +## Relationship + +**Title:** Relationship + +Additional information about how one resource is related to another + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "Relationship", + "hadRole": "isInputTo", + "relation": "https://example.gov/models/climate-prediction" +} +``` + +| Property | Type | Title/Description | +| ------------------------ | ------ | ----------------- | +| - [@id](#relationship--@id) | string | - | +| - [@type](#relationship--@type) | string | - | +| + [hadRole](#relationship--hadRole) | string | role | +| + [relation](#relationship--relation) | string | relation | + +## [Optional] Property `Relationship > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/relationships/dataset-001-data-provider" +``` + +## [Optional] Property `Relationship > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ---------------- | +| **Default** | `"Relationship"` | + +## [Optional] Property `Relationship > hadRole` + +**Title:** role + +**Requirement:** Optional + +The function of an entity or agent with respect to a dataset + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"isInputTo" +``` + +```json +"dataProvider" +``` + +## [Optional] Property `Relationship > relation` + +**Title:** relation + +**Requirement:** Optional + +The entity related to the dataset. This string should unambiguously identify the related resource using an appropriate identifier. + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"https://example.gov/models/climate-prediction" +``` + +```json +"https://example.gov/organizations/national-weather-service" +``` + +--- + + + +## Checksum + +**Title:** Checksum + +A mechanism that can be used to verify that the contents of a distribution have not changed + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "Checksum", + "algorithm": "SHA-256", + "checksumValue": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456" +} +``` + +| Property | Type | Title/Description | +| ---------------------------------- | ------ | ----------------- | +| - [@id](#checksum--@id) | string | - | +| - [@type](#checksum--@type) | string | - | +| + [algorithm](#checksum--algorithm) | string | algorithm | +| + [checksumValue](#checksum--checksumValue) | string | checksum value | + +## [Optional] Property `Checksum > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/checksums/dataset-001-sha256" +``` + +## [Optional] Property `Checksum > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ------------ | +| **Default** | `"Checksum"` | + +## [Optional] Property `Checksum > algorithm` + +**Title:** algorithm + +**Requirement:** Optional + +The algorithm used to produce the checksum + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Example:** + +```json +"SHA-256" +``` + +## [Optional] Property `Checksum > checksumValue` + +**Title:** checksum value + +**Requirement:** Optional + +A lower case hexadecimal encoded digest value produced using a specific algorithm + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456" +``` + +```json +"a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e" +``` + +--- + + + +## Concept + +**Title:** Concept + +A controlled term or label, optionally drawn from a concept scheme + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| -------------------- | +| [Concept](#concept--anyOf_i0) | +| [item 1](#concept--anyOf_i1) | + +## Property `Concept > anyOf > Concept` + +**Title:** Concept + +The value of the concept, expressed as a string. This is only used when the concept is not further described by the properties of the Concept object and is not linked to a concept scheme. + +| **Type** | `string` | +| -------- | -------- | + +## Property `Concept > anyOf > item 1` + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +| Property | Type | Title/Description | +| ------------------------------------- | ------------------ | ----------------- | +| - [@id](#concept--anyOf_i1_@id) | string | - | +| - [@type](#concept--anyOf_i1_@type) | string | - | +| - [altLabel](#concept--anyOf_i1_altLabel) | null or string | alternate label | +| - [definition](#concept--anyOf_i1_definition) | null or string | definition | +| - [inScheme](#concept--anyOf_i1_inScheme) | object | in scheme | +| - [notation](#concept--anyOf_i1_notation) | More than one type | notation | +| + [prefLabel](#concept--anyOf_i1_prefLabel) | string | preferred label | + +### Property `Concept > anyOf > item 1 > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +### Property `Concept > anyOf > item 1 > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ----------- | +| **Default** | `"Concept"` | + +### Property `Concept > anyOf > item 1 > altLabel` + +**Title:** alternate label + +**Requirement:** Optional + +Alternative label for a concept + +| **Type** | `null or string` | +| -------- | ---------------- | + +### Property `Concept > anyOf > item 1 > definition` + +**Title:** definition + +**Requirement:** Optional + +Definition of the controlled vocabulary term + +| **Type** | `null or string` | +| -------- | ---------------- | + +### Property `Concept > anyOf > item 1 > inScheme` + +**Title:** in scheme + +**Requirement:** Optional + +Concept scheme defining this concept + +| **Type** | `object` | +| ------------------------- | ----------------------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Conceptscheme](./identifiers-and-relationships.md#concept-scheme) | + +### Property `Concept > anyOf > item 1 > notation` + +**Title:** notation + +**Requirement:** Optional + +List of abbreviations or codes from code lists for the Concept + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------- | +| [item 0](#concept--anyOf_i1_notation_anyOf_i0) | +| [item 1](#concept--anyOf_i1_notation_anyOf_i1) | + +#### Property `Concept > anyOf > item 1 > notation > anyOf > item 0` + +| **Type** | `null` | +| -------- | ------ | + +#### Property `Concept > anyOf > item 1 > notation > anyOf > item 1` + +| **Type** | `array of string` | +| -------- | ----------------- | + +| Each item of this array must be | Description | +| ------------------------------------------------- | ----------- | +| [item 1 items](#concept--anyOf_i1_notation_anyOf_i1_items) | - | + +##### Concept > anyOf > item 1 > notation > anyOf > item 1 > item 1 items + +| **Type** | `string` | +| -------- | -------- | + +### Property `Concept > anyOf > item 1 > prefLabel` + +**Title:** preferred label + +**Requirement:** Optional + +Preferred label for the term + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +--- + + + +## ConceptScheme + +**Title:** ConceptScheme + +A controlled vocabulary or other list of approved terms for a concept + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "ConceptScheme", + "title": "Science Domains", + "description": "A classification scheme for scientific research domains.", + "issued": "2020-01-01" +} +``` + +| Property | Type | Title/Description | +| ------------------------------ | ------------------ | ------------------------ | +| - [@id](#concept-scheme--@id) | string | - | +| - [@type](#concept-scheme--@type) | string | - | +| - [version](#concept-scheme--version) | null or string | version info | +| - [created](#concept-scheme--created) | More than one type | creation date | +| - [description](#concept-scheme--description) | null or string | description | +| - [issued](#concept-scheme--issued) | More than one type | publication date | +| - [modified](#concept-scheme--modified) | More than one type | update/modification date | +| + [title](#concept-scheme--title) | string | title | + +## [Optional] Property `ConceptScheme > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/concept-schemes/data-classification" +``` + +## [Optional] Property `ConceptScheme > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ----------------- | +| **Default** | `"ConceptScheme"` | + +## [Optional] Property `ConceptScheme > version` + +**Title:** version info + +**Requirement:** Optional + +A version number or other version designation of the concept scheme + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"2.0.1" +``` + +## [Optional] Property `ConceptScheme > created` + +**Title:** creation date + +**Requirement:** Optional + +The date on which the Concept Scheme was first created + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2020" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024-01-15" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| --------------------------------------------------- | +| [Null allowed when not required](#concept-scheme--created_anyOf_i0) | +| [Date string](#concept-scheme--created_anyOf_i1) | + +### Property `ConceptScheme > created > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `ConceptScheme > created > anyOf > Date string` + +**Title:** Date string + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------ | +| [item 0](#concept-scheme--created_anyOf_i1_anyOf_i0) | +| [item 1](#concept-scheme--created_anyOf_i1_anyOf_i1) | +| [item 2](#concept-scheme--created_anyOf_i1_anyOf_i2) | +| [item 3](#concept-scheme--created_anyOf_i1_anyOf_i3) | + +#### Property `ConceptScheme > created > anyOf > Date string > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `ConceptScheme > created > anyOf > Date string > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `ConceptScheme > created > anyOf > Date string > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `ConceptScheme > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `ConceptScheme > description` + +**Title:** description + +**Requirement:** Optional + +A description of the concept scheme + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"A classification scheme for scientific research domains." +``` + +```json +"A controlled vocabulary for classifying federal government data assets by sensitivity and access requirements." +``` + +## [Optional] Property `ConceptScheme > issued` + +**Title:** publication date + +**Requirement:** Optional + +The date of formal issuance (e.g., publication) of the concept scheme + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2020-01-01" +``` + +```json +"2020" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| -------------------------------------------------- | +| [Null allowed when not required](#concept-scheme--issued_anyOf_i0) | +| [Date string](#concept-scheme--issued_anyOf_i1) | + +### Property `ConceptScheme > issued > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `ConceptScheme > issued > anyOf > Date string` + +**Title:** Date string + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ----------------------------------- | +| [item 0](#concept-scheme--issued_anyOf_i1_anyOf_i0) | +| [item 1](#concept-scheme--issued_anyOf_i1_anyOf_i1) | +| [item 2](#concept-scheme--issued_anyOf_i1_anyOf_i2) | +| [item 3](#concept-scheme--issued_anyOf_i1_anyOf_i3) | + +#### Property `ConceptScheme > issued > anyOf > Date string > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `ConceptScheme > issued > anyOf > Date string > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `ConceptScheme > issued > anyOf > Date string > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `ConceptScheme > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `ConceptScheme > modified` + +**Title:** update/modification date + +**Requirement:** Optional + +The most recent date at which the concept scheme was changed or modified + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2024" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024-01-15" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| ---------------------------------------------------- | +| [Null allowed when not required](#concept-scheme--modified_anyOf_i0) | +| [Date string](#concept-scheme--modified_anyOf_i1) | + +### Property `ConceptScheme > modified > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `ConceptScheme > modified > anyOf > Date string` + +**Title:** Date string + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------- | +| [item 0](#concept-scheme--modified_anyOf_i1_anyOf_i0) | +| [item 1](#concept-scheme--modified_anyOf_i1_anyOf_i1) | +| [item 2](#concept-scheme--modified_anyOf_i1_anyOf_i2) | +| [item 3](#concept-scheme--modified_anyOf_i1_anyOf_i3) | + +#### Property `ConceptScheme > modified > anyOf > Date string > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `ConceptScheme > modified > anyOf > Date string > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `ConceptScheme > modified > anyOf > Date string > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `ConceptScheme > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `ConceptScheme > title` + +**Title:** title + +**Requirement:** Optional + +The title of the concept scheme + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"Science Domains" +``` + +```json +"Federal Data Classification Scheme" +``` diff --git a/jsonschema/docs/index.md b/jsonschema/docs/index.md index 7e8a5a56..6ee6a660 100644 --- a/jsonschema/docs/index.md +++ b/jsonschema/docs/index.md @@ -1,43 +1,18 @@ # DCAT-US 3 Schema Documentation -DCAT-US 3 is a schema for metadata about data assets. It's defined as a set of -JSON Schema files divided into "classes" that specify different types of information -that could appear in the metadata. +DCAT-US 3 is documented here as a smaller set of review-friendly pages. -## Catalog +## Main classes -The top level class for DCAT-US 3 is [Catalog](./Catalog.md) which collects -information about other data elements and information about the overall -collection such as publisher, keywords, and contact information. +- [Catalog](./catalog.md) +- [Dataset](./dataset.md) +- [Dataset Series](./dataset-series.md) +- [Distribution](./distribution.md) -## Other classes +## Supporting classes -Inside of the DCAT-US 3 catalog, other classes are used to specify the format -of a particular metadata element. Alphabetically: - -- [AccessRestriction](./AccessRestriction.md) -- [Activity](./Activity.md) -- [Address](./Address.md) -- [Agent](./Agent.md) -- [Attribution](./Attribution.md) -- [Catalog](./Catalog.md) -- [CatalogRecord](./CatalogRecord.md) -- [Checksum](./Checksum.md) -- [Concept](./Concept.md) -- [ConceptScheme](./ConceptScheme.md) -- [CUIRestriction](./CUIRestriction.md) -- [DataService](./DataService.md) -- [Dataset](./Dataset.md) -- [DatasetSeries](./DatasetSeries.md) -- [Distribution](./Distribution.md) -- [Document](./Document.md) -- [Identifier](./Identifier.md) -- [Kind](./Kind.md) -- [Location](./Location.md) -- [Metric](./Metric.md) -- [Organization](./Organization.md) -- [PeriodOfTime](./PeriodOfTime.md) -- [QualityMeasurement](./QualityMeasurement.md) -- [Relationship](./Relationship.md) -- [Standard](./Standard.md) -- [UseRestriction](./UseRestriction.md) +- [Agents](./agents.md): [Agent](./agents.md#agent), [Organization](./agents.md#organization), [Kind](./agents.md#kind) +- [Constraints and Restrictions](./constraints-and-restrictions.md): [AccessRestriction](./constraints-and-restrictions.md#access-restriction), [CUIRestriction](./constraints-and-restrictions.md#cui-restriction), [UseRestriction](./constraints-and-restrictions.md#use-restriction) +- [Identifiers and Relationships](./identifiers-and-relationships.md): [Identifier](./identifiers-and-relationships.md#identifier), [Relationship](./identifiers-and-relationships.md#relationship), [Checksum](./identifiers-and-relationships.md#checksum), [Concept](./identifiers-and-relationships.md#concept), [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) +- [Temporal, Spatial, and Metrics](./temporal-spatial-metrics.md): [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time), [Location](./temporal-spatial-metrics.md#location), [Metric](./temporal-spatial-metrics.md#metric), [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement), [Activity](./temporal-spatial-metrics.md#activity), [Address](./temporal-spatial-metrics.md#address) +- [Quality and Governance](./quality-governance.md): [Standard](./quality-governance.md#standard), [Document](./quality-governance.md#document), [CatalogRecord](./quality-governance.md#catalog-record), [DataService](./quality-governance.md#data-service), [Attribution](./quality-governance.md#attribution) diff --git a/jsonschema/docs/quality-governance.md b/jsonschema/docs/quality-governance.md new file mode 100644 index 00000000..443f2b33 --- /dev/null +++ b/jsonschema/docs/quality-governance.md @@ -0,0 +1,2550 @@ +# Quality and Governance + +This page combines supporting DCAT-US 3 classes used with the main schema classes. + + + +## Standard + +**Title:** Standard + +A standard or specification that another resource conforms to + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@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 | Title/Description | +| -------------------------------------- | ------------------ | ----------------- | +| - [@id](#standard--@id) | string | - | +| - [@type](#standard--@type) | string | - | +| - [created](#standard--created) | More than one type | creation date | +| - [description](#standard--description) | null or string | description | +| - [identifier](#standard--identifier) | More than one type | identifier | +| - [otherIdentifier](#standard--otherIdentifier) | null or array | other identifier | +| - [issued](#standard--issued) | More than one type | issued | +| - [modified](#standard--modified) | More than one type | last modified | +| - [title](#standard--title) | null or string | title | +| - [category](#standard--category) | null or array | category | +| - [inScheme](#standard--inScheme) | More than one type | in scheme | + +## [Optional] Property `Standard > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/standards/dcat-us-3" +``` + +## [Optional] Property `Standard > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ------------ | +| **Default** | `"Standard"` | + +## [Optional] Property `Standard > created` + +**Title:** creation date + +**Requirement:** Optional + +The date on which the Standard has been first created + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2023-01-01" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| --------------------------------------------------- | +| [Null allowed when not required](#standard--created_anyOf_i0) | +| [Date string](#standard--created_anyOf_i1) | + +### Property `Standard > created > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `Standard > created > anyOf > Date string` + +**Title:** Date string + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------ | +| [item 0](#standard--created_anyOf_i1_anyOf_i0) | +| [item 1](#standard--created_anyOf_i1_anyOf_i1) | +| [item 2](#standard--created_anyOf_i1_anyOf_i2) | +| [item 3](#standard--created_anyOf_i1_anyOf_i3) | + +#### Property `Standard > created > anyOf > Date string > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `Standard > created > anyOf > Date string > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `Standard > created > anyOf > Date string > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `Standard > description` + +**Title:** description + +**Requirement:** Optional + +Plain-language summary of the standard + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"Data Catalog Vocabulary - United States Profile version 3.0" +``` + +```json +"The DCAT-US 3.0 schema defines a standard metadata format for data catalogs in the United States government, based on W3C DCAT." +``` + +## [Optional] Property `Standard > identifier` + +**Title:** identifier + +**Requirement:** Optional + +The unique identifier for the Standard, e.g. the URI or other unique identifier in the context of the Catalog + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------------------------ | +| [Null allowed when not required](#standard--identifier_anyOf_i0) | +| [Identifier](#standard--identifier_anyOf_i1) | + +### Property `Standard > identifier > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `Standard > identifier > anyOf > Identifier` + +**Title:** Identifier + +inline description of Identifier + +| **Type** | More than one type | +| ------------------------- | ----------------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | + +## [Optional] Property `Standard > otherIdentifier` + +**Title:** other identifier + +**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` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------------ | ----------------------------------------------------------------------------- | +| [Identifier](#standard--otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | + +### Standard > otherIdentifier > Identifier + +| **Type** | More than one type | +| ------------------------- | ---------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](#standard--identifier_anyOf_i1) | + +## [Optional] Property `Standard > issued` + +**Title:** issued + +**Requirement:** Optional + +The date of formal issuance (e.g., publication) of the Standard + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2024-01-15" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| -------------------------------------------------- | +| [Null allowed when not required](#standard--issued_anyOf_i0) | +| [Date string](#standard--issued_anyOf_i1) | + +### Property `Standard > issued > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `Standard > issued > anyOf > Date string` + +**Title:** Date string + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ----------------------------------- | +| [item 0](#standard--issued_anyOf_i1_anyOf_i0) | +| [item 1](#standard--issued_anyOf_i1_anyOf_i1) | +| [item 2](#standard--issued_anyOf_i1_anyOf_i2) | +| [item 3](#standard--issued_anyOf_i1_anyOf_i3) | + +#### Property `Standard > issued > anyOf > Date string > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `Standard > issued > anyOf > Date string > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `Standard > issued > anyOf > Date string > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `Standard > modified` + +**Title:** last modified + +**Requirement:** Optional + +The most recent date on which the Standard was changed or modified + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2024-06-01" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| ---------------------------------------------------- | +| [Null allowed when not required](#standard--modified_anyOf_i0) | +| [Date string](#standard--modified_anyOf_i1) | + +### Property `Standard > modified > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `Standard > modified > anyOf > Date string` + +**Title:** Date string + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------- | +| [item 0](#standard--modified_anyOf_i1_anyOf_i0) | +| [item 1](#standard--modified_anyOf_i1_anyOf_i1) | +| [item 2](#standard--modified_anyOf_i1_anyOf_i2) | +| [item 3](#standard--modified_anyOf_i1_anyOf_i3) | + +#### Property `Standard > modified > anyOf > Date string > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `Standard > modified > anyOf > Date string > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `Standard > modified > anyOf > Date string > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `Standard > title` + +**Title:** title + +**Requirement:** Optional + +Human-readable title of the standard + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"DCAT-US 3.0" +``` + +```json +"DCAT-US 3.0 - Data Catalog Vocabulary United States Profile" +``` + +## [Optional] Property `Standard > category` + +**Title:** category + +**Requirement:** Optional + +List of categories for the Standard + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ------------------------------------------------------------------ | +| [Concept](#standard--category_items) | A controlled term or label, optionally drawn from a concept scheme | + +### Standard > category > Concept + +| **Type** | More than one type | +| ------------------------- | ----------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | + +## [Optional] Property `Standard > inScheme` + +**Title:** in scheme + +**Requirement:** Optional + +The reference register to which the Standard belongs + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ---------------------------------------------------- | +| [Null allowed when not required](#standard--inScheme_anyOf_i0) | +| [ConceptScheme](#standard--inScheme_anyOf_i1) | + +### Property `Standard > inScheme > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `Standard > inScheme > anyOf > ConceptScheme` + +**Title:** ConceptScheme + +inline description of ConceptScheme + +| **Type** | `object` | +| ------------------------- | --------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [inScheme](#standard--category_items_anyOf_i1_inScheme) | + +--- + + + +## Document + +**Title:** Document + +A publication or other document related to a resource + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@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 | Title/Description | +| -------------------------------------------------- | ------------------ | ---------------------- | +| - [@id](#document--@id) | string | - | +| - [@type](#document--@type) | string | - | +| - [accessURL](#document--accessURL) | More than one type | access URL | +| - [downloadURL](#document--downloadURL) | More than one type | download URL | +| - [creator](#document--creator) | null or array | author | +| - [mediaType](#document--mediaType) | null or string | media type | +| - [abstract](#document--abstract) | null or string | abstract | +| - [bibliographicCitation](#document--bibliographicCitation) | null or string | bibliographic citation | +| - [conformsTo](#document--conformsTo) | null or array | conforms to | +| - [corporateCreator](#document--corporateCreator) | null or array | corporate author | +| - [description](#document--description) | null or string | description | +| - [identifier](#document--identifier) | More than one type | identifier | +| - [otherIdentifier](#document--otherIdentifier) | null or array | other identifier | +| - [issued](#document--issued) | More than one type | publication date | +| - [publisher](#document--publisher) | null or array | publisher | +| + [title](#document--title) | string | title | +| - [category](#document--category) | null or array | category | + +## [Optional] Property `Document > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/documents/climate-user-guide-001" +``` + +## [Optional] Property `Document > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ------------ | +| **Default** | `"Document"` | + +## [Optional] Property `Document > accessURL` + +**Title:** access URL + +**Requirement:** Optional + +A URL that gives access to the Document + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +"https://example.gov/docs/climate-user-guide" +``` + +| Any of(Option) | +| ----------------------------------------------------- | +| [Null allowed when not required](#document--accessURL_anyOf_i0) | +| [URL](#document--accessURL_anyOf_i1) | + +### Property `Document > accessURL > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `Document > accessURL > anyOf > URL` + +**Title:** URL + +reference iri of Document + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +## [Optional] Property `Document > downloadURL` + +**Title:** download URL + +**Requirement:** Optional + +A URL that is a direct link to a downloadable file of the Document in a given format + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +"https://example.gov/docs/climate-user-guide.pdf" +``` + +| Any of(Option) | +| ------------------------------------------------------- | +| [Null allowed when not required](#document--downloadURL_anyOf_i0) | +| [URL](#document--downloadURL_anyOf_i1) | + +### Property `Document > downloadURL > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `Document > downloadURL > anyOf > URL` + +**Title:** URL + +reference iri of Document + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +## [Optional] Property `Document > creator` + +**Title:** author + +**Requirement:** Optional + +The individual(s) responsible for creating the Document + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ----------------------------------------------- | +| [Kind](#document--creator_items) | Contact information for an individual or entity | + +### Document > creator > Kind + +| **Type** | `object` | +| ------------------------- | ----------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Kind](./agents.md#kind) | + +## [Optional] Property `Document > mediaType` + +**Title:** media type + +**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:** + +```json +"application/pdf" +``` + +## [Optional] Property `Document > abstract` + +**Title:** abstract + +**Requirement:** Optional + +Text abstract of the Document + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"This document provides detailed instructions for using climate data products, including API access, file formats, and data interpretation guidelines." +``` + +## [Optional] Property `Document > bibliographicCitation` + +**Title:** bibliographic citation + +**Requirement:** Optional + +Bibliographic citation as text + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"National Climate Data Center. (2024). Climate Data User Guide. Retrieved from https://example.gov/docs/climate-user-guide" +``` + +```json +"National Climate Data Center. (2024). Climate Data User Guide. U.S. Department of Commerce." +``` + +## [Optional] Property `Document > conformsTo` + +**Title:** conforms to + +**Requirement:** Optional + +List of standards or specifications the document follows + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ------------------------------------------------------------- | +| [Standard](#document--conformsTo_items) | A standard or specification that another resource conforms to | + +### Document > conformsTo > Standard + +| **Type** | `object` | +| ------------------------- | ------------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Standard](./quality-governance.md#standard) | + +## [Optional] Property `Document > corporateCreator` + +**Title:** corporate author + +**Requirement:** Optional + +The corporate organization(s) responsible for creating the Document + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| --------------------------------------- | --------------------------------------------------------------------------------- | +| [Organization](#document--corporateCreator_items) | An organization involved with a resource, including parent or child organizations | + +### Document > corporateCreator > Organization + +| **Type** | `object` | +| ------------------------- | ------------------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Organization](#document--conformsTo_items_identifier_anyOf_i1_anyOf_i1_creator_anyOf_i1) | + +## [Optional] Property `Document > description` + +**Title:** description + +**Requirement:** Optional + +Plain-language summary of the document + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"A guide for accessing and using the National Climate Data Center's data products." +``` + +```json +"A comprehensive guide for accessing and using the National Climate Data Center's data products and services." +``` + +## [Optional] Property `Document > identifier` + +**Title:** identifier + +**Requirement:** Optional + +The unique identifier for the Document (e.g. DOI, ISBN) + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------------------------ | +| [Null allowed when not required](#document--identifier_anyOf_i0) | +| [Identifier](#document--identifier_anyOf_i1) | + +### Property `Document > identifier > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `Document > identifier > anyOf > Identifier` + +**Title:** Identifier + +inline description of Identifier + +| **Type** | More than one type | +| ------------------------- | --------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](#document--conformsTo_items_identifier_anyOf_i1) | + +## [Optional] Property `Document > otherIdentifier` + +**Title:** other identifier + +**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` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------------ | ----------------------------------------------------------------------------- | +| [Identifier](#document--otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | + +### Document > otherIdentifier > Identifier + +| **Type** | More than one type | +| ------------------------- | --------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](#document--conformsTo_items_identifier_anyOf_i1) | + +## [Optional] Property `Document > issued` + +**Title:** publication date + +**Requirement:** Optional + +Publication date of the Document + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2024-01-15" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| -------------------------------------------------- | +| [Null allowed when not required](#document--issued_anyOf_i0) | +| [item 1](#document--issued_anyOf_i1) | + +### Property `Document > issued > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `Document > issued > anyOf > item 1` + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ----------------------------------- | +| [item 0](#document--issued_anyOf_i1_anyOf_i0) | +| [item 1](#document--issued_anyOf_i1_anyOf_i1) | +| [item 2](#document--issued_anyOf_i1_anyOf_i2) | +| [item 3](#document--issued_anyOf_i1_anyOf_i3) | + +#### Property `Document > issued > anyOf > item 1 > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `Document > issued > anyOf > item 1 > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `Document > issued > anyOf > item 1 > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `Document > publisher` + +**Title:** publisher + +**Requirement:** Optional + +The organization(s) that published the Document + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| -------------------------------- | --------------------------------------------------------------------------------- | +| [Organization](#document--publisher_items) | An organization involved with a resource, including parent or child organizations | + +### Document > publisher > Organization + +| **Type** | `object` | +| ------------------------- | ------------------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Organization](#document--conformsTo_items_identifier_anyOf_i1_anyOf_i1_creator_anyOf_i1) | + +## [Optional] Property `Document > title` + +**Title:** title + +**Requirement:** Optional + +The title of the Document + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Example:** + +```json +"Climate Data User Guide" +``` + +## [Optional] Property `Document > category` + +**Title:** category + +**Requirement:** Optional + +List of categories/genres for the Document + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ------------------------------------------------------------------ | +| [Concept](#document--category_items) | A controlled term or label, optionally drawn from a concept scheme | + +### Document > category > Concept + +| **Type** | More than one type | +| ------------------------- | ------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Concept](#document--conformsTo_items_category_items) | + +--- + + + +## CatalogRecord + +**Title:** CatalogRecord + +A record in a catalog, describing the registration of a single resource + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@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 | Title/Description | +| -------------------------------- | ----------------------- | ------------------------ | +| - [@id](#catalog-record--@id) | string | - | +| - [@type](#catalog-record--@type) | string | - | +| - [status](#catalog-record--status) | More than one type | change type | +| - [conformsTo](#catalog-record--conformsTo) | More than one type | application profile | +| - [description](#catalog-record--description) | null or array of string | Descriptions | +| - [issued](#catalog-record--issued) | null or array | listing date | +| - [language](#catalog-record--language) | More than one type | language | +| + [modified](#catalog-record--modified) | More than one type | update/modification date | +| - [source](#catalog-record--source) | null or string | source metadata | +| - [title](#catalog-record--title) | null or string | title | +| + [primaryTopic](#catalog-record--primaryTopic) | string | primary topic | + +## [Optional] Property `CatalogRecord > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/catalog-records/climate-dataset-record-001" +``` + +## [Optional] Property `CatalogRecord > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ----------------- | +| **Default** | `"CatalogRecord"` | + +## [Optional] Property `CatalogRecord > status` + +**Title:** change type + +**Requirement:** Optional + +The status of the catalog record in the context of editorial flow of the dataset and data service descriptions + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| -------------------------------------------------- | +| [Null allowed when not required](#catalog-record--status_anyOf_i0) | +| [Concept](#catalog-record--status_anyOf_i1) | + +### Property `CatalogRecord > status > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `CatalogRecord > status > anyOf > Concept` + +**Title:** Concept + +inline description of status + +| **Type** | More than one type | +| ------------------------- | ----------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | + +## [Optional] Property `CatalogRecord > conformsTo` + +**Title:** application profile + +**Requirement:** Optional + +An Application Profile that the Catalog Record's metadata conforms to + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------------------------ | +| [Null allowed when not required](#catalog-record--conformsTo_anyOf_i0) | +| [Standard](#catalog-record--conformsTo_anyOf_i1) | + +### Property `CatalogRecord > conformsTo > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `CatalogRecord > conformsTo > anyOf > Standard` + +**Title:** Standard + +inline description of application profile + +| **Type** | `object` | +| ------------------------- | ------------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Standard](./quality-governance.md#standard) | + +## [Optional] Property `CatalogRecord > description` + +**Title:** Descriptions + +**Requirement:** Optional + +A list of free-text accounts of the catalog record + +| **Type** | `null or array of string` | +| -------- | ------------------------- | + +**Example:** + +```json +[ + "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](#catalog-record--description_items) | - | + +### CatalogRecord > description > Description string + +**Title:** Description string + +| **Type** | `string` | +| -------- | -------- | + +## [Optional] Property `CatalogRecord > issued` + +**Title:** listing date + +**Requirement:** Optional + +List of dates on which the catalog record was included in the catalog + +| **Type** | `null or array` | +| -------- | --------------- | + +**Examples:** + +```json +[ + "2024-01-15T10:30:00Z" +] +``` + +```json +[ + "2024-01-15" +] +``` + +```json +[ + "2024" +] +``` + +```json +[ + "2024-01" +] +``` + +| Each item of this array must be | Description | +| ------------------------------- | ----------- | +| [Date string](#catalog-record--issued_items) | - | + +### CatalogRecord > issued > Date string + +**Title:** Date string + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| -------------------------------- | +| [item 0](#catalog-record--issued_items_anyOf_i0) | +| [item 1](#catalog-record--issued_items_anyOf_i1) | +| [item 2](#catalog-record--issued_items_anyOf_i2) | +| [item 3](#catalog-record--issued_items_anyOf_i3) | + +#### Property `CatalogRecord > issued > Date string > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `CatalogRecord > issued > Date string > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `CatalogRecord > issued > Date string > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `CatalogRecord > language` + +**Title:** 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** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"en" +``` + +```json +[ + "en", + "es" +] +``` + +| Any of(Option) | +| ---------------------------------------------------- | +| [Null allowed when not required](#catalog-record--language_anyOf_i0) | +| [Language code](#catalog-record--language_anyOf_i1) | +| [Array of language codes](#catalog-record--language_anyOf_i2) | + +### Property `CatalogRecord > language > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `CatalogRecord > language > anyOf > Language code` + +**Title:** Language code + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| -------------- | - | +| **Max length** | 2 | + +### Property `CatalogRecord > language > anyOf > Array of language codes` + +**Title:** Array of language codes + +| **Type** | `array of string` | +| -------- | ----------------- | + +| Each item of this array must be | Description | +| ----------------------------------------- | ----------- | +| [Language code](#catalog-record--language_anyOf_i2_items) | - | + +#### CatalogRecord > language > anyOf > Array of language codes > Language code + +**Title:** Language code + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| -------------- | - | +| **Max length** | 2 | + +## [Optional] Property `CatalogRecord > modified` + +**Title:** update/modification date + +**Requirement:** Optional + +The most recent date on which the catalog record was changed or modified + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Required** | Yes | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2024-06-15" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| ---------------------------- | +| [item 0](#catalog-record--modified_anyOf_i0) | +| [item 1](#catalog-record--modified_anyOf_i1) | +| [item 2](#catalog-record--modified_anyOf_i2) | +| [item 3](#catalog-record--modified_anyOf_i3) | + +### Property `CatalogRecord > modified > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +### Property `CatalogRecord > modified > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +### Property `CatalogRecord > modified > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `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:** + +```json +"Original metadata harvested from NOAA data portal" +``` + +## [Optional] Property `CatalogRecord > title` + +**Title:** title + +**Requirement:** Optional + +A name given to the Catalog Record + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"Climate Data 2024 Catalog Entry" +``` + +```json +"Climate Data 2023 Catalog Record" +``` + +## [Optional] Property `CatalogRecord > primaryTopic` + +**Title:** primary topic + +**Requirement:** Optional + +A link to the Dataset, Data service or Catalog described in the Catalog Record + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"https://example.gov/datasets/climate-data-2024" +``` + +```json +"https://example.gov/datasets/climate-data-2023" +``` + +--- + + + +## DataService + +**Title:** DataService + +A service that provides access to data or data processing functions + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@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 | Title/Description | +| ---------------------------------------------------------- | ----------------------- | ---------------------------- | +| - [@id](#data-service--@id) | string | - | +| - [@type](#data-service--@type) | string | - | +| + [contactPoint](#data-service--contactPoint) | array | contact point | +| - [endpointDescription](#data-service--endpointDescription) | null or array of string | endpoint description | +| + [endpointURL](#data-service--endpointURL) | array of string | endpoint URL | +| - [keyword](#data-service--keyword) | null or array of string | keyword/tag | +| - [servesDataset](#data-service--servesDataset) | null or array | serves dataset | +| - [spatialResolutionInMeters](#data-service--spatialResolutionInMeters) | null or string | spatial resolution in meters | +| - [temporalResolution](#data-service--temporalResolution) | null or string | temporal resolution | +| - [theme](#data-service--theme) | null or array | theme/category | +| - [accessRights](#data-service--accessRights) | More than one type | access rights | +| - [conformsTo](#data-service--conformsTo) | null or array | conforms to | +| - [created](#data-service--created) | More than one type | creation date | +| - [creator](#data-service--creator) | null or array | creator | +| - [description](#data-service--description) | null or string | description | +| - [identifier](#data-service--identifier) | More than one type | identifier | +| - [otherIdentifier](#data-service--otherIdentifier) | null or array | other identifier | +| - [language](#data-service--language) | More than one type | language | +| - [license](#data-service--license) | More than one type | license | +| - [modified](#data-service--modified) | More than one type | update/modification date | +| + [publisher](#data-service--publisher) | object | publisher | +| - [rights](#data-service--rights) | null or array of string | rights | +| - [rightsHolder](#data-service--rightsHolder) | null or array | rights holder | +| - [spatial](#data-service--spatial) | null or array | spatial/geographic coverage | +| - [temporal](#data-service--temporal) | null or array | temporal coverage | +| + [title](#data-service--title) | string | title | +| - [category](#data-service--category) | null or array | category | +| - [hasQualityMeasurement](#data-service--hasQualityMeasurement) | null or array | quality measurement | +| - [qualifiedAttribution](#data-service--qualifiedAttribution) | null or array | qualified attribution | +| - [wasUsedBy](#data-service--wasUsedBy) | null or array | was used by | + +## [Optional] Property `DataService > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/data-services/climate-api-001" +``` + +## [Optional] Property `DataService > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | --------------- | +| **Default** | `"DataService"` | + +## [Optional] Property `DataService > contactPoint` + +**Title:** contact point + +**Requirement:** Optional + +Contact information for questions about the Data Service. Include an email address that is continuously monitored + +| **Type** | `array` | +| ------------ | ------- | +| **Required** | Yes | + +| Each item of this array must be | Description | +| ------------------------------- | ----------------------------------------------- | +| [Kind](#data-service--contactPoint_items) | Contact information for an individual or entity | + +### DataService > contactPoint > Kind + +| **Type** | `object` | +| ------------------------- | ----------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Kind](./agents.md#kind) | + +## [Optional] Property `DataService > endpointDescription` + +**Title:** endpoint description + +**Requirement:** Optional + +List of endpoint descriptions with operations and parameters (for example, OpenAPI or similar service documentation) + +| **Type** | `null or array of string` | +| -------- | ------------------------- | + +**Examples:** + +```json +[ + "https://api.example.gov/climate/v1/openapi.json" +] +``` + +```json +[ + "https://api.example.gov/climate/docs/openapi.json" +] +``` + +| Each item of this array must be | Description | +| ------------------------------------------------------- | ----------- | +| [endpointDescription items](#data-service--endpointDescription_items) | - | + +### DataService > endpointDescription > endpointDescription items + +| **Type** | `string` | +| -------- | -------- | + +## [Optional] Property `DataService > endpointURL` + +**Title:** endpoint URL + +**Requirement:** Optional + +A list of root locations or primary endpoints of the service (a Web-resolvable IRI) + +| **Type** | `array of string` | +| ------------ | ----------------- | +| **Required** | Yes | + +**Examples:** + +```json +[ + "https://api.example.gov/climate/v1" +] +``` + +```json +[ + "https://api.example.gov/climate/v1", + "https://api.example.gov/climate/v2" +] +``` + +| Each item of this array must be | Description | +| ------------------------------- | --------------------------------------------------------------------------- | +| [URLs](#data-service--endpointURL_items) | The root location or primary endpoint of the service (a Web-resolvable IRI) | + +### DataService > endpointURL > URLs + +**Title:** URLs + +The root location or primary endpoint of the service (a Web-resolvable IRI) + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +## [Optional] Property `DataService > keyword` + +**Title:** keyword/tag + +**Requirement:** Optional + +List of keywords or tags describing the data service + +| **Type** | `null or array of string` | +| -------- | ------------------------- | + +**Examples:** + +```json +[ + "climate", + "weather", + "API" +] +``` + +```json +[ + "climate", + "weather", + "temperature", + "API", + "REST" +] +``` + +| Each item of this array must be | Description | +| ----------------------------------- | ----------- | +| [Non-empty strings](#data-service--keyword_items) | - | + +### DataService > keyword > Non-empty strings + +**Title:** Non-empty strings + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| -------------- | - | +| **Min length** | 1 | + +## [Optional] Property `DataService > servesDataset` + +**Title:** serves dataset + +**Requirement:** Optional + +List of datasets this service provides access to + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | --------------------------------------------------------- | +| [Dataset](#data-service--servesDataset_items) | A collection of data published or curated by one provider | + +### DataService > servesDataset > Dataset + +| **Type** | `object` | +| ------------------------- | ----------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Dataset](./dataset.md#root) | + +## [Optional] Property `DataService > spatialResolutionInMeters` + +**Title:** spatial resolution in meters + +**Requirement:** Optional + +The minimum spatial separation resolvable in a Data Service, measured in meters + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"1000" +``` + +## [Optional] Property `DataService > temporalResolution` + +**Title:** temporal resolution + +**Requirement:** Optional + +The minimum time period resolvable by the Data Service + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"P1D" +``` + +## [Optional] Property `DataService > theme` + +**Title:** theme/category + +**Requirement:** Optional + +List of themes or categories for the data service + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ------------------------------------------------------------------ | +| [Concept](#data-service--theme_items) | A controlled term or label, optionally drawn from a concept scheme | + +### DataService > theme > Concept + +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Concept](#data-service--servesDataset_items_sample_items_representationTechnique_anyOf_i1) | + +## [Optional] Property `DataService > accessRights` + +**Title:** access rights + +**Requirement:** Optional + +Information about whether the data service is publicly accessible, restricted, or not public + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +"Public access with no restrictions" +``` + +| Any of(Option) | +| -------------------------------- | +| [item 0](#data-service--accessRights_anyOf_i0) | +| [item 1](#data-service--accessRights_anyOf_i1) | + +### Property `DataService > accessRights > anyOf > item 0` + +| **Type** | `null` | +| -------- | ------ | + +### Property `DataService > accessRights > anyOf > item 1` + +Text description of the access rights + +| **Type** | `string` | +| -------- | -------- | + +## [Optional] Property `DataService > conformsTo` + +**Title:** conforms to + +**Requirement:** Optional + +List of general standards or specifications that the Data Service endpoints implement + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ------------------------------------------------------------- | +| [Standard](#data-service--conformsTo_items) | A standard or specification that another resource conforms to | + +### DataService > conformsTo > Standard + +| **Type** | `object` | +| ------------------------- | ---------------------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Standard](#data-service--servesDataset_items_sample_items_accessService_items_conformsTo_items) | + +## [Optional] Property `DataService > created` + +**Title:** creation date + +**Requirement:** Optional + +The date on which the Data Service was first created + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2020-01-15" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| -------------------------------- | +| [item 0](#data-service--created_anyOf_i0) | +| [Date string](#data-service--created_anyOf_i1) | + +### Property `DataService > created > anyOf > item 0` + +| **Type** | `null` | +| -------- | ------ | + +### Property `DataService > created > anyOf > Date string` + +**Title:** Date string + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------ | +| [item 0](#data-service--created_anyOf_i1_anyOf_i0) | +| [item 1](#data-service--created_anyOf_i1_anyOf_i1) | +| [item 2](#data-service--created_anyOf_i1_anyOf_i2) | +| [item 3](#data-service--created_anyOf_i1_anyOf_i3) | + +#### Property `DataService > created > anyOf > Date string > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `DataService > created > anyOf > Date string > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `DataService > created > anyOf > Date string > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `DataService > creator` + +**Title:** creator + +**Requirement:** Optional + +List of agents primarily responsible for producing the Data Service + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | -------------------------------------------------------------------------------- | +| [Agent](#data-service--creator_items) | A person, organization, software agent, or other entity involved with a resource | + +### DataService > creator > Agent + +| **Type** | `object` | +| ------------------------- | ---------------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Agent](#data-service--servesDataset_items_sample_items_accessService_items_creator_items) | + +## [Optional] Property `DataService > description` + +**Title:** description + +**Requirement:** Optional + +Plain-language summary of the data service + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"A RESTful API providing access to historical and real-time climate data including temperature, precipitation, and atmospheric conditions." +``` + +## [Optional] Property `DataService > identifier` + +**Title:** 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** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ---------------------------------- | +| [item 0](#data-service--identifier_anyOf_i0) | +| [Identifier](#data-service--identifier_anyOf_i1) | + +### Property `DataService > identifier > anyOf > item 0` + +| **Type** | `null` | +| -------- | ------ | + +### Property `DataService > identifier > anyOf > Identifier` + +**Title:** Identifier + +inline description of Identifier + +| **Type** | More than one type | +| ------------------------- | -------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](#data-service--servesDataset_items_otherIdentifier_items) | + +## [Optional] Property `DataService > otherIdentifier` + +**Title:** other identifier + +**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` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------------ | ----------------------------------------------------------------------------- | +| [Identifier](#data-service--otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | + +### DataService > otherIdentifier > Identifier + +| **Type** | More than one type | +| ------------------------- | -------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](#data-service--servesDataset_items_otherIdentifier_items) | + +## [Optional] Property `DataService > language` + +**Title:** 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** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"en" +``` + +```json +[ + "en", + "es" +] +``` + +| Any of(Option) | +| ---------------------------------------------------- | +| [Null allowed when not required](#data-service--language_anyOf_i0) | +| [Language code](#data-service--language_anyOf_i1) | +| [List of lanuages](#data-service--language_anyOf_i2) | + +### Property `DataService > language > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `DataService > language > anyOf > Language code` + +**Title:** Language code + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| -------------- | - | +| **Max length** | 2 | + +### Property `DataService > language > anyOf > List of lanuages` + +**Title:** List of lanuages + +| **Type** | `array of string` | +| -------- | ----------------- | + +| Each item of this array must be | Description | +| ----------------------------------------- | ----------- | +| [Language code](#data-service--language_anyOf_i2_items) | - | + +#### DataService > language > anyOf > List of lanuages > Language code + +**Title:** Language code + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| -------------- | - | +| **Max length** | 2 | + +## [Optional] Property `DataService > license` + +**Title:** license + +**Requirement:** Optional + +License that governs how the data service can be used or reused + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +"https://creativecommons.org/publicdomain/zero/1.0/" +``` + +| Any of(Option) | +| --------------------------------------------------- | +| [Null allowed when not required](#data-service--license_anyOf_i0) | +| [item 1](#data-service--license_anyOf_i1) | + +### Property `DataService > license > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `DataService > license > anyOf > item 1` + +Full text of the license + +| **Type** | `string` | +| -------- | -------- | + +## [Optional] Property `DataService > modified` + +**Title:** update/modification date + +**Requirement:** Optional + +The most recent date on which the Data Service was changed or modified + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2024-03-20" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| ---------------------------------------------------- | +| [Null allowed when not required](#data-service--modified_anyOf_i0) | +| [Date string](#data-service--modified_anyOf_i1) | + +### Property `DataService > modified > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `DataService > modified > anyOf > Date string` + +**Title:** Date string + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------- | +| [item 0](#data-service--modified_anyOf_i1_anyOf_i0) | +| [item 1](#data-service--modified_anyOf_i1_anyOf_i1) | +| [item 2](#data-service--modified_anyOf_i1_anyOf_i2) | +| [item 3](#data-service--modified_anyOf_i1_anyOf_i3) | + +#### Property `DataService > modified > anyOf > Date string > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `DataService > modified > anyOf > Date string > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `DataService > modified > anyOf > Date string > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `DataService > publisher` + +**Title:** publisher + +**Requirement:** Optional + +Person or organization responsible for publishing and making the data service available + +| **Type** | `object` | +| ------------------------- | ------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | +| **Defined in** | [Agent](./agents.md#agent) | + +## [Optional] Property `DataService > rights` + +**Title:** 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:** + +```json +[ + "Data provided by the National Climate Data Center is in the public domain." +] +``` + +| Each item of this array must be | Description | +| ------------------------------- | ----------- | +| [rights items](#data-service--rights_items) | - | + +### DataService > rights > rights items + +| **Type** | `string` | +| -------- | -------- | + +## [Optional] Property `DataService > rightsHolder` + +**Title:** rights holder + +**Requirement:** Optional + +A list of Agents (organizations) holding rights on the Data Service + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ----------------------------------- | --------------------------------------------------------------------------------- | +| [Organization](#data-service--rightsHolder_items) | An organization involved with a resource, including parent or child organizations | + +### DataService > rightsHolder > Organization + +| **Type** | `object` | +| ------------------------- | ------------------------------------------------------------------------------------ | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Organization](#data-service--servesDataset_items_otherIdentifier_items_anyOf_i1_creator_anyOf_i1) | + +## [Optional] Property `DataService > spatial` + +**Title:** spatial/geographic coverage + +**Requirement:** Optional + +A geographic region that is covered by the Data Service + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | -------------------------------- | +| [Location](#data-service--spatial_items) | A named place or geographic area | + +### DataService > spatial > Location + +| **Type** | `object` | +| ------------------------- | ------------------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Location](#data-service--servesDataset_items_sample_items_accessService_items_spatial_items) | + +## [Optional] Property `DataService > temporal` + +**Title:** temporal coverage + +**Requirement:** Optional + +Time periods covered by the data service + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ---------------------------------------------------------------------- | +| [PeriodOfTime](#data-service--temporal_items) | Information about a specific time period with a start- and/or end-time | + +### DataService > temporal > PeriodOfTime + +| **Type** | More than one type | +| ------------------------- | ------------------------------------------------------------------------------------ | +| **Additional properties** | Any type allowed | +| **Same definition as** | [PeriodOfTime](#data-service--servesDataset_items_sample_items_accessService_items_temporal_items) | + +## [Optional] Property `DataService > title` + +**Title:** title + +**Requirement:** Optional + +Human-readable title of the data service + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Example:** + +```json +"Climate Data REST API" +``` + +## [Optional] Property `DataService > category` + +**Title:** category + +**Requirement:** Optional + +List of high-level categories for the data service + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ------------------------------------------------------------------ | +| [Concept](#data-service--category_items) | A controlled term or label, optionally drawn from a concept scheme | + +### DataService > category > Concept + +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Concept](#data-service--servesDataset_items_sample_items_representationTechnique_anyOf_i1) | + +## [Optional] Property `DataService > hasQualityMeasurement` + +**Title:** quality measurement + +**Requirement:** Optional + +Quality measurements for the data service (for example, availability, response time, or reliability) + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| -------------------------------------------------- | ------------------------------------------------------------- | +| [QualityMeasurement](#data-service--hasQualityMeasurement_items) | A measurement of a resource against a specific quality metric | + +### DataService > hasQualityMeasurement > QualityMeasurement + +| **Type** | `object` | +| ------------------------- | ------------------------------------------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [QualityMeasurement](#data-service--servesDataset_items_sample_items_accessService_items_hasQualityMeasurement_items) | + +## [Optional] Property `DataService > qualifiedAttribution` + +**Title:** qualified attribution + +**Requirement:** Optional + +List of agents with specific responsibilities for the data service + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------------------ | ------------------------------------------------- | +| [Attribution](#data-service--qualifiedAttribution_items) | A responsibility that an agent has for a resource | + +### DataService > qualifiedAttribution > Attribution + +| **Type** | `object` | +| ------------------------- | ----------------------------------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Attribution](#data-service--servesDataset_items_sample_items_accessService_items_qualifiedAttribution_items) | + +## [Optional] Property `DataService > wasUsedBy` + +**Title:** was used by + +**Requirement:** Optional + +List of activities that used or tested the data service + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | -------------------------------------------------------------- | +| [Activity](#data-service--wasUsedBy_items) | An activity related to creating, changing, or using a resource | + +### DataService > wasUsedBy > Activity + +| **Type** | `object` | +| ------------------------- | --------------------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Activity](#data-service--servesDataset_items_sample_items_accessService_items_wasUsedBy_items) | + +--- + + + +## Attribution + +**Title:** Attribution + +A responsibility that an agent has for a resource + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "Attribution", + "hadRole": "Data Steward", + "agent": { + "name": "Environmental Data Management Office" + } +} +``` + +| Property | Type | Title/Description | +| ---------------------- | ------ | ----------------- | +| - [@id](#attribution--@id) | string | - | +| - [@type](#attribution--@type) | string | - | +| + [hadRole](#attribution--hadRole) | string | role | +| + [agent](#attribution--agent) | object | agent | + +## [Optional] Property `Attribution > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/attributions/dataset-steward-001" +``` + +## [Optional] Property `Attribution > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | --------------- | +| **Default** | `"Attribution"` | + +## [Optional] Property `Attribution > hadRole` + +**Title:** role + +**Requirement:** Optional + +The function of an entity or agent with respect to another entity or resource + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Example:** + +```json +"Data Steward" +``` + +## [Optional] Property `Attribution > agent` + +**Title:** agent + +**Requirement:** Optional + +The agent that plays a role in the resource + +| **Type** | `object` | +| ------------------------- | ------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | +| **Defined in** | [Agent](./agents.md#agent) | diff --git a/jsonschema/docs/temporal-spatial-metrics.md b/jsonschema/docs/temporal-spatial-metrics.md new file mode 100644 index 00000000..4ef7f12c --- /dev/null +++ b/jsonschema/docs/temporal-spatial-metrics.md @@ -0,0 +1,1303 @@ +# Temporal, Spatial, and Metrics + +This page combines supporting DCAT-US 3 classes used with the main schema classes. + + + +## PeriodOfTime + +**Title:** PeriodOfTime + +Information about a specific time period with a start- and/or end-time + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "PeriodOfTime", + "startDate": "2024-01-01", + "endDate": "2024-12-31" +} +``` + +| Property | Type | Title/Description | +| -------------------------- | ------------------ | ----------------- | +| - [@id](#period-of-time--@id) | string | - | +| - [@type](#period-of-time--@type) | string | - | +| - [endDate](#period-of-time--endDate) | More than one type | end date | +| - [startDate](#period-of-time--startDate) | More than one type | start date | + +| Any of(Option) | +| ------------------- | +| [item 0](#period-of-time--anyOf_i0) | +| [item 1](#period-of-time--anyOf_i1) | + +## Property `PeriodOfTime > anyOf > item 0` + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +### The following properties are required +* startDate + +## Property `PeriodOfTime > anyOf > item 1` + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +### The following properties are required +* endDate + +## [Optional] Property `PeriodOfTime > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/periods/fiscal-year-2024" +``` + +## [Optional] Property `PeriodOfTime > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ---------------- | +| **Default** | `"PeriodOfTime"` | + +## [Optional] Property `PeriodOfTime > endDate` + +**Title:** end date + +**Requirement:** Optional + +The end date of the period of time + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2024-12-31" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| --------------------------------------------------- | +| [Null allowed when not required](#period-of-time--endDate_anyOf_i0) | +| [item 1](#period-of-time--endDate_anyOf_i1) | + +### Property `PeriodOfTime > endDate > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `PeriodOfTime > endDate > anyOf > item 1` + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ------------------------------------ | +| [item 0](#period-of-time--endDate_anyOf_i1_anyOf_i0) | +| [item 1](#period-of-time--endDate_anyOf_i1_anyOf_i1) | +| [item 2](#period-of-time--endDate_anyOf_i1_anyOf_i2) | +| [item 3](#period-of-time--endDate_anyOf_i1_anyOf_i3) | + +#### Property `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `PeriodOfTime > endDate > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +## [Optional] Property `PeriodOfTime > startDate` + +**Title:** start date + +**Requirement:** Optional + +The start date of the period of time + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"2023-10-01" +``` + +```json +"2024-01-15T10:30:00Z" +``` + +```json +"2024" +``` + +```json +"2024-01" +``` + +| Any of(Option) | +| ----------------------------------------------------- | +| [Null allowed when not required](#period-of-time--startDate_anyOf_i0) | +| [item 1](#period-of-time--startDate_anyOf_i1) | + +### Property `PeriodOfTime > startDate > anyOf > Null allowed when not required` + +**Title:** Null allowed when not required + +| **Type** | `null` | +| -------- | ------ | + +### Property `PeriodOfTime > startDate > anyOf > item 1` + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| -------------------------------------- | +| [item 0](#period-of-time--startDate_anyOf_i1_anyOf_i0) | +| [item 1](#period-of-time--startDate_anyOf_i1_anyOf_i1) | +| [item 2](#period-of-time--startDate_anyOf_i1_anyOf_i2) | +| [item 3](#period-of-time--startDate_anyOf_i1_anyOf_i3) | + +#### Property `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 0` + +| **Type** | `string` | +| ---------- | ----------- | +| **Format** | `date-time` | + +#### Property `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 1` + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `date` | + +#### Property `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 2` + +A year in YYYY format + +| **Type** | `string` | +| -------- | -------- | + +| Restrictions | | +| --------------------------------- | --------------------------------------------------------------------------- | +| **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | + +#### Property `PeriodOfTime > startDate > 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](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | + +--- + + + +## Location + +**Title:** Location + +A named place or geographic area + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +{ + "@type": "Location", + "prefLabel": "Continental United States", + "bbox": "POLYGON((-125 24, -66 24, -66 50, -125 50, -125 24))" +} +``` + +```json +{ + "@type": "Location", + "prefLabel": "Continental United States", + "bbox": { + "type": "Polygon", + "coordinates": [ + [ + [ + -77.119759, + 38.791645 + ], + [ + -76.909393, + 38.791645 + ], + [ + -76.909393, + 38.99538 + ], + [ + -77.119759, + 38.99538 + ], + [ + -77.119759, + 38.791645 + ] + ] + ] + } +} +``` + +```json +{ + "@type": "Location", + "prefLabel": "Null Island", + "bbox": "POINT (0.0 0.0)" +} +``` + +```json +{ + "@type": "Location", + "prefLabel": "Random object", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -77.0402, + 38.7916 + ], + [ + -76.9094, + 38.8921 + ], + [ + -76.9115, + 38.9355 + ], + [ + -76.9286, + 38.9784 + ], + [ + -77.0024, + 38.9657 + ], + [ + -77.0389, + 38.9939 + ], + [ + -77.0672, + 38.9687 + ], + [ + -77.0782, + 38.9143 + ], + [ + -77.1198, + 38.9342 + ], + [ + -77.1198, + 38.8456 + ], + [ + -77.0402, + 38.7916 + ] + ] + ] + } +} +``` + +| Property | Type | Title/Description | +| -------------------------------------- | ------------------ | ----------------- | +| - [@id](#location--@id) | string | - | +| - [@type](#location--@type) | string | - | +| - [bbox](#location--bbox) | More than one type | bounding box | +| - [centroid](#location--centroid) | More than one type | centroid | +| - [identifier](#location--identifier) | More than one type | identifier | +| - [otherIdentifier](#location--otherIdentifier) | null or array | other identifier | +| - [geometry](#location--geometry) | More than one type | geometry | +| - [inScheme](#location--inScheme) | More than one type | gazetteer | +| - [altLabel](#location--altLabel) | null or string | alternative name | +| - [prefLabel](#location--prefLabel) | null or string | geographic name | + +## [Optional] Property `Location > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/locations/washington-dc" +``` + +## [Optional] Property `Location > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ------------ | +| **Default** | `"Location"` | + +## [Optional] Property `Location > bbox` + +**Title:** bounding box + +**Requirement:** Optional + +Bounding box for the location, described in WKT, GeoJSON, or GML format + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Examples:** + +```json +"POLYGON((-125 24, -66 24, -66 50, -125 50, -125 24))" +``` + +```json +{ + "type": "Polygon", + "coordinates": [ + [ + [ + -77.119759, + 38.791645 + ], + [ + -76.909393, + 38.791645 + ], + [ + -76.909393, + 38.99538 + ], + [ + -77.119759, + 38.99538 + ], + [ + -77.119759, + 38.791645 + ] + ] + ] +} +``` + +| Any of(Option) | +| ------------------------ | +| [item 0](#location--bbox_anyOf_i0) | +| [item 1](#location--bbox_anyOf_i1) | +| [item 2](#location--bbox_anyOf_i2) | + +### Property `Location > bbox > anyOf > item 0` + +| **Type** | `null` | +| -------- | ------ | + +### Property `Location > bbox > anyOf > item 1` + +Bounding box represented in WKT, GeoJSON (stringified), or GML format + +| **Type** | `string` | +| -------- | -------- | + +### Property `Location > bbox > anyOf > item 2` + +Bounding box represented in GeoJSON format, either as a Polygon or in bbox array format + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +| Property | Type | Title/Description | +| -------------------------------------------- | ----- | ----------------- | +| + [coordinates](#location--bbox_anyOf_i2_coordinates) | array | - | +| + [type](#location--bbox_anyOf_i2_type) | const | - | + +#### Property `Location > bbox > anyOf > item 2 > coordinates` + +**Requirement:** Optional + +| **Type** | `array` | +| ------------ | ------- | +| **Required** | Yes | + +#### Property `Location > bbox > anyOf > item 2 > type` + +**Requirement:** Optional + +| **Type** | `const` | +| ------------ | ------- | +| **Required** | Yes | + +Specific value: `"Polygon"` + +## [Optional] Property `Location > centroid` + +**Title:** centroid + +**Requirement:** Optional + +The geographic center (centroid) of a location described in WKT, GeoJSON, or GML format + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "type": "Point", + "coordinates": [ + -77.0369, + 38.9072 + ] +} +``` + +| Any of(Option) | +| ---------------------------- | +| [item 0](#location--centroid_anyOf_i0) | +| [item 1](#location--centroid_anyOf_i1) | +| [item 2](#location--centroid_anyOf_i2) | + +### Property `Location > centroid > anyOf > item 0` + +| **Type** | `null` | +| -------- | ------ | + +### Property `Location > centroid > anyOf > item 1` + +Center point represented in WKT, GeoJSON (stringified), or GML format + +| **Type** | `string` | +| -------- | -------- | + +### Property `Location > centroid > anyOf > item 2` + +Centroid represented in GeoJSON format; force point usage with coordinates of longitude and latitude + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +| Property | Type | Title/Description | +| ------------------------------------------------ | --------------- | ----------------- | +| + [coordinates](#location--centroid_anyOf_i2_coordinates) | array of number | - | +| + [type](#location--centroid_anyOf_i2_type) | const | - | + +#### Property `Location > centroid > anyOf > item 2 > coordinates` + +**Requirement:** Optional + +| **Type** | `array of number` | +| ------------ | ----------------- | +| **Required** | Yes | + +| Each item of this array must be | Description | +| --------------------------------------------------------- | ----------- | +| [coordinates items](#location--centroid_anyOf_i2_coordinates_items) | - | + +##### Location > centroid > anyOf > item 2 > coordinates > coordinates items + +| **Type** | `number` | +| -------- | -------- | + +#### Property `Location > centroid > anyOf > item 2 > type` + +**Requirement:** Optional + +| **Type** | `const` | +| ------------ | ------- | +| **Required** | Yes | + +Specific value: `"Point"` + +## [Optional] Property `Location > identifier` + +**Title:** identifier + +**Requirement:** Optional + +The unique geographic identifier for the Location, e.g., the URI or other unique identifier in the context of the relevant gazetteer + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ---------------------------------- | +| [item 0](#location--identifier_anyOf_i0) | +| [Identifier](#location--identifier_anyOf_i1) | + +### Property `Location > identifier > anyOf > item 0` + +| **Type** | `null` | +| -------- | ------ | + +### Property `Location > identifier > anyOf > Identifier` + +**Title:** Identifier + +inline description of Identifier + +| **Type** | More than one type | +| ------------------------- | ----------------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | + +## [Optional] Property `Location > otherIdentifier` + +**Title:** other identifier + +**Requirement:** Optional + +A list of geographic identifiers for the Location besides the main identifier, e.g. the URI or other unique identifiers in the context of the relevant gazetteer + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------------ | ----------------------------------------------------------------------------- | +| [Identifier](#location--otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | + +### Location > otherIdentifier > Identifier + +| **Type** | More than one type | +| ------------------------- | ---------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](#location--identifier_anyOf_i1) | + +## [Optional] Property `Location > geometry` + +**Title:** geometry + +**Requirement:** Optional + +Associates a location with a corresponding geometry described in WKT, GeoJSON, or GML format + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "type": "Polygon", + "coordinates": [ + [ + [ + -77.0402, + 38.7916 + ], + [ + -76.9094, + 38.8921 + ], + [ + -76.9115, + 38.9355 + ], + [ + -76.9286, + 38.9784 + ], + [ + -77.0024, + 38.9657 + ], + [ + -77.0389, + 38.9939 + ], + [ + -77.0672, + 38.9687 + ], + [ + -77.0782, + 38.9143 + ], + [ + -77.1198, + 38.9342 + ], + [ + -77.1198, + 38.8456 + ], + [ + -77.0402, + 38.7916 + ] + ] + ] +} +``` + +| Any of(Option) | +| ---------------------------- | +| [item 0](#location--geometry_anyOf_i0) | +| [item 1](#location--geometry_anyOf_i1) | +| [item 2](#location--geometry_anyOf_i2) | + +### Property `Location > geometry > anyOf > item 0` + +| **Type** | `null` | +| -------- | ------ | + +### Property `Location > geometry > anyOf > item 1` + +String format of the full geometry of the location in WKT, GeoJSON, or GML format + +| **Type** | `string` | +| -------- | -------- | + +### Property `Location > geometry > anyOf > item 2` + +Geometry represented in GeoJSON format + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +#### The following properties are required +* type +* coordinates + +## [Optional] Property `Location > inScheme` + +**Title:** gazetteer + +**Requirement:** Optional + +The gazetteer to which the location belongs + +| **Type** | More than one type | +| ------------------------- | ------------------ | +| **Additional properties** | Any type allowed | + +| Any of(Option) | +| ----------------------------------- | +| [item 0](#location--inScheme_anyOf_i0) | +| [ConceptScheme](#location--inScheme_anyOf_i1) | + +### Property `Location > inScheme > anyOf > item 0` + +| **Type** | `null` | +| -------- | ------ | + +### Property `Location > inScheme > anyOf > ConceptScheme` + +**Title:** ConceptScheme + +inline description of the gazetteer + +| **Type** | `object` | +| ------------------------- | ----------------------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Conceptscheme](./identifiers-and-relationships.md#concept-scheme) | + +## [Optional] Property `Location > altLabel` + +**Title:** alternative name + +**Requirement:** Optional + +An alternative label or name for a location + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"DC" +``` + +## [Optional] Property `Location > prefLabel` + +**Title:** geographic name + +**Requirement:** Optional + +Preferred label or name of the Location + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"Continental United States" +``` + +```json +"Washington, D.C." +``` + +--- + + + +## Metric + +**Title:** Metric + +A standard used to measure one aspect of data quality + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "Metric", + "expectedDataType": "xsd:decimal", + "inDimension": "https://example.gov/dimensions/completeness", + "definition": "Percentage of non-null values in the dataset." +} +``` + +| Property | Type | Title/Description | +| ---------------------------------------- | -------------- | ----------------- | +| - [@id](#metric--@id) | string | - | +| - [@type](#metric--@type) | string | - | +| + [expectedDataType](#metric--expectedDataType) | string | expected datatype | +| + [inDimension](#metric--inDimension) | string | in dimension | +| - [definition](#metric--definition) | null or string | definition | + +## [Optional] Property `Metric > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/metrics/record-completeness" +``` + +## [Optional] Property `Metric > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ---------- | +| **Default** | `"Metric"` | + +## [Optional] Property `Metric > expectedDataType` + +**Title:** expected datatype + +**Requirement:** Optional + +Represents the expected data type for the metric's observed value (e.g., xsd:boolean, xsd:double etc...) + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"xsd:decimal" +``` + +```json +"xsd:double" +``` + +## [Optional] Property `Metric > inDimension` + +**Title:** in dimension + +**Requirement:** Optional + +Represents the dimensions a quality metric, certificate and annotation allow a measurement of. + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"https://example.gov/dimensions/completeness" +``` + +```json +"https://www.w3.org/TR/vocab-dqv/#dqv:completeness" +``` + +## [Optional] Property `Metric > definition` + +**Title:** definition + +**Requirement:** Optional + +Definition of the metric. + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"Percentage of non-null values in the dataset." +``` + +```json +"The percentage of non-null values for required fields in a dataset. A value of 1.0 indicates 100% completeness." +``` + +--- + + + +## QualityMeasurement + +**Title:** QualityMeasurement + +A measurement of a resource against a specific quality metric + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "QualityMeasurement", + "isMeasurementOf": { + "expectedDataType": "xsd:decimal", + "inDimension": "https://example.gov/dimensions/completeness" + }, + "value": "98.5", + "unitMeasure": "percent" +} +``` + +| Property | Type | Title/Description | +| -------------------------------------- | -------------- | ----------------- | +| - [@id](#quality-measurement--@id) | string | - | +| - [@type](#quality-measurement--@type) | string | - | +| + [isMeasurementOf](#quality-measurement--isMeasurementOf) | object | is measurement of | +| + [value](#quality-measurement--value) | string | value | +| - [unitMeasure](#quality-measurement--unitMeasure) | null or string | unit of measure | + +## [Optional] Property `QualityMeasurement > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/quality-measurements/completeness-001" +``` + +## [Optional] Property `QualityMeasurement > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ---------------------- | +| **Default** | `"QualityMeasurement"` | + +## [Optional] Property `QualityMeasurement > isMeasurementOf` + +**Title:** is measurement of + +**Requirement:** Optional + +The metric being observed + +| **Type** | `object` | +| ------------------------- | --------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | +| **Defined in** | [Metric](./temporal-spatial-metrics.md#metric) | + +## [Optional] Property `QualityMeasurement > value` + +**Title:** value + +**Requirement:** Optional + +The value computed by metric + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Example:** + +```json +"98.5" +``` + +## [Optional] Property `QualityMeasurement > unitMeasure` + +**Title:** unit of measure + +**Requirement:** Optional + +Unit of measure associated with the value + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"percent" +``` + +--- + + + +## Activity + +**Title:** Activity + +An activity related to creating, changing, or using a resource + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "Activity", + "label": "Data Collection", + "category": [ + "https://example.gov/concepts/data-collection" + ] +} +``` + +| Property | Type | Title/Description | +| ------------------------ | ------------- | ----------------- | +| - [@id](#activity--@id) | string | - | +| - [@type](#activity--@type) | string | - | +| - [category](#activity--category) | null or array | category | +| + [label](#activity--label) | string | label | + +## [Optional] Property `Activity > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/activities/data-processing-001" +``` + +## [Optional] Property `Activity > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ------------ | +| **Default** | `"Activity"` | + +## [Optional] Property `Activity > category` + +**Title:** category + +**Requirement:** Optional + +List of categories for the Activity + +| **Type** | `null or array` | +| -------- | --------------- | + +| Each item of this array must be | Description | +| ------------------------------- | ------------------------------------------------------------------ | +| [Concept](#activity--category_items) | A controlled term or label, optionally drawn from a concept scheme | + +### Activity > category > Concept + +| **Type** | More than one type | +| ------------------------- | ----------------------- | +| **Additional properties** | Any type allowed | +| **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | + +## [Optional] Property `Activity > label` + +**Title:** label + +**Requirement:** Optional + +A human-readable label for the activity + +| **Type** | `string` | +| ------------ | -------- | +| **Required** | Yes | + +**Examples:** + +```json +"Data Collection" +``` + +```json +"Data Processing and Quality Assurance" +``` + +--- + + + +## Address + +**Title:** Address + +A single physical address + +| **Type** | `object` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | + +**Example:** + +```json +{ + "@type": "Address", + "street-address": "151 Patton Avenue", + "locality": "Asheville", + "region": "NC", + "postal-code": "28801", + "country-name": "United States" +} +``` + +| Property | Type | Title/Description | +| ------------------------------------ | -------------- | ------------------- | +| - [@id](#address--@id) | string | - | +| - [@type](#address--@type) | string | - | +| - [country-name](#address--country-name) | null or string | country | +| - [locality](#address--locality) | null or string | locality | +| - [postal-code](#address--postal-code) | null or string | postal code | +| - [region](#address--region) | null or string | administrative area | +| - [street-address](#address--street-address) | null or string | street address | + +## [Optional] Property `Address > @id` + +**Requirement:** Optional + +| **Type** | `string` | +| ---------- | -------- | +| **Format** | `iri` | + +**Example:** + +```json +"https://example.gov/addresses/hq-001" +``` + +## [Optional] Property `Address > @type` + +**Requirement:** Optional + +| **Type** | `string` | +| ----------- | ----------- | +| **Default** | `"Address"` | + +## [Optional] Property `Address > country-name` + +**Title:** country + +**Requirement:** Optional + +The country of the Address + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Example:** + +```json +"United States" +``` + +## [Optional] Property `Address > locality` + +**Title:** locality + +**Requirement:** Optional + +The city of the Address + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"Asheville" +``` + +```json +"Washington" +``` + +## [Optional] Property `Address > postal-code` + +**Title:** postal code + +**Requirement:** Optional + +The postal code of the Address + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"28801" +``` + +```json +"20230" +``` + +## [Optional] Property `Address > region` + +**Title:** administrative area + +**Requirement:** Optional + +The administrative area of the Address. Depending on the country, this corresponds to a province, a county, a region, or a state + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"NC" +``` + +```json +"DC" +``` + +## [Optional] Property `Address > street-address` + +**Title:** street address + +**Requirement:** Optional + +The street name and civic number of an Address + +| **Type** | `null or string` | +| -------- | ---------------- | + +**Examples:** + +```json +"151 Patton Avenue" +``` + +```json +"1401 Constitution Ave NW" +``` diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index f55039b5..c4ce31c3 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -19,6 +19,73 @@ from json_schema_for_humans.template_renderer import TemplateRenderer +MAIN_CLASS_PAGES = [ + {"source": "Catalog.md", "output": "catalog.md", "title": "Catalog"}, + {"source": "Dataset.md", "output": "dataset.md", "title": "Dataset"}, + { + "source": "DatasetSeries.md", + "output": "dataset-series.md", + "title": "Dataset Series", + }, + { + "source": "Distribution.md", + "output": "distribution.md", + "title": "Distribution", + }, +] + +GROUPED_CLASS_PAGES = [ + { + "output": "agents.md", + "title": "Agents", + "classes": ["Agent.md", "Organization.md", "Kind.md"], + }, + { + "output": "constraints-and-restrictions.md", + "title": "Constraints and Restrictions", + "classes": ["AccessRestriction.md", "CUIRestriction.md", "UseRestriction.md"], + }, + { + "output": "identifiers-and-relationships.md", + "title": "Identifiers and Relationships", + "classes": [ + "Identifier.md", + "Relationship.md", + "Checksum.md", + "Concept.md", + "ConceptScheme.md", + ], + }, + { + "output": "temporal-spatial-metrics.md", + "title": "Temporal, Spatial, and Metrics", + "classes": [ + "PeriodOfTime.md", + "Location.md", + "Metric.md", + "QualityMeasurement.md", + "Activity.md", + "Address.md", + ], + }, + { + "output": "quality-governance.md", + "title": "Quality and Governance", + "classes": [ + "Standard.md", + "Document.md", + "CatalogRecord.md", + "DataService.md", + "Attribution.md", + ], + }, +] + +GROUP_PAGE_INTRO = ( + "This page combines supporting DCAT-US 3 classes used with the main schema classes." +) + + def _any_differences(comp_object): """Check this directory and all of its subdirectories for differences. @@ -83,6 +150,152 @@ def _func_that_wraps(*args, **kwargs): return _func_that_wraps +def _class_name_from_file(file_name): + return Path(file_name).stem + + +def _class_anchor(class_name): + slug = re.sub(r"([A-Z]+)([A-Z][a-z])", r"\1-\2", class_name) + slug = re.sub(r"([a-z0-9])([A-Z])", r"\1-\2", slug) + return slug.lower() + + +def _build_class_link_map(): + link_map = {} + + for page in MAIN_CLASS_PAGES: + class_name = _class_name_from_file(page["source"]) + target = f"./{page['output']}#root" + link_map[class_name.lower()] = target + + for page in GROUPED_CLASS_PAGES: + for class_file in page["classes"]: + class_name = _class_name_from_file(class_file) + target = f"./{page['output']}#{_class_anchor(class_name)}" + link_map[class_name.lower()] = target + + return link_map + + +CLASS_LINK_MAP = _build_class_link_map() + + +def _rewrite_class_doc_links(content): + def _replace(match): + label = match.group(1) + basename = match.group(2).lower() + target = CLASS_LINK_MAP.get(basename) + if target is None: + return match.group(0) + return f"[{label}]({target})" + + return re.sub(r"\[([^\]]+)\]\(\./([A-Za-z0-9]+)\.md\)", _replace, content) + + +def _rewrite_local_anchors(content, anchor_prefix="", root_anchor="root"): + def _replace_anchor(match): + anchor_name = match.group(1) + if anchor_name == "root": + return f'' + return f'' + + def _replace_fragment(match): + anchor_name = match.group(1).strip() + if anchor_name == "root": + return f"](#{root_anchor})" + return f"](#{anchor_prefix}{anchor_name})" + + content = re.sub(r'', _replace_anchor, content) + return re.sub(r"\]\(#([^\)]+?)\s*\)", _replace_fragment, content) + + +def _normalize_doc_content(content, anchor_prefix="", root_anchor="root"): + content = content.strip() + content = _rewrite_class_doc_links(content) + content = _rewrite_local_anchors( + content, + anchor_prefix=anchor_prefix, + root_anchor=root_anchor, + ) + return content + + +def _write_text(output_path, content): + output_path.parent.mkdir(parents=True, exist_ok=True) + output_path.write_text(f"{content.rstrip()}\n", encoding="utf-8") + + +def _read_generated_doc(docs_dir, file_name): + path = Path(docs_dir) / file_name + return path.read_text(encoding="utf-8") + + +def _build_index_page(): + lines = [ + "# DCAT-US 3 Schema Documentation", + "", + "DCAT-US 3 is documented here as a smaller set of review-friendly pages.", + "", + "## Main classes", + "", + ] + + for page in MAIN_CLASS_PAGES: + lines.append(f"- [{page['title']}](./{page['output']})") + + lines.extend(["", "## Supporting classes", ""]) + + for page in GROUPED_CLASS_PAGES: + class_links = ", ".join( + f"[{_class_name_from_file(class_file)}](./{page['output']}#{_class_anchor(_class_name_from_file(class_file))})" + for class_file in page["classes"] + ) + lines.append(f"- [{page['title']}](./{page['output']}): {class_links}") + + return "\n".join(lines) + + +def _clear_generated_markdown(output_dir): + for markdown_file in Path(output_dir).glob("*.md"): + if markdown_file.name == "README.md": + continue + markdown_file.unlink() + + +def _build_public_docs(rendered_docs_dir, output_dir): + output_dir = Path(output_dir) + _clear_generated_markdown(output_dir) + + for page in MAIN_CLASS_PAGES: + raw_content = _read_generated_doc(rendered_docs_dir, page["source"]) + page_content = _normalize_doc_content(raw_content, root_anchor="root") + page_content = f'\n\n{page_content}' + _write_text(output_dir / page["output"], page_content) + + for page in GROUPED_CLASS_PAGES: + sections = [] + for class_file in page["classes"]: + class_name = _class_name_from_file(class_file) + section_anchor = _class_anchor(class_name) + raw_content = _read_generated_doc(rendered_docs_dir, class_file) + section_content = _normalize_doc_content( + raw_content, + anchor_prefix=f"{section_anchor}--", + root_anchor=section_anchor, + ) + sections.append( + f'\n\n## {class_name}\n\n{section_content}' + ) + + page_content = "\n\n---\n\n".join(sections) + _write_text( + output_dir / page["output"], + f"# {page['title']}\n\n{GROUP_PAGE_INTRO}\n\n{page_content}", + ) + + _write_text(output_dir / "index.md", _build_index_page()) + + def _normalize_requirement_level(value): """Return a normalized requirement level label.""" if not value: @@ -174,20 +387,17 @@ def _remove_me(line): return [line for line in type_info_list if not _remove_me(line)] -def generate_docs(output_dir): - """Generate the schema documentation into output_dir.""" +def _render_raw_docs(output_dir): + """Generate the unmerged schema documentation into output_dir.""" schema_files = sorted(glob.glob("definitions/*.json")) - # We need to preload the schemas at their relative ids loaded_schemas = {} for schema_file in schema_files: with open(schema_file) as f: schema = json.load(f) - # get path from $id _, _, path, _, _ = urlsplit(schema["$id"]) loaded_schemas[path] = schema - # generation config config = { "link_to_reused_ref": True, "show_breadcrumbs": True, @@ -210,7 +420,6 @@ def generate_docs(output_dir): ) template_renderer = TemplateRenderer(final_config) - # hack the rendering process original_md_properties_table = template_renderer.template.environment.filters[ "md_properties_table" ] @@ -235,6 +444,14 @@ def generate_docs(output_dir): generate.copy_additional_files_to_target(schemas_to_render, final_config) +def generate_docs(output_dir): + """Generate the schema documentation into output_dir.""" + with tempfile.TemporaryDirectory() as temp_dir: + temp_path = Path(temp_dir) + _render_raw_docs(temp_path) + _build_public_docs(temp_path, output_dir) + + @click.command() @click.option("-o", "--output-dir", help="Output directory", default="docs") @click.option( diff --git a/jsonschema/merge_dcat-us-docs.js b/jsonschema/merge_dcat-us-docs.js new file mode 100644 index 00000000..f0b5e0fb --- /dev/null +++ b/jsonschema/merge_dcat-us-docs.js @@ -0,0 +1,136 @@ +#!/usr/bin/env node + +const fs = require("fs"); +const path = require("path"); +const { execSync } = require("child_process"); + +const repoRoot = path.resolve(__dirname, ".."); +const submodulePath = path.join(repoRoot, "_external", "dcat-us"); +const docsSourceDir = path.join(submodulePath, "jsonschema", "docs"); +const outputDir = path.join(repoRoot, "pages", "_data_standards", "dcat-us-3"); + +const mainClassMap = [ + { source: "Catalog.md", output: "catalog.md", title: "Catalog" }, + { source: "Dataset.md", output: "dataset.md", title: "Dataset" }, + { source: "DatasetSeries.md", output: "dataset-series.md", title: "Dataset Series" }, + { source: "Distribution.md", output: "distribution.md", title: "Distribution" }, +]; + +const groupedClassPages = [ + { + output: "agents.md", + title: "Agents", + classes: ["Agent.md", "Organization.md", "Kind.md"], + }, + { + output: "constraints-and-restrictions.md", + title: "Constraints and Restrictions", + classes: ["AccessRestriction.md", "CUIRestriction.md", "UseRestriction.md"], + }, + { + output: "identifiers-and-relationships.md", + title: "Identifiers and Relationships", + classes: ["Identifier.md", "Relationship.md", "Checksum.md", "Concept.md", "ConceptScheme.md"], + }, + { + output: "temporal-spatial-metrics.md", + title: "Temporal, Spatial, and Metrics", + classes: ["PeriodOfTime.md", "Location.md", "Metric.md", "QualityMeasurement.md", "Activity.md", "Address.md"], + }, + { + output: "quality-governance.md", + title: "Quality and Governance", + classes: ["Standard.md", "Document.md", "CatalogRecord.md", "DataService.md", "Attribution.md"], + }, +]; + +function runCommand(command, cwd = repoRoot) { + execSync(command, { cwd, stdio: "pipe" }); +} + +function ensureSubmoduleReady() { + if (!fs.existsSync(path.join(submodulePath, ".git"))) { + runCommand("git submodule update --init --depth 1 _external/dcat-us"); + } + + runCommand("git sparse-checkout init --no-cone", submodulePath); + runCommand('printf "/jsonschema/definitions/\\n/jsonschema/docs/\\n" | git sparse-checkout set --stdin', submodulePath); +} + +function readSourceDoc(fileName) { + const fullPath = path.join(docsSourceDir, fileName); + if (!fs.existsSync(fullPath)) { + throw new Error(`Missing expected source doc: ${fullPath}`); + } + + return fs.readFileSync(fullPath, "utf8").trim(); +} + +function buildFrontMatter(title, permalink) { + return [ + "---", + `title: DCAT-US 3.0: ${title}`, + "layout: page", + `permalink: ${permalink}`, + "primary_nav_section: Data Standards", + "category_name: Data standards", + "---", + "", + ].join("\n"); +} + +function writeFile(outputPath, content) { + fs.mkdirSync(path.dirname(outputPath), { recursive: true }); + fs.writeFileSync(outputPath, `${content.trim()}\n`, "utf8"); +} + +function buildMainClassPages() { + mainClassMap.forEach((item) => { + const sourceContent = readSourceDoc(item.source); + const permalink = `/standards/catalog/dcat-us-3/${item.output.replace(".md", "")}/`; + const pageContent = `${buildFrontMatter(item.title, permalink)}${sourceContent}`; + writeFile(path.join(outputDir, item.output), pageContent); + }); +} + +function buildGroupedPages() { + groupedClassPages.forEach((group) => { + const permalink = `/standards/catalog/dcat-us-3/${group.output.replace(".md", "")}/`; + const sections = group.classes.map((classFile) => { + const className = classFile.replace(".md", ""); + const sourceContent = readSourceDoc(classFile); + return `## ${className}\n\n${sourceContent}`; + }); + + const pageContent = [ + buildFrontMatter(group.title, permalink), + `This page combines supporting DCAT-US 3.0 classes used with the main schema classes.`, + "", + sections.join("\n\n---\n\n"), + "", + ].join("\n"); + + writeFile(path.join(outputDir, group.output), pageContent); + }); +} + +function main() { + try { + ensureSubmoduleReady(); + + if (!fs.existsSync(docsSourceDir)) { + throw new Error(`Source docs directory not found: ${docsSourceDir}`); + } + + fs.mkdirSync(outputDir, { recursive: true }); + buildMainClassPages(); + buildGroupedPages(); + + process.stdout.write("Merged DCAT-US 3.0 docs into pages/_data_standards/dcat-us-3/\n"); + } catch (error) { + process.stderr.write(`${error.message}\n`); + process.exit(1); + } +} + +main(); From 780f0e8ea35c510e12a66dd915cf752e8ed044d9 Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 17:29:16 -0600 Subject: [PATCH 02/13] Remove duplicative array information (simplify links) Co-authored-by: Copilot --- jsonschema/doc_templates/md/section_array.md | 6 +- jsonschema/docs/agents.md | 35 +- jsonschema/docs/catalog.md | 216 +++------- .../docs/constraints-and-restrictions.md | 32 +- jsonschema/docs/dataset-series.md | 66 +-- jsonschema/docs/dataset.md | 397 +++++------------- jsonschema/docs/distribution.md | 145 +++---- .../docs/identifiers-and-relationships.md | 14 +- jsonschema/docs/quality-governance.md | 315 ++++---------- jsonschema/docs/temporal-spatial-metrics.md | 48 +-- jsonschema/generate_schema_docs.py | 89 +++- 11 files changed, 443 insertions(+), 920 deletions(-) diff --git a/jsonschema/doc_templates/md/section_array.md b/jsonschema/doc_templates/md/section_array.md index e20ddc16..60f2bddb 100644 --- a/jsonschema/doc_templates/md/section_array.md +++ b/jsonschema/doc_templates/md/section_array.md @@ -6,14 +6,10 @@ {% if schema.array_items_def %} {% set is_linked_array_item = schema.array_items_def.should_be_a_link(config) or schema.array_items_def.refers_to %} +{% if not is_linked_array_item %} {% filter md_heading(depth+1, schema.array_items_def.html_id) %} {% with schema=schema.array_items_def %}{%- include "breadcrumbs.md" %}{% endwith %} {% endfilter %} -{% if is_linked_array_item %} -{% with schema=schema.array_items_def, skip_headers=True, depth=depth+1, skip_required=True %} - {% include "content.md" %} -{% endwith %} -{% else %} {% with schema=schema.array_items_def, skip_headers=False, depth=depth+1, skip_required=True %} {% include "content.md" %} {% endwith %} diff --git a/jsonschema/docs/agents.md b/jsonschema/docs/agents.md index 5f777f69..ac7fd89a 100644 --- a/jsonschema/docs/agents.md +++ b/jsonschema/docs/agents.md @@ -66,16 +66,9 @@ The type of the agent that makes the item available | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#agent--category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Agent > category > Concept - -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `Agent > name` @@ -211,14 +204,7 @@ Represents hierarchical containment of Organizations or OrganizationalUnits; ind | Each item of this array must be | Description | | ---------------------------------------- | --------------------------------------------------------------------------------- | -| [Organization](#organization--subOrganizationOf_items) | An organization involved with a resource, including parent or child organizations | - -### Organization > subOrganizationOf > Organization - -| **Type** | `object` | -| ------------------------- | --------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Organization](#organization) | +| [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | ## [Optional] Property `Organization > altLabel` @@ -369,16 +355,9 @@ The address of the contact | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------- | -| [Address](#kind--address_items) | A single physical address | - -### Kind > address > Address - -| **Type** | `object` | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Address](./temporal-spatial-metrics.md#address) | +| Each item of this array must be | Description | +| ------------------------------------------------ | ------------------------- | +| [Address](./temporal-spatial-metrics.md#address) | A single physical address | ## [Optional] Property `Kind > hasEmail` diff --git a/jsonschema/docs/catalog.md b/jsonschema/docs/catalog.md index 2a6288ee..5b314ee4 100644 --- a/jsonschema/docs/catalog.md +++ b/jsonschema/docs/catalog.md @@ -138,13 +138,6 @@ List of related catalogs that are useful in the context of this catalog | ----------------------------------- | ---------------------------------------------------------------------------------- | | [DCAT-US 3 Catalog](#catalog_items) | A curated collection of metadata about datasets, data services, or other resources | -### DCAT-US 3 Catalog > catalog > DCAT-US 3 Catalog - -| **Type** | `object` | -| ------------------------- | -------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [DCAT-US 3 Catalog](#root) | - ## [Optional] Property `DCAT-US 3 Catalog > contactPoint` **Title:** Contact points @@ -158,14 +151,7 @@ Contact information people can use to ask questions or send feedback about the c | Each item of this array must be | Description | | ------------------------------- | ----------------------------------------------- | -| [Kind](#contactPoint_items) | Contact information for an individual or entity | - -### DCAT-US 3 Catalog > contactPoint > Kind - -| **Type** | `object` | -| ------------------------- | ----------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Kind](./agents.md#kind) | +| [Kind](./agents.md#kind) | Contact information for an individual or entity | ## [Optional] Property `DCAT-US 3 Catalog > dataset` @@ -181,14 +167,7 @@ List of datasets included in the catalog. Use this together with service so the | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | -| [Dataset](#dataset_items) | A collection of data published or curated by one provider | - -### DCAT-US 3 Catalog > dataset > Dataset - -| **Type** | `object` | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Dataset](./dataset.md#root) | +| [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | ## [Optional] Property `DCAT-US 3 Catalog > keyword` @@ -236,16 +215,9 @@ A catalog record describing how a single resource (such as a dataset or data ser | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ----------------------------------------------------------------------- | -| [CatalogRecord](#record_items) | A record in a catalog, describing the registration of a single resource | - -### DCAT-US 3 Catalog > record > CatalogRecord - -| **Type** | `object` | -| ------------------------- | ----------------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Catalogrecord](./quality-governance.md#catalog-record) | +| Each item of this array must be | Description | +| ------------------------------------------------------- | ----------------------------------------------------------------------- | +| [CatalogRecord](./quality-governance.md#catalog-record) | A record in a catalog, describing the registration of a single resource | ## [Optional] Property `DCAT-US 3 Catalog > service` @@ -258,16 +230,9 @@ List of data services included in the catalog. Use this together with dataset so | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------- | -| [DataService](#service_items) | A service that provides access to data or data processing functions | - -### DCAT-US 3 Catalog > service > DataService - -| **Type** | `object` | -| ------------------------- | -------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [DataService](#dataset_items_sample_items_accessService_items) | +| Each item of this array must be | Description | +| --------------------------------------------------- | ------------------------------------------------------------------- | +| [DataService](./quality-governance.md#data-service) | A service that provides access to data or data processing functions | ## [Optional] Property `DCAT-US 3 Catalog > theme` @@ -280,16 +245,9 @@ List of themes or categories for the catalog. A catalog can have more than one t | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#theme_items) | A controlled term or label, optionally drawn from a concept scheme | - -### DCAT-US 3 Catalog > theme > Concept - -| **Type** | More than one type | -| ------------------------- | ----------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#dataset_items_sample_items_representationTechnique_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `DCAT-US 3 Catalog > themeTaxonomy` @@ -302,16 +260,9 @@ Controlled vocabulary or taxonomy used to classify catalog resources, such as da | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------- | --------------------------------------------------------------------- | -| [ConceptScheme](#themeTaxonomy_items) | A controlled vocabulary or other list of approved terms for a concept | - -### DCAT-US 3 Catalog > themeTaxonomy > ConceptScheme - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [inScheme](#dataset_items_sample_items_representationTechnique_anyOf_i1_anyOf_i1_inScheme) | +| Each item of this array must be | Description | +| ------------------------------------------------------------------ | --------------------------------------------------------------------- | +| [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) | A controlled vocabulary or other list of approved terms for a concept | ## [Optional] Property `DCAT-US 3 Catalog > accessRights` @@ -380,10 +331,10 @@ Standard, schema, profile, or model that this catalog follows A standard or specification that another resource conforms to -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Standard](#dataset_items_sample_items_accessService_items_conformsTo_items) | +| **Type** | `object` | +| ------------------------- | -------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Standard](./quality-governance.md#standard) | ## [Optional] Property `DCAT-US 3 Catalog > creator` @@ -398,14 +349,7 @@ Person or organization responsible for creating the catalog metadata | Each item of this array must be | Description | | ------------------------------- | -------------------------------------------------------------------------------- | -| [Agent](#creator_items) | A person, organization, software agent, or other entity involved with a resource | - -### DCAT-US 3 Catalog > creator > Agent - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Agent](#dataset_items_sample_items_accessService_items_creator_items) | +| [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | ## [Optional] Property `DCAT-US 3 Catalog > description` @@ -443,13 +387,6 @@ List of catalogs that are contained within this catalog | ----------------------------------- | ---------------------------------------------------------------------------------- | | [DCAT-US 3 Catalog](#hasPart_items) | A curated collection of metadata about datasets, data services, or other resources | -### DCAT-US 3 Catalog > hasPart > DCAT-US 3 Catalog - -| **Type** | `object` | -| ------------------------- | -------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [DCAT-US 3 Catalog](#root) | - ## [Optional] Property `DCAT-US 3 Catalog > identifier` **Title:** identifier @@ -480,10 +417,10 @@ Main unique identifier for the catalog, such as a URI or another persistent iden inline description of Identifier -| **Type** | More than one type | -| ------------------------- | -------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#dataset_items_otherIdentifier_items) | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | ## [Optional] Property `DCAT-US 3 Catalog > otherIdentifier` @@ -496,16 +433,9 @@ A list of identifiers for the Catalog besides the main identifier, e.g. the URI | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### DCAT-US 3 Catalog > otherIdentifier > Identifier - -| **Type** | More than one type | -| ------------------------- | -------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#dataset_items_otherIdentifier_items) | +| Each item of this array must be | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------------------------- | +| [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | ## [Optional] Property `DCAT-US 3 Catalog > issued` @@ -829,10 +759,10 @@ Person or organization responsible for publishing and making the catalog availab inline description of the publisher -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Agent](#dataset_items_sample_items_accessService_items_creator_items) | +| **Type** | `object` | +| ------------------------- | -------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Agent](./agents.md#agent) | ## [Optional] Property `DCAT-US 3 Catalog > rights` @@ -882,16 +812,9 @@ Organizations that hold rights in the catalog | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ----------------------------------- | --------------------------------------------------------------------------------- | -| [Organization](#rightsHolder_items) | An organization involved with a resource, including parent or child organizations | - -### DCAT-US 3 Catalog > rightsHolder > Organization - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Organization](#dataset_items_otherIdentifier_items_anyOf_i1_creator_anyOf_i1) | +| Each item of this array must be | Description | +| ---------------------------------------- | --------------------------------------------------------------------------------- | +| [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | ## [Optional] Property `DCAT-US 3 Catalog > spatial` @@ -904,16 +827,9 @@ Geographic area covered by the catalog | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | -------------------------------- | -| [Location](#spatial_items) | A named place or geographic area | - -### DCAT-US 3 Catalog > spatial > Location - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Location](#dataset_items_sample_items_accessService_items_spatial_items) | +| Each item of this array must be | Description | +| -------------------------------------------------- | -------------------------------- | +| [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | ## [Optional] Property `DCAT-US 3 Catalog > subject` @@ -926,16 +842,9 @@ List of subjects of the catalog | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#subject_items) | A controlled term or label, optionally drawn from a concept scheme | - -### DCAT-US 3 Catalog > subject > Concept - -| **Type** | More than one type | -| ------------------------- | ----------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#dataset_items_sample_items_representationTechnique_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `DCAT-US 3 Catalog > temporal` @@ -948,16 +857,9 @@ Time periods covered by the catalog | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ---------------------------------------------------------------------- | -| [PeriodOfTime](#temporal_items) | Information about a specific time period with a start- and/or end-time | - -### DCAT-US 3 Catalog > temporal > PeriodOfTime - -| **Type** | More than one type | -| ------------------------- | ------------------------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [PeriodOfTime](#dataset_items_sample_items_accessService_items_temporal_items) | +| Each item of this array must be | Description | +| ------------------------------------------------------------ | ---------------------------------------------------------------------- | +| [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | ## [Optional] Property `DCAT-US 3 Catalog > title` @@ -991,16 +893,9 @@ List of high-level categories for the catalog | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### DCAT-US 3 Catalog > category > Concept - -| **Type** | More than one type | -| ------------------------- | ----------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#dataset_items_sample_items_representationTechnique_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `DCAT-US 3 Catalog > homepage` @@ -1032,10 +927,10 @@ Main public web page for the catalog, usually an HTML page inline description of the home page -| **Type** | `object` | -| ------------------------- | -------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Document](#dataset_items_sample_items_page_items) | +| **Type** | `object` | +| ------------------------- | -------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Document](./quality-governance.md#document) | ## [Optional] Property `DCAT-US 3 Catalog > qualifiedAttribution` @@ -1048,13 +943,6 @@ List of agents with specific responsibilities for the catalog | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------------ | ------------------------------------------------- | -| [Attribution](#qualifiedAttribution_items) | A responsibility that an agent has for a resource | - -### DCAT-US 3 Catalog > qualifiedAttribution > Attribution - -| **Type** | `object` | -| ------------------------- | ----------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Attribution](#dataset_items_sample_items_accessService_items_qualifiedAttribution_items) | +| Each item of this array must be | Description | +| -------------------------------------------------- | ------------------------------------------------- | +| [Attribution](./quality-governance.md#attribution) | A responsibility that an agent has for a resource | diff --git a/jsonschema/docs/constraints-and-restrictions.md b/jsonschema/docs/constraints-and-restrictions.md index f290fd1f..192ee997 100644 --- a/jsonschema/docs/constraints-and-restrictions.md +++ b/jsonschema/docs/constraints-and-restrictions.md @@ -74,10 +74,10 @@ A note related to the access restriction The indication of whether or not there are access restrictions on the item, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/access-restriction-status -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | **Examples:** @@ -130,10 +130,10 @@ Authority, code list entry, or policy reference that defines the specific access inline description of the specific restriction -| **Type** | More than one type | -| ------------------------- | --------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [restrictionStatus](#access-restriction--restrictionStatus) | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | --- @@ -348,10 +348,10 @@ Significant information pertaining to the use or reproduction of the data Indication of whether or not there are use restrictions on the archival materials, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/use-restriction-status -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | **Examples:** @@ -404,7 +404,7 @@ Authority, code list entry, or policy reference that defines the specific use re inline description of the specific restriction -| **Type** | More than one type | -| ------------------------- | --------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [restrictionStatus](#use-restriction--restrictionStatus) | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | diff --git a/jsonschema/docs/dataset-series.md b/jsonschema/docs/dataset-series.md index 951efff7..a2759875 100644 --- a/jsonschema/docs/dataset-series.md +++ b/jsonschema/docs/dataset-series.md @@ -193,14 +193,7 @@ List of contacts people can use to ask questions or send feedback about the data | Each item of this array must be | Description | | ------------------------------- | ----------------------------------------------- | -| [Kind](#contactPoint_items) | Contact information for an individual or entity | - -### DatasetSeries > contactPoint > Kind - -| **Type** | `object` | -| ------------------------- | ----------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Kind](./agents.md#kind) | +| [Kind](./agents.md#kind) | Contact information for an individual or entity | ## [Optional] Property `DatasetSeries > first` @@ -232,9 +225,9 @@ The first dataset in an ordered dataset series inline description of the first dataset -| **Type** | `object` | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | +| **Type** | `object` | +| ------------------------- | ---------------------------- | +| **Additional properties** | Any type allowed | | **Defined in** | [Dataset](./dataset.md#root) | ## [Optional] Property `DatasetSeries > last` @@ -267,10 +260,10 @@ The last dataset in an ordered dataset series inline description of the last dataset -| **Type** | `object` | -| ------------------------- | -------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Dataset](#first_anyOf_i1) | +| **Type** | `object` | +| ------------------------- | ---------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Dataset](./dataset.md#root) | ## [Optional] Property `DatasetSeries > seriesMember` @@ -285,14 +278,7 @@ List of members of the Dataset Series | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | -| [Dataset](#seriesMember_items) | A collection of data published or curated by one provider | - -### DatasetSeries > seriesMember > Dataset - -| **Type** | `object` | -| ------------------------- | -------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Dataset](#first_anyOf_i1) | +| [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | ## [Optional] Property `DatasetSeries > accrualPeriodicity` @@ -618,10 +604,10 @@ Organization responsible for maintaining the Dataset Series as a coherent series inline description of publisher -| **Type** | `object` | -| ------------------------- | ----------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Agent](#first_anyOf_i1_sample_items_accessService_items_creator_items) | +| **Type** | `object` | +| ------------------------- | -------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Agent](./agents.md#agent) | ## [Optional] Property `DatasetSeries > spatial` @@ -634,16 +620,9 @@ A geographic region that is covered by the Dataset Series | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | -------------------------------- | -| [Location](#spatial_items) | A named place or geographic area | - -### DatasetSeries > spatial > Location - -| **Type** | `object` | -| ------------------------- | -------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Location](#first_anyOf_i1_sample_items_accessService_items_spatial_items) | +| Each item of this array must be | Description | +| -------------------------------------------------- | -------------------------------- | +| [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | ## [Optional] Property `DatasetSeries > temporal` @@ -656,16 +635,9 @@ Time periods covered by the dataset series | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ---------------------------------------------------------------------- | -| [PeriodOfTime](#temporal_items) | Information about a specific time period with a start- and/or end-time | - -### DatasetSeries > temporal > PeriodOfTime - -| **Type** | More than one type | -| ------------------------- | ------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [PeriodOfTime](#first_anyOf_i1_sample_items_accessService_items_temporal_items) | +| Each item of this array must be | Description | +| ------------------------------------------------------------ | ---------------------------------------------------------------------- | +| [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | ## [Optional] Property `DatasetSeries > title` diff --git a/jsonschema/docs/dataset.md b/jsonschema/docs/dataset.md index b33f28ed..a3ca3e04 100644 --- a/jsonschema/docs/dataset.md +++ b/jsonschema/docs/dataset.md @@ -191,16 +191,9 @@ Additional identifiers for the dataset besides the main identifier, such as a DO | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### Dataset > otherIdentifier > Identifier - -| **Type** | More than one type | -| ------------------------- | ----------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | +| Each item of this array must be | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------------------------- | +| [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | ## [Optional] Property `Dataset > sample` @@ -213,16 +206,9 @@ List of sample distributions for the dataset | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ----------------------------------------------------------------------------- | -| [Distribution](#sample_items) | A specific representation of a dataset, such as a file, feed, or API response | - -### Dataset > sample > Distribution - -| **Type** | `object` | -| ------------------------- | --------------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Distribution](./distribution.md#root) | +| Each item of this array must be | Description | +| -------------------------------------- | ----------------------------------------------------------------------------- | +| [Distribution](./distribution.md#root) | A specific representation of a dataset, such as a file, feed, or API response | ## [Optional] Property `Dataset > status` @@ -254,10 +240,10 @@ Lifecycle status of the dataset, such as completed, deprecated, under developmen inline description of Concept -| **Type** | More than one type | -| ------------------------- | --------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#sample_items_representationTechnique_anyOf_i1) | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | ## [Optional] Property `Dataset > supportedSchema` @@ -289,10 +275,10 @@ supported schema for this dataset inline description of the supported schema -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Dataset](#sample_items_accessService_items_servesDataset_items) | +| **Type** | `object` | +| ------------------------- | ---------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Dataset](./dataset.md#root) | ## [Optional] Property `Dataset > versionNotes` @@ -335,10 +321,10 @@ A contact point for questions about the Dataset (single contact or list). Includ inline description of Kind -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Kind](#sample_items_accessService_items_contactPoint_items) | +| **Type** | `object` | +| ------------------------- | ------------------------ | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Kind](./agents.md#kind) | ### Property `Dataset > contactPoint > anyOf > List of contacts` @@ -347,16 +333,9 @@ inline description of Kind | **Type** | `array` | | -------- | ------- | -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------- | -| [Kind](#contactPoint_anyOf_i1_items) | Contact information for an individual or entity | - -#### Dataset > contactPoint > anyOf > List of contacts > Kind - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Kind](#sample_items_accessService_items_contactPoint_items) | +| Each item of this array must be | Description | +| ------------------------------- | ----------------------------------------------- | +| [Kind](./agents.md#kind) | Contact information for an individual or entity | ## [Optional] Property `Dataset > distribution` @@ -369,16 +348,9 @@ List of available distributions for the dataset. This can be omitted when no dis | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ----------------------------------- | ----------------------------------------------------------------------------- | -| [Distribution](#distribution_items) | A specific representation of a dataset, such as a file, feed, or API response | - -### Dataset > distribution > Distribution - -| **Type** | `object` | -| ------------------------- | ----------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Distribution](#sample_items) | +| Each item of this array must be | Description | +| -------------------------------------- | ----------------------------------------------------------------------------- | +| [Distribution](./distribution.md#root) | A specific representation of a dataset, such as a file, feed, or API response | ## [Optional] Property `Dataset > first` @@ -410,10 +382,10 @@ the first item of the sequence the dataset belongs to inline description of Dataset -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Dataset](#sample_items_accessService_items_servesDataset_items) | +| **Type** | `object` | +| ------------------------- | ---------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Dataset](./dataset.md#root) | ## [Optional] Property `Dataset > hasCurrentVersion` @@ -445,10 +417,10 @@ reference to the current (latest) version of a dataset inline description of Dataset -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Dataset](#sample_items_accessService_items_servesDataset_items) | +| **Type** | `object` | +| ------------------------- | ---------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Dataset](./dataset.md#root) | ## [Optional] Property `Dataset > hasVersion` @@ -463,14 +435,7 @@ List of related Datasets that are a version, edition, or adaptation of the descr | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | -| [Dataset](#hasVersion_items) | A collection of data published or curated by one provider | - -### Dataset > hasVersion > Dataset - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Dataset](#sample_items_accessService_items_servesDataset_items) | +| [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | ## [Optional] Property `Dataset > inSeries` @@ -483,16 +448,9 @@ Dataset series this dataset belongs to | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| -------------------------------- | --------------------------------------------------------- | -| [DatasetSeries](#inSeries_items) | A group of related datasets that are published separately | - -### Dataset > inSeries > DatasetSeries - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [DatasetSeries](#sample_items_accessService_items_servesDataset_items_inSeries_items) | +| Each item of this array must be | Description | +| ----------------------------------------- | --------------------------------------------------------- | +| [DatasetSeries](./dataset-series.md#root) | A group of related datasets that are published separately | ## [Optional] Property `Dataset > keyword` @@ -573,10 +531,10 @@ A web page from the original data provider that gives access to the Dataset, its inline description of Document -| **Type** | `object` | -| ------------------------- | -------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Document](#sample_items_accessService_items_servesDataset_items_landingPage_anyOf_i1) | +| **Type** | `object` | +| ------------------------- | -------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Document](./quality-governance.md#document) | ## [Optional] Property `Dataset > previousVersion` @@ -608,10 +566,10 @@ reference to the previous dataset version inline description of Dataset -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Dataset](#sample_items_accessService_items_servesDataset_items) | +| **Type** | `object` | +| ------------------------- | ---------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Dataset](./dataset.md#root) | ## [Optional] Property `Dataset > qualifiedRelation` @@ -624,16 +582,9 @@ Detailed relationship between the dataset and another resource, including the ro | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ---------------------------------------- | ------------------------------------------------------------------- | -| [Relationship](#qualifiedRelation_items) | Additional information about how one resource is related to another | - -### Dataset > qualifiedRelation > Relationship - -| **Type** | `object` | -| ------------------------- | --------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Relationship](#sample_items_accessService_items_servesDataset_items_qualifiedRelation_items) | +| Each item of this array must be | Description | +| --------------------------------------------------------------- | ------------------------------------------------------------------- | +| [Relationship](./identifiers-and-relationships.md#relationship) | Additional information about how one resource is related to another | ## [Optional] Property `Dataset > spatialResolutionInMeters` @@ -680,16 +631,9 @@ List of themes or categories for the dataset | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#theme_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Dataset > theme > Concept - -| **Type** | More than one type | -| ------------------------- | --------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#sample_items_representationTechnique_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `Dataset > version` @@ -738,10 +682,10 @@ A distribution describing the Data Dictionary for this dataset inline description of Distribution -| **Type** | `object` | -| ------------------------- | ----------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Distribution](#sample_items) | +| **Type** | `object` | +| ------------------------- | -------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Distribution](./distribution.md#root) | ## [Optional] Property `Dataset > liabilityStatement` @@ -791,16 +735,9 @@ Distribution of the original metadata document this dataset was derived from | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------------- | ----------------------------------------------------------------------------- | -| [Distribution](#metadataDistribution_items) | A specific representation of a dataset, such as a file, feed, or API response | - -### Dataset > metadataDistribution > Distribution - -| **Type** | `object` | -| ------------------------- | ----------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Distribution](#sample_items) | +| Each item of this array must be | Description | +| -------------------------------------- | ----------------------------------------------------------------------------- | +| [Distribution](./distribution.md#root) | A specific representation of a dataset, such as a file, feed, or API response | ## [Optional] Property `Dataset > purpose` @@ -961,16 +898,9 @@ List of standards, schemas, or profiles the dataset follows | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------- | -| [Standard](#conformsTo_items) | A standard or specification that another resource conforms to | - -### Dataset > conformsTo > Standard - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Standard](#sample_items_accessService_items_servesDataset_items_landingPage_anyOf_i1_conformsTo_items) | +| Each item of this array must be | Description | +| -------------------------------------------- | ------------------------------------------------------------- | +| [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | ## [Optional] Property `Dataset > contributor` @@ -985,14 +915,7 @@ List of agents contributing to the Dataset | Each item of this array must be | Description | | ------------------------------- | -------------------------------------------------------------------------------- | -| [Agent](#contributor_items) | A person, organization, software agent, or other entity involved with a resource | - -### Dataset > contributor > Agent - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Agent](#sample_items_accessService_items_servesDataset_items_inSeries_items_publisher_anyOf_i1) | +| [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | ## [Optional] Property `Dataset > created` @@ -1115,10 +1038,10 @@ Person or organization responsible for creating the dataset inline description of Agent -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Agent](#sample_items_accessService_items_servesDataset_items_inSeries_items_publisher_anyOf_i1) | +| **Type** | `object` | +| ------------------------- | -------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Agent](./agents.md#agent) | ## [Optional] Property `Dataset > description` @@ -1155,14 +1078,7 @@ List of related datasets that are part of the described dataset | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | -| [Dataset](#hasPart_items) | A collection of data published or curated by one provider | - -### Dataset > hasPart > Dataset - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Dataset](#sample_items_accessService_items_servesDataset_items) | +| [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | ## [Optional] Property `Dataset > identifier` @@ -1195,10 +1111,10 @@ The unique identifier for the Dataset, e.g. the URI or other unique identifier i inline description of Identifier -| **Type** | More than one type | -| ------------------------- | ------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#otherIdentifier_items) | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | ## [Optional] Property `Dataset > isReferencedBy` @@ -1520,10 +1436,10 @@ Full text of the provenance statement Organization responsible for publishing and making the dataset available -| **Type** | `object` | -| ------------------------- | --------------------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | +| **Type** | `object` | +| ------------------------- | ---------------------------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | **Defined in** | [Organization](./agents.md#organization) | ## [Optional] Property `Dataset > relation` @@ -1572,14 +1488,7 @@ List of Datasets replaced by this Dataset | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | -| [Dataset](#replaces_items) | A collection of data published or curated by one provider | - -### Dataset > replaces > Dataset - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Dataset](#sample_items_accessService_items_servesDataset_items) | +| [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | ## [Optional] Property `Dataset > rights` @@ -1628,16 +1537,9 @@ List of agents (organizations) holding rights on the Dataset | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ----------------------------------- | --------------------------------------------------------------------------------- | -| [Organization](#rightsHolder_items) | An organization involved with a resource, including parent or child organizations | - -### Dataset > rightsHolder > Organization - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Organization](#otherIdentifier_items_anyOf_i1_creator_anyOf_i1) | +| Each item of this array must be | Description | +| ---------------------------------------- | --------------------------------------------------------------------------------- | +| [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | ## [Optional] Property `Dataset > source` @@ -1652,14 +1554,7 @@ List of related Datasets from which the described Dataset is derived | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | -| [Dataset](#source_items) | A collection of data published or curated by one provider | - -### Dataset > source > Dataset - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Dataset](#sample_items_accessService_items_servesDataset_items) | +| [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | ## [Optional] Property `Dataset > spatial` @@ -1692,10 +1587,10 @@ A geographic region or regions that are covered by the Dataset inline description of Location -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Location](#sample_items_accessService_items_servesDataset_items_inSeries_items_spatial_items) | +| **Type** | `object` | +| ------------------------- | -------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Location](./temporal-spatial-metrics.md#location) | ### Property `Dataset > spatial > anyOf > List of geographic regions` @@ -1704,16 +1599,9 @@ inline description of Location | **Type** | `array` | | -------- | ------- | -| Each item of this array must be | Description | -| ----------------------------------- | -------------------------------- | -| [Location](#spatial_anyOf_i2_items) | A named place or geographic area | - -#### Dataset > spatial > anyOf > List of geographic regions > Location - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Location](#sample_items_accessService_items_servesDataset_items_inSeries_items_spatial_items) | +| Each item of this array must be | Description | +| -------------------------------------------------- | -------------------------------- | +| [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | ## [Optional] Property `Dataset > subject` @@ -1726,16 +1614,9 @@ List of primary subjects for the dataset, usually narrower than broad theme cate | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#subject_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Dataset > subject > Concept - -| **Type** | More than one type | -| ------------------------- | --------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#sample_items_representationTechnique_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `Dataset > temporal` @@ -1748,16 +1629,9 @@ Time periods covered by the dataset | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ---------------------------------------------------------------------- | -| [PeriodOfTime](#temporal_items) | Information about a specific time period with a start- and/or end-time | - -### Dataset > temporal > PeriodOfTime - -| **Type** | More than one type | -| ------------------------- | --------------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [PeriodOfTime](#sample_items_accessService_items_servesDataset_items_inSeries_items_temporal_items) | +| Each item of this array must be | Description | +| ------------------------------------------------------------ | ---------------------------------------------------------------------- | +| [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | ## [Optional] Property `Dataset > title` @@ -1792,16 +1666,9 @@ List of high-level categories for the dataset | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Dataset > category > Concept - -| **Type** | More than one type | -| ------------------------- | --------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#sample_items_representationTechnique_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `Dataset > hasQualityMeasurement` @@ -1814,16 +1681,9 @@ List of quality measurements for the dataset (for example, completeness, accurac | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| -------------------------------------------------- | ------------------------------------------------------------- | -| [QualityMeasurement](#hasQualityMeasurement_items) | A measurement of a resource against a specific quality metric | - -### Dataset > hasQualityMeasurement > QualityMeasurement - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [QualityMeasurement](#sample_items_accessService_items_servesDataset_items_hasQualityMeasurement_items) | +| Each item of this array must be | Description | +| ----------------------------------------------------------------------- | ------------------------------------------------------------- | +| [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) | A measurement of a resource against a specific quality metric | ## [Optional] Property `Dataset > page` @@ -1836,16 +1696,9 @@ List of pages or documents about this dataset | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ----------------------------------------------------- | -| [Document](#page_items) | A publication or other document related to a resource | - -### Dataset > page > Document - -| **Type** | `object` | -| ------------------------- | -------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Document](#sample_items_accessService_items_servesDataset_items_landingPage_anyOf_i1) | +| Each item of this array must be | Description | +| -------------------------------------------- | ----------------------------------------------------- | +| [Document](./quality-governance.md#document) | A publication or other document related to a resource | ## [Optional] Property `Dataset > qualifiedAttribution` @@ -1858,16 +1711,9 @@ List of agents with specific responsibilities for the dataset | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------------ | ------------------------------------------------- | -| [Attribution](#qualifiedAttribution_items) | A responsibility that an agent has for a resource | - -### Dataset > qualifiedAttribution > Attribution - -| **Type** | `object` | -| ------------------------- | ----------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Attribution](#sample_items_accessService_items_servesDataset_items_qualifiedAttribution_items) | +| Each item of this array must be | Description | +| -------------------------------------------------- | ------------------------------------------------- | +| [Attribution](./quality-governance.md#attribution) | A responsibility that an agent has for a resource | ## [Optional] Property `Dataset > wasAttributedTo` @@ -1882,14 +1728,7 @@ List of agents attributed to this dataset | Each item of this array must be | Description | | ------------------------------- | -------------------------------------------------------------------------------- | -| [Agent](#wasAttributedTo_items) | A person, organization, software agent, or other entity involved with a resource | - -### Dataset > wasAttributedTo > Agent - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Agent](#sample_items_accessService_items_servesDataset_items_inSeries_items_publisher_anyOf_i1) | +| [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | ## [Optional] Property `Dataset > wasGeneratedBy` @@ -1902,16 +1741,9 @@ List of activities that generated, or provide the business context for the creat | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| --------------------------------- | -------------------------------------------------------------- | -| [Activity](#wasGeneratedBy_items) | An activity related to creating, changing, or using a resource | - -### Dataset > wasGeneratedBy > Activity - -| **Type** | `object` | -| ------------------------- | -------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Activity](#sample_items_accessService_items_servesDataset_items_wasGeneratedBy_items) | +| Each item of this array must be | Description | +| -------------------------------------------------- | -------------------------------------------------------------- | +| [Activity](./temporal-spatial-metrics.md#activity) | An activity related to creating, changing, or using a resource | ## [Optional] Property `Dataset > wasUsedBy` @@ -1924,16 +1756,9 @@ List of activities that used the Dataset | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | -------------------------------------------------------------- | -| [Activity](#wasUsedBy_items) | An activity related to creating, changing, or using a resource | - -### Dataset > wasUsedBy > Activity - -| **Type** | `object` | -| ------------------------- | -------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Activity](#sample_items_accessService_items_servesDataset_items_wasGeneratedBy_items) | +| Each item of this array must be | Description | +| -------------------------------------------------- | -------------------------------------------------------------- | +| [Activity](./temporal-spatial-metrics.md#activity) | An activity related to creating, changing, or using a resource | ## [Optional] Property `Dataset > image` diff --git a/jsonschema/docs/distribution.md b/jsonschema/docs/distribution.md index 1de9db33..4a33c385 100644 --- a/jsonschema/docs/distribution.md +++ b/jsonschema/docs/distribution.md @@ -126,9 +126,9 @@ Method or schema used to structure the distribution content (for example, CSV co inline description of Concept -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------- | +| **Additional properties** | Any type allowed | | **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | ## [Optional] Property `Distribution > status` @@ -161,10 +161,10 @@ The status of the distribution in the context of maturity lifecycle inline description of Concept -| **Type** | More than one type | -| ------------------------- | -------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#representationTechnique_anyOf_i1) | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | ## [Optional] Property `Distribution > characterEncoding` @@ -227,16 +227,9 @@ A data service that gives access to the distribution of the dataset | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ----------------------------------- | ------------------------------------------------------------------- | -| [DataService](#accessService_items) | A service that provides access to data or data processing functions | - -### Distribution > accessService > DataService - -| **Type** | `object` | -| ------------------------- | ------------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Dataservice](./quality-governance.md#data-service) | +| Each item of this array must be | Description | +| --------------------------------------------------- | ------------------------------------------------------------------- | +| [DataService](./quality-governance.md#data-service) | A service that provides access to data or data processing functions | ## [Optional] Property `Distribution > accessURL` @@ -454,10 +447,10 @@ An indication how long it is planned to keep the Distribution of the Dataset ava inline description of Concept -| **Type** | More than one type | -| ------------------------- | -------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#representationTechnique_anyOf_i1) | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | ## [Optional] Property `Distribution > accessRestriction` @@ -470,16 +463,9 @@ List of access restrictions related to the distribution | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| --------------------------------------------- | ----------------------------------------------------------- | -| [AccessRestriction](#accessRestriction_items) | Rules or indicators that describe who can access a resource | - -### Distribution > accessRestriction > AccessRestriction - -| **Type** | `object` | -| ------------------------- | -------------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [AccessRestriction](#accessService_items_servesDataset_items_sample_items_accessRestriction_items) | +| Each item of this array must be | Description | +| ------------------------------------------------------------------------- | ----------------------------------------------------------- | +| [AccessRestriction](./constraints-and-restrictions.md#access-restriction) | Rules or indicators that describe who can access a resource | ## [Optional] Property `Distribution > cuiRestriction` @@ -511,10 +497,10 @@ Controlled Unclassified Information restriction related to the distribution inline description of CUIRestriction -| **Type** | `object` | -| ------------------------- | ----------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [CUIRestriction](#accessService_items_servesDataset_items_sample_items_cuiRestriction_anyOf_i1) | +| **Type** | `object` | +| ------------------------- | ------------------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [CUIRestriction](./constraints-and-restrictions.md#cui-restriction) | ## [Optional] Property `Distribution > describedBy` @@ -546,10 +532,10 @@ A distribution containing the Data Dictionary for this distribution inline description of the data dictionary -| **Type** | `object` | -| ------------------------- | --------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Distribution](#accessService_items_servesDataset_items_sample_items) | +| **Type** | `object` | +| ------------------------- | -------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Distribution](./distribution.md#root) | ## [Optional] Property `Distribution > useRestriction` @@ -562,16 +548,9 @@ Use restriction related to the distribution | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| --------------------------------------- | --------------------------------------------------- | -| [UseRestriction](#useRestriction_items) | Rules or legal limits on how a resource may be used | - -### Distribution > useRestriction > UseRestriction - -| **Type** | `object` | -| ------------------------- | -------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [UseRestriction](#accessService_items_servesDataset_items_sample_items_useRestriction_items) | +| Each item of this array must be | Description | +| ------------------------------------------------------------------- | --------------------------------------------------- | +| [UseRestriction](./constraints-and-restrictions.md#use-restriction) | Rules or legal limits on how a resource may be used | ## [Optional] Property `Distribution > accessRights` @@ -621,16 +600,9 @@ List of standards, schemas, or reference systems the Distribution follows (prefe | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------- | -| [Standard](#conformsTo_items) | A standard or specification that another resource conforms to | - -### Distribution > conformsTo > Standard - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Standard](#accessService_items_servesDataset_items_sample_items_conformsTo_items) | +| Each item of this array must be | Description | +| -------------------------------------------- | ------------------------------------------------------------- | +| [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | ## [Optional] Property `Distribution > description` @@ -700,10 +672,10 @@ The unique identifier for the Distribution (e.g. DOI, ISBN) inline description of Identifier -| **Type** | More than one type | -| ------------------------- | ---------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#accessService_items_servesDataset_items_otherIdentifier_items) | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | ## [Optional] Property `Distribution > otherIdentifier` @@ -716,16 +688,9 @@ A list of identifiers for the Distribution besides the main identifier, e.g. the | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### Distribution > otherIdentifier > Identifier - -| **Type** | More than one type | -| ------------------------- | ---------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#accessService_items_servesDataset_items_otherIdentifier_items) | +| Each item of this array must be | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------------------------- | +| [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | ## [Optional] Property `Distribution > issued` @@ -1085,16 +1050,9 @@ Quality measurements for the distribution (for example, completeness, accuracy, | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| -------------------------------------------------- | ------------------------------------------------------------- | -| [QualityMeasurement](#hasQualityMeasurement_items) | A measurement of a resource against a specific quality metric | - -### Distribution > hasQualityMeasurement > QualityMeasurement - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [QualityMeasurement](#accessService_items_servesDataset_items_sample_items_hasQualityMeasurement_items) | +| Each item of this array must be | Description | +| ----------------------------------------------------------------------- | ------------------------------------------------------------- | +| [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) | A measurement of a resource against a specific quality metric | ## [Optional] Property `Distribution > page` @@ -1107,16 +1065,9 @@ A page or document about this Distribution | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ----------------------------------------------------- | -| [Document](#page_items) | A publication or other document related to a resource | - -### Distribution > page > Document - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Document](#accessService_items_servesDataset_items_sample_items_page_items) | +| Each item of this array must be | Description | +| -------------------------------------------- | ----------------------------------------------------- | +| [Document](./quality-governance.md#document) | A publication or other document related to a resource | ## [Optional] Property `Distribution > image` @@ -1182,7 +1133,7 @@ Checksum used to verify that the downloadable file content has not changed inline description of Checksum -| **Type** | `object` | -| ------------------------- | ----------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Checksum](#accessService_items_servesDataset_items_sample_items_checksum_anyOf_i1) | +| **Type** | `object` | +| ------------------------- | ------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Checksum](./identifiers-and-relationships.md#checksum) | diff --git a/jsonschema/docs/identifiers-and-relationships.md b/jsonschema/docs/identifiers-and-relationships.md index 8181b1ed..7e31c48b 100644 --- a/jsonschema/docs/identifiers-and-relationships.md +++ b/jsonschema/docs/identifiers-and-relationships.md @@ -101,9 +101,9 @@ the agency that manages the identifier scheme inline description of the creator -| **Type** | `object` | -| ------------------------- | --------------------------------- | -| **Additional properties** | Any type allowed | +| **Type** | `object` | +| ------------------------- | ---------------------------------------- | +| **Additional properties** | Any type allowed | | **Defined in** | [Organization](./agents.md#organization) | ### Property `Identifier > anyOf > Identifier as a complex object > issued` @@ -481,10 +481,10 @@ Definition of the controlled vocabulary term Concept scheme defining this concept -| **Type** | `object` | -| ------------------------- | ----------------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Conceptscheme](./identifiers-and-relationships.md#concept-scheme) | +| **Type** | `object` | +| ------------------------- | ------------------------------------------------------------------ | +| **Additional properties** | Any type allowed | +| **Defined in** | [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) | ### Property `Concept > anyOf > item 1 > notation` diff --git a/jsonschema/docs/quality-governance.md b/jsonschema/docs/quality-governance.md index 443f2b33..660131dc 100644 --- a/jsonschema/docs/quality-governance.md +++ b/jsonschema/docs/quality-governance.md @@ -213,9 +213,9 @@ The unique identifier for the Standard, e.g. the URI or other unique identifier inline description of Identifier -| **Type** | More than one type | -| ------------------------- | ----------------------------- | -| **Additional properties** | Any type allowed | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------------- | +| **Additional properties** | Any type allowed | | **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | ## [Optional] Property `Standard > otherIdentifier` @@ -229,16 +229,9 @@ A list of identifiers for the Standard besides the main identifier, e.g. the URI | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#standard--otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### Standard > otherIdentifier > Identifier - -| **Type** | More than one type | -| ------------------------- | ---------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#standard--identifier_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------------------------- | +| [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | ## [Optional] Property `Standard > issued` @@ -454,16 +447,9 @@ List of categories for the Standard | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#standard--category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Standard > category > Concept - -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `Standard > inScheme` @@ -495,10 +481,10 @@ The reference register to which the Standard belongs inline description of ConceptScheme -| **Type** | `object` | -| ------------------------- | --------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [inScheme](#standard--category_items_anyOf_i1_inScheme) | +| **Type** | `object` | +| ------------------------- | ------------------------------------------------------------------ | +| **Additional properties** | Any type allowed | +| **Same definition as** | [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) | --- @@ -670,14 +656,7 @@ The individual(s) responsible for creating the Document | Each item of this array must be | Description | | ------------------------------- | ----------------------------------------------- | -| [Kind](#document--creator_items) | Contact information for an individual or entity | - -### Document > creator > Kind - -| **Type** | `object` | -| ------------------------- | ----------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Kind](./agents.md#kind) | +| [Kind](./agents.md#kind) | Contact information for an individual or entity | ## [Optional] Property `Document > mediaType` @@ -745,16 +724,9 @@ List of standards or specifications the document follows | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------- | -| [Standard](#document--conformsTo_items) | A standard or specification that another resource conforms to | - -### Document > conformsTo > Standard - -| **Type** | `object` | -| ------------------------- | ------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Standard](./quality-governance.md#standard) | +| Each item of this array must be | Description | +| -------------------------------------------- | ------------------------------------------------------------- | +| [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | ## [Optional] Property `Document > corporateCreator` @@ -767,16 +739,9 @@ The corporate organization(s) responsible for creating the Document | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| --------------------------------------- | --------------------------------------------------------------------------------- | -| [Organization](#document--corporateCreator_items) | An organization involved with a resource, including parent or child organizations | - -### Document > corporateCreator > Organization - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Organization](#document--conformsTo_items_identifier_anyOf_i1_anyOf_i1_creator_anyOf_i1) | +| Each item of this array must be | Description | +| ---------------------------------------- | --------------------------------------------------------------------------------- | +| [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | ## [Optional] Property `Document > description` @@ -829,10 +794,10 @@ The unique identifier for the Document (e.g. DOI, ISBN) inline description of Identifier -| **Type** | More than one type | -| ------------------------- | --------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#document--conformsTo_items_identifier_anyOf_i1) | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | ## [Optional] Property `Document > otherIdentifier` @@ -845,16 +810,9 @@ A list of identifiers for the Document besides the main identifier, e.g. the URI | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#document--otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### Document > otherIdentifier > Identifier - -| **Type** | More than one type | -| ------------------------- | --------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#document--conformsTo_items_identifier_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------------------------- | +| [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | ## [Optional] Property `Document > issued` @@ -956,16 +914,9 @@ The organization(s) that published the Document | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| -------------------------------- | --------------------------------------------------------------------------------- | -| [Organization](#document--publisher_items) | An organization involved with a resource, including parent or child organizations | - -### Document > publisher > Organization - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Organization](#document--conformsTo_items_identifier_anyOf_i1_anyOf_i1_creator_anyOf_i1) | +| Each item of this array must be | Description | +| ---------------------------------------- | --------------------------------------------------------------------------------- | +| [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | ## [Optional] Property `Document > title` @@ -996,16 +947,9 @@ List of categories/genres for the Document | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#document--category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Document > category > Concept - -| **Type** | More than one type | -| ------------------------- | ------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#document--conformsTo_items_category_items) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | --- @@ -1106,9 +1050,9 @@ The status of the catalog record in the context of editorial flow of the dataset inline description of status -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------- | +| **Additional properties** | Any type allowed | | **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | ## [Optional] Property `CatalogRecord > conformsTo` @@ -1141,9 +1085,9 @@ An Application Profile that the Catalog Record's metadata conforms to inline description of application profile -| **Type** | `object` | -| ------------------------- | ------------------------- | -| **Additional properties** | Any type allowed | +| **Type** | `object` | +| ------------------------- | -------------------------------------------- | +| **Additional properties** | Any type allowed | | **Defined in** | [Standard](./quality-governance.md#standard) | ## [Optional] Property `CatalogRecord > description` @@ -1601,14 +1545,7 @@ Contact information for questions about the Data Service. Include an email addre | Each item of this array must be | Description | | ------------------------------- | ----------------------------------------------- | -| [Kind](#data-service--contactPoint_items) | Contact information for an individual or entity | - -### DataService > contactPoint > Kind - -| **Type** | `object` | -| ------------------------- | ----------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Kind](./agents.md#kind) | +| [Kind](./agents.md#kind) | Contact information for an individual or entity | ## [Optional] Property `DataService > endpointDescription` @@ -1744,14 +1681,7 @@ List of datasets this service provides access to | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | -| [Dataset](#data-service--servesDataset_items) | A collection of data published or curated by one provider | - -### DataService > servesDataset > Dataset - -| **Type** | `object` | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Dataset](./dataset.md#root) | +| [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | ## [Optional] Property `DataService > spatialResolutionInMeters` @@ -1798,16 +1728,9 @@ List of themes or categories for the data service | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#data-service--theme_items) | A controlled term or label, optionally drawn from a concept scheme | - -### DataService > theme > Concept - -| **Type** | More than one type | -| ------------------------- | ----------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#data-service--servesDataset_items_sample_items_representationTechnique_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `DataService > accessRights` @@ -1855,16 +1778,9 @@ List of general standards or specifications that the Data Service endpoints impl | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------- | -| [Standard](#data-service--conformsTo_items) | A standard or specification that another resource conforms to | - -### DataService > conformsTo > Standard - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Standard](#data-service--servesDataset_items_sample_items_accessService_items_conformsTo_items) | +| Each item of this array must be | Description | +| -------------------------------------------- | ------------------------------------------------------------- | +| [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | ## [Optional] Property `DataService > created` @@ -1968,14 +1884,7 @@ List of agents primarily responsible for producing the Data Service | Each item of this array must be | Description | | ------------------------------- | -------------------------------------------------------------------------------- | -| [Agent](#data-service--creator_items) | A person, organization, software agent, or other entity involved with a resource | - -### DataService > creator > Agent - -| **Type** | `object` | -| ------------------------- | ---------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Agent](#data-service--servesDataset_items_sample_items_accessService_items_creator_items) | +| [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | ## [Optional] Property `DataService > description` @@ -2022,10 +1931,10 @@ The unique identifier for the Data Service, e.g. the URI or other unique identif inline description of Identifier -| **Type** | More than one type | -| ------------------------- | -------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#data-service--servesDataset_items_otherIdentifier_items) | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------------- | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | ## [Optional] Property `DataService > otherIdentifier` @@ -2038,16 +1947,9 @@ A list of identifiers for the Data Service besides the main identifier, e.g. the | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#data-service--otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### DataService > otherIdentifier > Identifier - -| **Type** | More than one type | -| ------------------------- | -------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#data-service--servesDataset_items_otherIdentifier_items) | +| Each item of this array must be | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------------------------- | +| [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | ## [Optional] Property `DataService > language` @@ -2256,10 +2158,10 @@ A year and month in YYYY-MM format Person or organization responsible for publishing and making the data service available -| **Type** | `object` | -| ------------------------- | ------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | +| **Type** | `object` | +| ------------------------- | -------------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | **Defined in** | [Agent](./agents.md#agent) | ## [Optional] Property `DataService > rights` @@ -2301,16 +2203,9 @@ A list of Agents (organizations) holding rights on the Data Service | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ----------------------------------- | --------------------------------------------------------------------------------- | -| [Organization](#data-service--rightsHolder_items) | An organization involved with a resource, including parent or child organizations | - -### DataService > rightsHolder > Organization - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Organization](#data-service--servesDataset_items_otherIdentifier_items_anyOf_i1_creator_anyOf_i1) | +| Each item of this array must be | Description | +| ---------------------------------------- | --------------------------------------------------------------------------------- | +| [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | ## [Optional] Property `DataService > spatial` @@ -2323,16 +2218,9 @@ A geographic region that is covered by the Data Service | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | -------------------------------- | -| [Location](#data-service--spatial_items) | A named place or geographic area | - -### DataService > spatial > Location - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Location](#data-service--servesDataset_items_sample_items_accessService_items_spatial_items) | +| Each item of this array must be | Description | +| -------------------------------------------------- | -------------------------------- | +| [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | ## [Optional] Property `DataService > temporal` @@ -2345,16 +2233,9 @@ Time periods covered by the data service | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ---------------------------------------------------------------------- | -| [PeriodOfTime](#data-service--temporal_items) | Information about a specific time period with a start- and/or end-time | - -### DataService > temporal > PeriodOfTime - -| **Type** | More than one type | -| ------------------------- | ------------------------------------------------------------------------------------ | -| **Additional properties** | Any type allowed | -| **Same definition as** | [PeriodOfTime](#data-service--servesDataset_items_sample_items_accessService_items_temporal_items) | +| Each item of this array must be | Description | +| ------------------------------------------------------------ | ---------------------------------------------------------------------- | +| [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | ## [Optional] Property `DataService > title` @@ -2385,16 +2266,9 @@ List of high-level categories for the data service | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#data-service--category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### DataService > category > Concept - -| **Type** | More than one type | -| ------------------------- | ----------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Concept](#data-service--servesDataset_items_sample_items_representationTechnique_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `DataService > hasQualityMeasurement` @@ -2407,16 +2281,9 @@ Quality measurements for the data service (for example, availability, response t | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| -------------------------------------------------- | ------------------------------------------------------------- | -| [QualityMeasurement](#data-service--hasQualityMeasurement_items) | A measurement of a resource against a specific quality metric | - -### DataService > hasQualityMeasurement > QualityMeasurement - -| **Type** | `object` | -| ------------------------- | ------------------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [QualityMeasurement](#data-service--servesDataset_items_sample_items_accessService_items_hasQualityMeasurement_items) | +| Each item of this array must be | Description | +| ----------------------------------------------------------------------- | ------------------------------------------------------------- | +| [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) | A measurement of a resource against a specific quality metric | ## [Optional] Property `DataService > qualifiedAttribution` @@ -2429,16 +2296,9 @@ List of agents with specific responsibilities for the data service | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------------ | ------------------------------------------------- | -| [Attribution](#data-service--qualifiedAttribution_items) | A responsibility that an agent has for a resource | - -### DataService > qualifiedAttribution > Attribution - -| **Type** | `object` | -| ------------------------- | ----------------------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Attribution](#data-service--servesDataset_items_sample_items_accessService_items_qualifiedAttribution_items) | +| Each item of this array must be | Description | +| -------------------------------------------------- | ------------------------------------------------- | +| [Attribution](./quality-governance.md#attribution) | A responsibility that an agent has for a resource | ## [Optional] Property `DataService > wasUsedBy` @@ -2451,16 +2311,9 @@ List of activities that used or tested the data service | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | -------------------------------------------------------------- | -| [Activity](#data-service--wasUsedBy_items) | An activity related to creating, changing, or using a resource | - -### DataService > wasUsedBy > Activity - -| **Type** | `object` | -| ------------------------- | --------------------------------------------------------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Activity](#data-service--servesDataset_items_sample_items_accessService_items_wasUsedBy_items) | +| Each item of this array must be | Description | +| -------------------------------------------------- | -------------------------------------------------------------- | +| [Activity](./temporal-spatial-metrics.md#activity) | An activity related to creating, changing, or using a resource | --- @@ -2543,8 +2396,8 @@ The function of an entity or agent with respect to another entity or resource The agent that plays a role in the resource -| **Type** | `object` | -| ------------------------- | ------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | +| **Type** | `object` | +| ------------------------- | -------------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | **Defined in** | [Agent](./agents.md#agent) | diff --git a/jsonschema/docs/temporal-spatial-metrics.md b/jsonschema/docs/temporal-spatial-metrics.md index 4ef7f12c..6b9e2bdb 100644 --- a/jsonschema/docs/temporal-spatial-metrics.md +++ b/jsonschema/docs/temporal-spatial-metrics.md @@ -620,9 +620,9 @@ The unique geographic identifier for the Location, e.g., the URI or other unique inline description of Identifier -| **Type** | More than one type | -| ------------------------- | ----------------------------- | -| **Additional properties** | Any type allowed | +| **Type** | More than one type | +| ------------------------- | ----------------------------------------------------------- | +| **Additional properties** | Any type allowed | | **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | ## [Optional] Property `Location > otherIdentifier` @@ -636,16 +636,9 @@ A list of geographic identifiers for the Location besides the main identifier, e | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | -| [Identifier](#location--otherIdentifier_items) | A unique identifier and optionally it's scheme and other relevant information | - -### Location > otherIdentifier > Identifier - -| **Type** | More than one type | -| ------------------------- | ---------------------------------- | -| **Additional properties** | Any type allowed | -| **Same definition as** | [Identifier](#location--identifier_anyOf_i1) | +| Each item of this array must be | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------------------------- | +| [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | ## [Optional] Property `Location > geometry` @@ -773,10 +766,10 @@ The gazetteer to which the location belongs inline description of the gazetteer -| **Type** | `object` | -| ------------------------- | ----------------------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Conceptscheme](./identifiers-and-relationships.md#concept-scheme) | +| **Type** | `object` | +| ------------------------- | ------------------------------------------------------------------ | +| **Additional properties** | Any type allowed | +| **Defined in** | [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) | ## [Optional] Property `Location > altLabel` @@ -1002,10 +995,10 @@ A measurement of a resource against a specific quality metric The metric being observed -| **Type** | `object` | -| ------------------------- | --------------------- | -| **Required** | Yes | -| **Additional properties** | Any type allowed | +| **Type** | `object` | +| ------------------------- | ---------------------------------------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | **Defined in** | [Metric](./temporal-spatial-metrics.md#metric) | ## [Optional] Property `QualityMeasurement > value` @@ -1109,16 +1102,9 @@ List of categories for the Activity | **Type** | `null or array` | | -------- | --------------- | -| Each item of this array must be | Description | -| ------------------------------- | ------------------------------------------------------------------ | -| [Concept](#activity--category_items) | A controlled term or label, optionally drawn from a concept scheme | - -### Activity > category > Concept - -| **Type** | More than one type | -| ------------------------- | ----------------------- | -| **Additional properties** | Any type allowed | -| **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | +| Each item of this array must be | Description | +| ----------------------------------------------------- | ------------------------------------------------------------------ | +| [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | ## [Optional] Property `Activity > label` diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index c4ce31c3..9cca2846 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -178,6 +178,44 @@ def _build_class_link_map(): CLASS_LINK_MAP = _build_class_link_map() +CLASS_DISPLAY_NAME_MAP = { + _class_name_from_file(page["source"]).lower(): _class_name_from_file(page["source"]) + for page in MAIN_CLASS_PAGES +} +CLASS_DISPLAY_NAME_MAP.update( + { + _class_name_from_file(class_file).lower(): _class_name_from_file(class_file) + for page in GROUPED_CLASS_PAGES + for class_file in page["classes"] + } +) + + +def _canonical_class_doc_link(schema_node): + if schema_node is None: + return None + + candidates = [schema_node, schema_node.refers_to, schema_node.refers_to_merged] + for candidate in candidates: + if candidate is None: + continue + + class_name = None + if getattr(candidate, "ref_path", None): + class_name = candidate.ref_path.split("/")[-1] + elif getattr(candidate, "definition_name", None): + class_name = candidate.definition_name + + if not class_name: + continue + + normalized_name = class_name.lower() + target = CLASS_LINK_MAP.get(normalized_name) + if target: + display_name = CLASS_DISPLAY_NAME_MAP.get(normalized_name, class_name) + return f"[{display_name}]({target})" + + return None def _rewrite_class_doc_links(content): @@ -360,20 +398,40 @@ def _remove_me(line): return [line for line in properties_list if not _remove_me(line)] -def type_info_table_wrap(type_info_list): +def array_items_restrictions_wrap(items_restrictions, schema): + if not items_restrictions: + return items_restrictions + + items = ([schema.array_items_def] if schema.array_items_def else []) + schema.tuple_validation_items + for row, item in zip(items_restrictions[1:], items): + canonical_link = _canonical_class_doc_link(item) + if canonical_link: + row[0] = canonical_link + + return items_restrictions + + +def type_info_table_wrap(type_info_list, schema): """Edit the type info table for our preferred format. type_info_list is a list of lists that will eventually be formatted into a table. """ + canonical_link = _canonical_class_doc_link(schema) + # edit lines for line in type_info_list: if line[0].strip("*") == "Defined in": - # This is a link to another type, so turn it into a relative link - match = re.match(r"^/dcat-us/3.0.0/definitions/(\w+)", line[1]) - class_name = match.group(1) - line[1] = f"[{class_name.title()}](./{class_name.title()}.md)" + if canonical_link: + line[1] = canonical_link + else: + # This is a link to another type, so turn it into a relative link + match = re.match(r"^/dcat-us/3.0.0/definitions/(\w+)", line[1]) + class_name = match.group(1) + line[1] = f"[{class_name.title()}](./{class_name.title()}.md)" + elif line[0].strip("*") == "Same definition as" and canonical_link: + line[1] = canonical_link elif "`combining`" in line: # replace combining with something better line[line.index("`combining`")] = "More than one type" @@ -433,10 +491,25 @@ def _render_raw_docs(output_dir): schema, ) ) + original_md_array_items_restrictions = template_renderer.template.environment.filters[ + "md_array_items_restrictions" + ] + original_md_type_info_table = template_renderer.template.environment.filters[ + "md_type_info_table" + ] + template_renderer.template.environment.filters["canonical_class_doc_link"] = ( + _canonical_class_doc_link + ) + template_renderer.template.environment.filters["md_array_items_restrictions"] = ( + lambda schema: array_items_restrictions_wrap( + original_md_array_items_restrictions(schema), + schema, + ) + ) template_renderer.template.environment.filters["md_type_info_table"] = ( - _wrapped_filter( - template_renderer.template.environment.filters["md_type_info_table"], - type_info_table_wrap, + lambda schema: type_info_table_wrap( + original_md_type_info_table(schema), + schema, ) ) From dbe7d0b7404b3f92ade475998a073f9222b5755a Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 17:33:03 -0600 Subject: [PATCH 03/13] Add line intro for each page. Co-authored-by: Copilot --- jsonschema/docs/agents.md | 2 +- jsonschema/docs/catalog.md | 2 ++ .../docs/constraints-and-restrictions.md | 2 +- jsonschema/docs/dataset-series.md | 2 ++ jsonschema/docs/dataset.md | 2 ++ jsonschema/docs/distribution.md | 2 ++ .../docs/identifiers-and-relationships.md | 2 +- jsonschema/docs/quality-governance.md | 2 +- jsonschema/docs/temporal-spatial-metrics.md | 2 +- jsonschema/generate_schema_docs.py | 29 ++++++++++++++----- 10 files changed, 34 insertions(+), 13 deletions(-) diff --git a/jsonschema/docs/agents.md b/jsonschema/docs/agents.md index ac7fd89a..447ca59e 100644 --- a/jsonschema/docs/agents.md +++ b/jsonschema/docs/agents.md @@ -1,6 +1,6 @@ # Agents -This page combines supporting DCAT-US 3 classes used with the main schema classes. +Data information classes including Agent, Organization, and Kind, which describe organizations, people, and contact information. diff --git a/jsonschema/docs/catalog.md b/jsonschema/docs/catalog.md index 5b314ee4..644c022d 100644 --- a/jsonschema/docs/catalog.md +++ b/jsonschema/docs/catalog.md @@ -1,5 +1,7 @@ +The catalog of datasets, services, and other information describing data assets. + **Title:** DCAT-US 3 Catalog A curated collection of metadata about datasets, data services, or other resources diff --git a/jsonschema/docs/constraints-and-restrictions.md b/jsonschema/docs/constraints-and-restrictions.md index 192ee997..ddb18c15 100644 --- a/jsonschema/docs/constraints-and-restrictions.md +++ b/jsonschema/docs/constraints-and-restrictions.md @@ -1,6 +1,6 @@ # Constraints and Restrictions -This page combines supporting DCAT-US 3 classes used with the main schema classes. +Restriction classes describing access limits, controlled unclassified information, and rules on how a resource may be used. diff --git a/jsonschema/docs/dataset-series.md b/jsonschema/docs/dataset-series.md index a2759875..0892c27f 100644 --- a/jsonschema/docs/dataset-series.md +++ b/jsonschema/docs/dataset-series.md @@ -1,5 +1,7 @@ +Information about a dataset series, including its members, ordering, coverage, and publishing details. + **Title:** DatasetSeries A group of related datasets that are published separately diff --git a/jsonschema/docs/dataset.md b/jsonschema/docs/dataset.md index a3ca3e04..4464fb1f 100644 --- a/jsonschema/docs/dataset.md +++ b/jsonschema/docs/dataset.md @@ -1,5 +1,7 @@ +Information about a dataset, including identifiers, contacts, coverage, distributions, and related resources. + **Title:** Dataset A collection of data published or curated by one provider diff --git a/jsonschema/docs/distribution.md b/jsonschema/docs/distribution.md index 4a33c385..b694ab35 100644 --- a/jsonschema/docs/distribution.md +++ b/jsonschema/docs/distribution.md @@ -1,5 +1,7 @@ +Information about a distribution, including access methods, formats, licenses, restrictions, and quality details. + **Title:** Distribution A specific representation of a dataset, such as a file, feed, or API response diff --git a/jsonschema/docs/identifiers-and-relationships.md b/jsonschema/docs/identifiers-and-relationships.md index 7e31c48b..64fec193 100644 --- a/jsonschema/docs/identifiers-and-relationships.md +++ b/jsonschema/docs/identifiers-and-relationships.md @@ -1,6 +1,6 @@ # Identifiers and Relationships -This page combines supporting DCAT-US 3 classes used with the main schema classes. +Supporting classes for identifiers, relationships, checksums, and controlled concepts used to describe and connect resources. diff --git a/jsonschema/docs/quality-governance.md b/jsonschema/docs/quality-governance.md index 660131dc..9f5045f9 100644 --- a/jsonschema/docs/quality-governance.md +++ b/jsonschema/docs/quality-governance.md @@ -1,6 +1,6 @@ # Quality and Governance -This page combines supporting DCAT-US 3 classes used with the main schema classes. +Supporting classes for standards, documents, catalog records, data services, and attribution used in governance and quality description. diff --git a/jsonschema/docs/temporal-spatial-metrics.md b/jsonschema/docs/temporal-spatial-metrics.md index 6b9e2bdb..c7e184c0 100644 --- a/jsonschema/docs/temporal-spatial-metrics.md +++ b/jsonschema/docs/temporal-spatial-metrics.md @@ -1,6 +1,6 @@ # Temporal, Spatial, and Metrics -This page combines supporting DCAT-US 3 classes used with the main schema classes. +Supporting classes for time periods, locations, quality metrics, measurements, activities, and addresses. diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index 9cca2846..bba8d85c 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -20,17 +20,29 @@ MAIN_CLASS_PAGES = [ - {"source": "Catalog.md", "output": "catalog.md", "title": "Catalog"}, - {"source": "Dataset.md", "output": "dataset.md", "title": "Dataset"}, + { + "source": "Catalog.md", + "output": "catalog.md", + "title": "Catalog", + "intro": "The catalog of datasets, services, and other information describing data assets.", + }, + { + "source": "Dataset.md", + "output": "dataset.md", + "title": "Dataset", + "intro": "Information about a dataset, including identifiers, contacts, coverage, distributions, and related resources.", + }, { "source": "DatasetSeries.md", "output": "dataset-series.md", "title": "Dataset Series", + "intro": "Information about a dataset series, including its members, ordering, coverage, and publishing details.", }, { "source": "Distribution.md", "output": "distribution.md", "title": "Distribution", + "intro": "Information about a distribution, including access methods, formats, licenses, restrictions, and quality details.", }, ] @@ -38,16 +50,19 @@ { "output": "agents.md", "title": "Agents", + "intro": "Data information classes including Agent, Organization, and Kind, which describe organizations, people, and contact information.", "classes": ["Agent.md", "Organization.md", "Kind.md"], }, { "output": "constraints-and-restrictions.md", "title": "Constraints and Restrictions", + "intro": "Restriction classes describing access limits, controlled unclassified information, and rules on how a resource may be used.", "classes": ["AccessRestriction.md", "CUIRestriction.md", "UseRestriction.md"], }, { "output": "identifiers-and-relationships.md", "title": "Identifiers and Relationships", + "intro": "Supporting classes for identifiers, relationships, checksums, and controlled concepts used to describe and connect resources.", "classes": [ "Identifier.md", "Relationship.md", @@ -59,6 +74,7 @@ { "output": "temporal-spatial-metrics.md", "title": "Temporal, Spatial, and Metrics", + "intro": "Supporting classes for time periods, locations, quality metrics, measurements, activities, and addresses.", "classes": [ "PeriodOfTime.md", "Location.md", @@ -71,6 +87,7 @@ { "output": "quality-governance.md", "title": "Quality and Governance", + "intro": "Supporting classes for standards, documents, catalog records, data services, and attribution used in governance and quality description.", "classes": [ "Standard.md", "Document.md", @@ -81,10 +98,6 @@ }, ] -GROUP_PAGE_INTRO = ( - "This page combines supporting DCAT-US 3 classes used with the main schema classes." -) - def _any_differences(comp_object): """Check this directory and all of its subdirectories for differences. @@ -307,7 +320,7 @@ def _build_public_docs(rendered_docs_dir, output_dir): for page in MAIN_CLASS_PAGES: raw_content = _read_generated_doc(rendered_docs_dir, page["source"]) page_content = _normalize_doc_content(raw_content, root_anchor="root") - page_content = f'\n\n{page_content}' + page_content = f'\n\n{page["intro"]}\n\n{page_content}' _write_text(output_dir / page["output"], page_content) for page in GROUPED_CLASS_PAGES: @@ -328,7 +341,7 @@ def _build_public_docs(rendered_docs_dir, output_dir): page_content = "\n\n---\n\n".join(sections) _write_text( output_dir / page["output"], - f"# {page['title']}\n\n{GROUP_PAGE_INTRO}\n\n{page_content}", + f"# {page['title']}\n\n{page['intro']}\n\n{page_content}", ) _write_text(output_dir / "index.md", _build_index_page()) From 8a6b11e4f1d5b54be902f76a09d732c63381057d Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 21:44:28 -0600 Subject: [PATCH 04/13] Update schema documentation styling Co-authored-by: Copilot --- jsonschema/doc_templates/md/content.md | 23 +- jsonschema/doc_templates/md/section_array.md | 58 +-- .../doc_templates/md/section_examples.md | 24 +- jsonschema/doc_templates/md/section_one_of.md | 11 +- .../md/section_properties_details.md | 14 +- jsonschema/doc_templates/md/tabbed_section.md | 2 +- jsonschema/docs/agents.md | 50 +-- jsonschema/docs/catalog.md | 144 +++---- .../docs/constraints-and-restrictions.md | 50 +-- jsonschema/docs/dataset-series.md | 94 ++--- jsonschema/docs/dataset.md | 298 +++++++------- jsonschema/docs/distribution.md | 200 +++++----- .../docs/identifiers-and-relationships.md | 160 ++++---- jsonschema/docs/quality-governance.md | 364 +++++++++--------- jsonschema/docs/temporal-spatial-metrics.md | 166 ++++---- jsonschema/generate_schema_docs.py | 9 +- 16 files changed, 853 insertions(+), 814 deletions(-) diff --git a/jsonschema/doc_templates/md/content.md b/jsonschema/doc_templates/md/content.md index 566c8897..a9dd78f0 100644 --- a/jsonschema/doc_templates/md/content.md +++ b/jsonschema/doc_templates/md/content.md @@ -30,31 +30,30 @@ {% include "section_examples.md" %} {% endif %} +{# If this is a reference, do not expand inline #} {% if schema.should_be_a_link(config) %} + {# Only show the canonical link, not inline details #} {% elif schema.refers_to -%} - {# If it's referred to, we're linking to it, not including it here. #} - {%- with schema=schema.refers_to_merged, skip_headers=True, depth=depth -%} - {# include "content.md" #} - {% endwith %} + {# Only show the canonical link, not inline details #} {% else %} {# Properties, pattern properties, additional properties #} {% if schema.is_object %} - {{- schema | md_properties_table | md_generate_table -}} + {{- schema | md_properties_table | md_generate_table -}} {% endif %} {# Combining: allOf, anyOf, oneOf, not #} {% if schema.kw_all_of %} - {% with operator="allOf", title="All of(Requirement)", current_node=schema.kw_all_of, skip_required=True %} + {% with operator="allOf", title="All of", current_node=schema.kw_all_of, skip_required=True %} {% include "tabbed_section.md" %} {% endwith %} {% endif %} {% if schema.kw_any_of %} - {% with operator="anyOf", title="Any of(Option)", current_node=schema.kw_any_of, skip_required=True %} + {% with operator="anyOf", title="Any of", current_node=schema.kw_any_of, skip_required=True %} {% include "tabbed_section.md" %} {% endwith %} {% endif %} {% if schema.kw_one_of %} - {% with operator="oneOf", title="One of(Option)",current_node=schema.kw_one_of, skip_required=True %} + {% with operator="oneOf", title="One of", current_node=schema.kw_one_of, skip_required=True %} {% include "tabbed_section.md" %} {% endwith %} {% endif %} @@ -90,6 +89,12 @@ {# details of Properties, pattern properties, additional properties #} {% if schema.is_object %} - {% include "section_properties_details.md" %} + {% include "section_properties_details.md" %} {% endif %} {% endif %} + +{# Placeholder for See Also section for main classes #} +{% if schema.title in ["Catalog", "Dataset", "Dataset Series", "Distribution"] %} +--- +**See Also:** (related supporting classes) +{% endif %} diff --git a/jsonschema/doc_templates/md/section_array.md b/jsonschema/doc_templates/md/section_array.md index 60f2bddb..37a77ebb 100644 --- a/jsonschema/doc_templates/md/section_array.md +++ b/jsonschema/doc_templates/md/section_array.md @@ -1,42 +1,50 @@ + {{ schema | md_array_restrictions | md_generate_table }} +{# Only show array items table; suppress inline details if canonical link exists #} {% if schema.array_items_def or schema.tuple_validation_items %} {{ schema | md_array_items_restrictions | md_generate_table }} {% endif %} +{# Only expand inline details for array items if not a reference/canonical link #} {% if schema.array_items_def %} -{% set is_linked_array_item = schema.array_items_def.should_be_a_link(config) or schema.array_items_def.refers_to %} -{% if not is_linked_array_item %} -{% filter md_heading(depth+1, schema.array_items_def.html_id) %} -{% with schema=schema.array_items_def %}{%- include "breadcrumbs.md" %}{% endwith %} -{% endfilter %} -{% with schema=schema.array_items_def, skip_headers=False, depth=depth+1, skip_required=True %} - {% include "content.md" %} -{% endwith %} -{% endif %} + {% set is_linked_array_item = schema.array_items_def.should_be_a_link(config) or schema.array_items_def.refers_to %} + {% if not is_linked_array_item %} + {% filter md_heading(depth+1, schema.array_items_def.html_id) %} + {{ schema.array_items_def.title or 'Array Item' }} + {% endfilter %} + {% with schema=schema.array_items_def, skip_headers=False, depth=depth+1, skip_required=True %} + {% include "content.md" %} + {% endwith %} + {% endif %} {% endif %} +{# Tuple validation items: only expand if not a reference #} {% if schema.tuple_validation_items %} -{% for item in schema.tuple_validation_items %} - {% filter md_heading(depth+1) %} - {% with schema=item %}{%- include "breadcrumbs.md" %}{% endwith %} - {% endfilter %} - {% with schema=item, skip_headers=False, depth=depth+1, skip_required=True %} - {% include "content.md" %} - {% endwith %} -{% endfor %} + {% for item in schema.tuple_validation_items %} + {% set is_linked_tuple_item = item.should_be_a_link(config) or item.refers_to %} + {% if not is_linked_tuple_item %} + {% filter md_heading(depth+1) %} + {{ item.title or 'Tuple Item' }} + {% endfilter %} + {% with schema=item, skip_headers=False, depth=depth+1, skip_required=True %} + {% include "content.md" %} + {% endwith %} + {% endif %} + {% endfor %} {% endif %} +{# Contains/Additional items unchanged for now #} {% if schema.kw_contains and schema.kw_contains.literal != {} %} -{{ "At least one of the items must be" | md_heading(depth+1) }} -{% with schema=schema.kw_contains, skip_headers=False, depth=depth+1, skip_required=True %} - {% include "content.md" %} -{% endwith %} + {{ "At least one of the items must be" | md_heading(depth+1) }} + {% with schema=schema.kw_contains, skip_headers=False, depth=depth+1, skip_required=True %} + {% include "content.md" %} + {% endwith %} {% endif %} {% if schema.array_additional_items_def %} -{{ "Additional items must be" | md_heading(depth+1) }} -{% with schema=schema.array_additional_items_def, skip_headers=False, depth=depth+1, skip_required=True %} - {% include "content.md" %} -{% endwith %} + {{ "Additional items must be" | md_heading(depth+1) }} + {% with schema=schema.array_additional_items_def, skip_headers=False, depth=depth+1, skip_required=True %} + {% include "content.md" %} + {% endwith %} {% endif %} diff --git a/jsonschema/doc_templates/md/section_examples.md b/jsonschema/doc_templates/md/section_examples.md index 206602a7..3c1e024b 100644 --- a/jsonschema/doc_templates/md/section_examples.md +++ b/jsonschema/doc_templates/md/section_examples.md @@ -1,16 +1,16 @@ **Example{% if examples|length > 1 %}s{% endif %}:**{{- "" -}} {% for example in examples %} - {%- if loop.first %}{{ "\n\n" }}{% endif -%} - {% set example_id = schema.html_id ~ "_ex" ~ loop.index %} - {%- if not examples_as_yaml -%} - {{- "" }}```json - {{- "\n" }}{{ example }} - {{- "\n" }}``` - {%- else -%} - {{- "" }}```yaml - {{- "\n" }}{{ example | yaml_example }} - {{- "\n" }}``` - {%- endif -%} - {{ "\n" }} + {%- if loop.first %}{{ "\n\n" }}{% endif -%} + {% set example_id = schema.html_id ~ "_ex" ~ loop.index %} + {%- if not examples_as_yaml -%} + {{- "" }}```json + {{- "\n" }}{{ example }} + {{- "\n" }}``` + {%- else -%} + {{- "" }}```yaml + {{- "\n" }}{{ example | yaml_example }} + {{- "\n" }}``` + {%- endif -%} + {{ "\n" }} {% endfor %} diff --git a/jsonschema/doc_templates/md/section_one_of.md b/jsonschema/doc_templates/md/section_one_of.md index a7c1ad27..cd86cb63 100644 --- a/jsonschema/doc_templates/md/section_one_of.md +++ b/jsonschema/doc_templates/md/section_one_of.md @@ -1,4 +1,13 @@ Must be one of: {% for enum_choice in schema.kw_enum.array_items %} * {{ enum_choice.literal | python_to_json }} -{% endfor %} \ No newline at end of file +{% endfor %} + +{# If there are subschemas with details, show them compactly #} +{% if schema.kw_one_of or schema.kw_any_of %} + {% for subschema in (schema.kw_one_of or schema.kw_any_of) %} + {% if subschema.title or subschema.description %} + - **{{ subschema.title or 'Option' }}**: {{ subschema.description or '' }} + {% endif %} + {% endfor %} +{% endif %} \ No newline at end of file diff --git a/jsonschema/doc_templates/md/section_properties_details.md b/jsonschema/doc_templates/md/section_properties_details.md index 7dbae033..0da4c5f7 100644 --- a/jsonschema/doc_templates/md/section_properties_details.md +++ b/jsonschema/doc_templates/md/section_properties_details.md @@ -4,18 +4,13 @@ {% endif %} {% set html_id = sub_property.html_id %} - {% set description = sub_property | get_description %} + {# Keep property headings minimal; requirement appears in the body below. #} {% filter md_heading(depth + 1, html_id) -%} - {%- filter replace('\n', '') -%} - {%- if not skip_required and sub_property.property_name -%} - {{ sub_property | requirement_badge -}}{{ ' ' }} - {%- endif -%} - {%- if sub_property is deprecated -%}~~ {%- endif -%} - {%- if sub_property.is_pattern_property %}Pattern {% endif %}Property `{% with schema=sub_property %}{%- include "breadcrumbs.md" %}{% endwith %}` - {%- if sub_property is deprecated -%}~~{%- endif -%} - {%- endfilter %} + {%- if sub_property is deprecated -%}~~ {%- endif -%} + `{% with schema=sub_property %}{%- include "breadcrumbs.md" %}{% endwith %}` + {%- if sub_property is deprecated -%}~~{%- endif -%} {%- endfilter %} {% if sub_property.is_pattern_property %} @@ -24,7 +19,6 @@ must respect the following conditions {% endif %} - {% with schema=sub_property, skip_headers=False, depth=depth+1 %} {% include "content.md" %} {% endwith %} diff --git a/jsonschema/doc_templates/md/tabbed_section.md b/jsonschema/doc_templates/md/tabbed_section.md index 3f43eb4e..17cb29b3 100644 --- a/jsonschema/doc_templates/md/tabbed_section.md +++ b/jsonschema/doc_templates/md/tabbed_section.md @@ -3,7 +3,7 @@ {% for node in current_node.array_items %} {% filter md_heading(depth+1, node.html_id) -%} - {% if node.is_pattern_property %}Pattern{% endif %} Property `{% with schema=node %}{%- include "breadcrumbs.md" %}{% endwith %}` + {% if node.is_pattern_property %}Pattern {% endif %}`{% with schema=node %}{%- include "breadcrumbs.md" %}{% endwith %}` {%- endfilter %} {% with schema=node, skip_headers=False, depth=depth+1 %} {% include "content.md" %} diff --git a/jsonschema/docs/agents.md b/jsonschema/docs/agents.md index 447ca59e..15dcb2c4 100644 --- a/jsonschema/docs/agents.md +++ b/jsonschema/docs/agents.md @@ -4,7 +4,7 @@ Data information classes including Agent, Organization, and Kind, which describe -## Agent +## Class Agent **Title:** Agent @@ -33,7 +33,7 @@ A person, organization, software agent, or other entity involved with a resource | - [category](#agent--category) | null or array | category | | + [name](#agent--name) | string | name | -## [Optional] Property `Agent > @id` +## `Agent > @id` **Requirement:** Optional @@ -47,7 +47,7 @@ A person, organization, software agent, or other entity involved with a resource "https://example.gov/agents/data-steward-001" ``` -## [Optional] Property `Agent > @type` +## `Agent > @type` **Requirement:** Optional @@ -55,7 +55,7 @@ A person, organization, software agent, or other entity involved with a resource | ----------- | --------- | | **Default** | `"Agent"` | -## [Optional] Property `Agent > category` +## `Agent > category` **Title:** category @@ -70,7 +70,7 @@ The type of the agent that makes the item available | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `Agent > name` +## `Agent > name` **Title:** name @@ -96,7 +96,7 @@ The name of the agent -## Organization +## Class Organization **Title:** Organization @@ -147,7 +147,7 @@ An organization involved with a resource, including parent or child organization | - [notation](#organization--notation) | null or array of string | notation | | - [prefLabel](#organization--prefLabel) | null or string | preferred label | -## [Optional] Property `Organization > @id` +## `Organization > @id` **Requirement:** Optional @@ -161,7 +161,7 @@ An organization involved with a resource, including parent or child organization "https://example.gov/organizations/census-bureau" ``` -## [Optional] Property `Organization > @type` +## `Organization > @type` **Requirement:** Optional @@ -169,7 +169,7 @@ An organization involved with a resource, including parent or child organization | ----------- | ---------------- | | **Default** | `"Organization"` | -## [Optional] Property `Organization > name` +## `Organization > name` **Title:** name @@ -191,7 +191,7 @@ The full name of the Organization "U.S. Census Bureau" ``` -## [Optional] Property `Organization > subOrganizationOf` +## `Organization > subOrganizationOf` **Title:** suborganization of @@ -206,7 +206,7 @@ Represents hierarchical containment of Organizations or OrganizationalUnits; ind | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## [Optional] Property `Organization > altLabel` +## `Organization > altLabel` **Title:** alternative label @@ -227,7 +227,7 @@ alternative name (trading name, colloquial name) for an organization "Census Bureau" ``` -## [Optional] Property `Organization > notation` +## `Organization > notation` **Title:** notation @@ -251,14 +251,14 @@ List of abbreviations or codes from code lists for an organization (e.g. DOI, DO | ------------------------------- | ----------- | | [Abbreviation](#organization--notation_items) | - | -### Organization > notation > Abbreviation +### Abbreviation **Title:** Abbreviation | **Type** | `string` | | -------- | -------- | -## [Optional] Property `Organization > prefLabel` +## `Organization > prefLabel` **Title:** preferred label @@ -279,7 +279,7 @@ Preferred or legal name of the organization -## Kind +## Class Kind **Title:** Kind @@ -322,7 +322,7 @@ Contact information for an individual or entity | - [tel](#kind--tel) | null or string | telephone | | - [title](#kind--title) | null or string | position title | -## [Optional] Property `Kind > @id` +## `Kind > @id` **Requirement:** Optional @@ -336,7 +336,7 @@ Contact information for an individual or entity "https://example.gov/contacts/climate-support-001" ``` -## [Optional] Property `Kind > @type` +## `Kind > @type` **Requirement:** Optional @@ -344,7 +344,7 @@ Contact information for an individual or entity | ----------- | -------- | | **Default** | `"Kind"` | -## [Optional] Property `Kind > address` +## `Kind > address` **Title:** address @@ -359,7 +359,7 @@ The address of the contact | ------------------------------------------------ | ------------------------- | | [Address](./temporal-spatial-metrics.md#address) | A single physical address | -## [Optional] Property `Kind > hasEmail` +## `Kind > hasEmail` **Title:** Email @@ -385,7 +385,7 @@ Email address for the contact in mailto: format (for example, mailto:support@exa | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^mailto:[\w\_\~\!\$\&\'\(\)\*\+\,\;\=\:.-]+@[\w.-]+\.[\w.-]+?$``` [Test](https://regex101.com/?regex=%5Emailto%3A%5B%5Cw%5C_%5C~%5C%21%5C%24%5C%26%5C%27%5C%28%5C%29%5C%2A%5C%2B%5C%2C%5C%3B%5C%3D%5C%3A.-%5D%2B%40%5B%5Cw.-%5D%2B%5C.%5B%5Cw.-%5D%2B%3F%24&testString=%22mailto%3Aclimate-support%40example.gov%22) | -## [Optional] Property `Kind > family-name` +## `Kind > family-name` **Title:** family name @@ -402,7 +402,7 @@ The family name of the contact "Smith" ``` -## [Optional] Property `Kind > fn` +## `Kind > fn` **Title:** formatted name @@ -424,7 +424,7 @@ The formatted text of the name of the contact "Dr. Jane Smith" ``` -## [Optional] Property `Kind > given-name` +## `Kind > given-name` **Title:** given name @@ -441,7 +441,7 @@ The given name of the contact "Jane" ``` -## [Optional] Property `Kind > organization-name` +## `Kind > organization-name` **Title:** organization name @@ -458,7 +458,7 @@ The name of the organization to contact "National Climate Data Center" ``` -## [Optional] Property `Kind > tel` +## `Kind > tel` **Title:** telephone @@ -475,7 +475,7 @@ The telephone number for the contact "+1-555-123-4567" ``` -## [Optional] Property `Kind > title` +## `Kind > title` **Title:** position title diff --git a/jsonschema/docs/catalog.md b/jsonschema/docs/catalog.md index 644c022d..62f98c41 100644 --- a/jsonschema/docs/catalog.md +++ b/jsonschema/docs/catalog.md @@ -103,7 +103,7 @@ A curated collection of metadata about datasets, data services, or other resourc | - [homepage](#homepage) | More than one type | homepage | | - [qualifiedAttribution](#qualifiedAttribution) | null or array | qualified attribution | -## [Optional] Property `DCAT-US 3 Catalog > @id` +## `DCAT-US 3 Catalog > @id` **Requirement:** Optional @@ -117,7 +117,7 @@ A curated collection of metadata about datasets, data services, or other resourc "https://example.gov/catalogs/federal-data-catalog" ``` -## [Optional] Property `DCAT-US 3 Catalog > @type` +## `DCAT-US 3 Catalog > @type` **Requirement:** Optional @@ -125,7 +125,7 @@ A curated collection of metadata about datasets, data services, or other resourc | ----------- | ----------- | | **Default** | `"Catalog"` | -## [Optional] Property `DCAT-US 3 Catalog > catalog` +## `DCAT-US 3 Catalog > catalog` **Title:** Related catalogs @@ -140,7 +140,7 @@ List of related catalogs that are useful in the context of this catalog | ----------------------------------- | ---------------------------------------------------------------------------------- | | [DCAT-US 3 Catalog](#catalog_items) | A curated collection of metadata about datasets, data services, or other resources | -## [Optional] Property `DCAT-US 3 Catalog > contactPoint` +## `DCAT-US 3 Catalog > contactPoint` **Title:** Contact points @@ -155,7 +155,7 @@ Contact information people can use to ask questions or send feedback about the c | ------------------------------- | ----------------------------------------------- | | [Kind](./agents.md#kind) | Contact information for an individual or entity | -## [Optional] Property `DCAT-US 3 Catalog > dataset` +## `DCAT-US 3 Catalog > dataset` **Title:** dataset @@ -171,7 +171,7 @@ List of datasets included in the catalog. Use this together with service so the | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## [Optional] Property `DCAT-US 3 Catalog > keyword` +## `DCAT-US 3 Catalog > keyword` **Title:** keyword/tag @@ -197,7 +197,7 @@ List of keywords or tags describing the catalog | ------------------------------- | ----------- | | [keyword items](#keyword_items) | - | -### DCAT-US 3 Catalog > keyword > keyword items +### Array Item | **Type** | `string` | | -------- | -------- | @@ -206,7 +206,7 @@ List of keywords or tags describing the catalog | -------------- | - | | **Min length** | 1 | -## [Optional] Property `DCAT-US 3 Catalog > record` +## `DCAT-US 3 Catalog > record` **Title:** catalog record @@ -221,7 +221,7 @@ A catalog record describing how a single resource (such as a dataset or data ser | ------------------------------------------------------- | ----------------------------------------------------------------------- | | [CatalogRecord](./quality-governance.md#catalog-record) | A record in a catalog, describing the registration of a single resource | -## [Optional] Property `DCAT-US 3 Catalog > service` +## `DCAT-US 3 Catalog > service` **Title:** service @@ -236,7 +236,7 @@ List of data services included in the catalog. Use this together with dataset so | --------------------------------------------------- | ------------------------------------------------------------------- | | [DataService](./quality-governance.md#data-service) | A service that provides access to data or data processing functions | -## [Optional] Property `DCAT-US 3 Catalog > theme` +## `DCAT-US 3 Catalog > theme` **Title:** theme/category @@ -251,7 +251,7 @@ List of themes or categories for the catalog. A catalog can have more than one t | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `DCAT-US 3 Catalog > themeTaxonomy` +## `DCAT-US 3 Catalog > themeTaxonomy` **Title:** themes @@ -266,7 +266,7 @@ Controlled vocabulary or taxonomy used to classify catalog resources, such as da | ------------------------------------------------------------------ | --------------------------------------------------------------------- | | [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) | A controlled vocabulary or other list of approved terms for a concept | -## [Optional] Property `DCAT-US 3 Catalog > accessRights` +## `DCAT-US 3 Catalog > accessRights` **Title:** access rights @@ -284,26 +284,26 @@ Information about whether the catalog is publicly accessible, restricted, or not "Public access with no restrictions" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------------- | | [Null allowed when not required](#accessRights_anyOf_i0) | | [item 1](#accessRights_anyOf_i1) | -### Property `DCAT-US 3 Catalog > accessRights > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > accessRights > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DCAT-US 3 Catalog > accessRights > anyOf > item 1` +### `DCAT-US 3 Catalog > accessRights > anyOf > item 1` Text description of the access rights | **Type** | `string` | | -------- | -------- | -## [Optional] Property `DCAT-US 3 Catalog > conformsTo` +## `DCAT-US 3 Catalog > conformsTo` **Title:** schema version @@ -315,19 +315,19 @@ Standard, schema, profile, or model that this catalog follows | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------ | | [Null allowed when not required](#conformsTo_anyOf_i0) | | [Standard](#conformsTo_anyOf_i1) | -### Property `DCAT-US 3 Catalog > conformsTo > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > conformsTo > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DCAT-US 3 Catalog > conformsTo > anyOf > Standard` +### `DCAT-US 3 Catalog > conformsTo > anyOf > Standard` **Title:** Standard @@ -338,7 +338,7 @@ A standard or specification that another resource conforms to | **Additional properties** | Any type allowed | | **Same definition as** | [Standard](./quality-governance.md#standard) | -## [Optional] Property `DCAT-US 3 Catalog > creator` +## `DCAT-US 3 Catalog > creator` **Title:** creator @@ -353,7 +353,7 @@ Person or organization responsible for creating the catalog metadata | ------------------------------- | -------------------------------------------------------------------------------- | | [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | -## [Optional] Property `DCAT-US 3 Catalog > description` +## `DCAT-US 3 Catalog > description` **Title:** description @@ -374,7 +374,7 @@ Plain-language summary of the catalog "A comprehensive catalog of federal government data assets spanning multiple agencies and data domains." ``` -## [Optional] Property `DCAT-US 3 Catalog > hasPart` +## `DCAT-US 3 Catalog > hasPart` **Title:** has part @@ -389,7 +389,7 @@ List of catalogs that are contained within this catalog | ----------------------------------- | ---------------------------------------------------------------------------------- | | [DCAT-US 3 Catalog](#hasPart_items) | A curated collection of metadata about datasets, data services, or other resources | -## [Optional] Property `DCAT-US 3 Catalog > identifier` +## `DCAT-US 3 Catalog > identifier` **Title:** identifier @@ -401,19 +401,19 @@ Main unique identifier for the catalog, such as a URI or another persistent iden | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------ | | [Null allowed when not required](#identifier_anyOf_i0) | | [Identifier](#identifier_anyOf_i1) | -### Property `DCAT-US 3 Catalog > identifier > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > identifier > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DCAT-US 3 Catalog > identifier > anyOf > Identifier` +### `DCAT-US 3 Catalog > identifier > anyOf > Identifier` **Title:** Identifier @@ -424,7 +424,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | -## [Optional] Property `DCAT-US 3 Catalog > otherIdentifier` +## `DCAT-US 3 Catalog > otherIdentifier` **Title:** other identifier @@ -439,7 +439,7 @@ A list of identifiers for the Catalog besides the main identifier, e.g. the URI | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## [Optional] Property `DCAT-US 3 Catalog > issued` +## `DCAT-US 3 Catalog > issued` **Title:** release date @@ -469,19 +469,19 @@ Date when the catalog was formally issued, such as its initial publication date "2024-01" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------- | | [Null allowed when not required](#issued_anyOf_i0) | | [Date string](#issued_anyOf_i1) | -### Property `DCAT-US 3 Catalog > issued > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > issued > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DCAT-US 3 Catalog > issued > anyOf > Date string` +### `DCAT-US 3 Catalog > issued > anyOf > Date string` **Title:** Date string @@ -489,26 +489,26 @@ Date when the catalog was formally issued, such as its initial publication date | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------- | | [item 0](#issued_anyOf_i1_anyOf_i0) | | [item 1](#issued_anyOf_i1_anyOf_i1) | | [item 2](#issued_anyOf_i1_anyOf_i2) | | [item 3](#issued_anyOf_i1_anyOf_i3) | -#### Property `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 0` +#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 1` +#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 2` +#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -519,7 +519,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 3` +#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -530,7 +530,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `DCAT-US 3 Catalog > language` +## `DCAT-US 3 Catalog > language` **Title:** language @@ -557,20 +557,20 @@ Language codes used for catalog metadata text (such as titles and descriptions), ] ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#language_anyOf_i0) | | [Language code](#language_anyOf_i1) | | [List of language codes](#language_anyOf_i2) | -### Property `DCAT-US 3 Catalog > language > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > language > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DCAT-US 3 Catalog > language > anyOf > Language code` +### `DCAT-US 3 Catalog > language > anyOf > Language code` **Title:** Language code @@ -581,7 +581,7 @@ Language codes used for catalog metadata text (such as titles and descriptions), | -------------- | - | | **Max length** | 2 | -### Property `DCAT-US 3 Catalog > language > anyOf > List of language codes` +### `DCAT-US 3 Catalog > language > anyOf > List of language codes` **Title:** List of language codes @@ -592,7 +592,7 @@ Language codes used for catalog metadata text (such as titles and descriptions), | ----------------------------------------- | ----------- | | [Language code](#language_anyOf_i2_items) | - | -#### DCAT-US 3 Catalog > language > anyOf > List of language codes > Language code +#### Language code **Title:** Language code @@ -603,7 +603,7 @@ Language codes used for catalog metadata text (such as titles and descriptions), | -------------- | - | | **Max length** | 2 | -## [Optional] Property `DCAT-US 3 Catalog > license` +## `DCAT-US 3 Catalog > license` **Title:** license @@ -621,26 +621,26 @@ License that governs how the catalog can be used or reused "https://creativecommons.org/publicdomain/zero/1.0/" ``` -| Any of(Option) | +| Any of | | --------------------------------------------------- | | [Null allowed when not required](#license_anyOf_i0) | | [item 1](#license_anyOf_i1) | -### Property `DCAT-US 3 Catalog > license > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > license > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DCAT-US 3 Catalog > license > anyOf > item 1` +### `DCAT-US 3 Catalog > license > anyOf > item 1` Full text of the license | **Type** | `string` | | -------- | -------- | -## [Optional] Property `DCAT-US 3 Catalog > modified` +## `DCAT-US 3 Catalog > modified` **Title:** update/modification date @@ -670,19 +670,19 @@ Most recent date when the catalog content changed, not just catalog-record metad "2024-01" ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#modified_anyOf_i0) | | [Date string](#modified_anyOf_i1) | -### Property `DCAT-US 3 Catalog > modified > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > modified > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DCAT-US 3 Catalog > modified > anyOf > Date string` +### `DCAT-US 3 Catalog > modified > anyOf > Date string` **Title:** Date string @@ -690,26 +690,26 @@ Most recent date when the catalog content changed, not just catalog-record metad | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------- | | [item 0](#modified_anyOf_i1_anyOf_i0) | | [item 1](#modified_anyOf_i1_anyOf_i1) | | [item 2](#modified_anyOf_i1_anyOf_i2) | | [item 3](#modified_anyOf_i1_anyOf_i3) | -#### Property `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 0` +#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 1` +#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 2` +#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -720,7 +720,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 3` +#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -731,7 +731,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `DCAT-US 3 Catalog > publisher` +## `DCAT-US 3 Catalog > publisher` **Title:** publisher @@ -743,19 +743,19 @@ Person or organization responsible for publishing and making the catalog availab | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------------------------- | | [Null allowed when not required](#publisher_anyOf_i0) | | [Agent](#publisher_anyOf_i1) | -### Property `DCAT-US 3 Catalog > publisher > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > publisher > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DCAT-US 3 Catalog > publisher > anyOf > Agent` +### `DCAT-US 3 Catalog > publisher > anyOf > Agent` **Title:** Agent @@ -766,7 +766,7 @@ inline description of the publisher | **Additional properties** | Any type allowed | | **Same definition as** | [Agent](./agents.md#agent) | -## [Optional] Property `DCAT-US 3 Catalog > rights` +## `DCAT-US 3 Catalog > rights` **Title:** rights @@ -796,14 +796,14 @@ Rights statements about the catalog that are not already covered by license or a | ------------------------------- | ---------------------------------- | | [rights items](#rights_items) | Full text of a statement of rights | -### DCAT-US 3 Catalog > rights > rights items +### Array Item Full text of a statement of rights | **Type** | `string` | | -------- | -------- | -## [Optional] Property `DCAT-US 3 Catalog > rightsHolder` +## `DCAT-US 3 Catalog > rightsHolder` **Title:** rights holder @@ -818,7 +818,7 @@ Organizations that hold rights in the catalog | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## [Optional] Property `DCAT-US 3 Catalog > spatial` +## `DCAT-US 3 Catalog > spatial` **Title:** spatial/geographic coverage @@ -833,7 +833,7 @@ Geographic area covered by the catalog | -------------------------------------------------- | -------------------------------- | | [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | -## [Optional] Property `DCAT-US 3 Catalog > subject` +## `DCAT-US 3 Catalog > subject` **Title:** subject @@ -848,7 +848,7 @@ List of subjects of the catalog | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `DCAT-US 3 Catalog > temporal` +## `DCAT-US 3 Catalog > temporal` **Title:** temporal coverage @@ -863,7 +863,7 @@ Time periods covered by the catalog | ------------------------------------------------------------ | ---------------------------------------------------------------------- | | [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | -## [Optional] Property `DCAT-US 3 Catalog > title` +## `DCAT-US 3 Catalog > title` **Title:** title @@ -884,7 +884,7 @@ Human-readable title of the catalog "Federal Data Catalog" ``` -## [Optional] Property `DCAT-US 3 Catalog > category` +## `DCAT-US 3 Catalog > category` **Title:** category @@ -899,7 +899,7 @@ List of high-level categories for the catalog | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `DCAT-US 3 Catalog > homepage` +## `DCAT-US 3 Catalog > homepage` **Title:** homepage @@ -911,19 +911,19 @@ Main public web page for the catalog, usually an HTML page | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#homepage_anyOf_i0) | | [Document](#homepage_anyOf_i1) | -### Property `DCAT-US 3 Catalog > homepage > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > homepage > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DCAT-US 3 Catalog > homepage > anyOf > Document` +### `DCAT-US 3 Catalog > homepage > anyOf > Document` **Title:** Document @@ -934,7 +934,7 @@ inline description of the home page | **Additional properties** | Any type allowed | | **Same definition as** | [Document](./quality-governance.md#document) | -## [Optional] Property `DCAT-US 3 Catalog > qualifiedAttribution` +## `DCAT-US 3 Catalog > qualifiedAttribution` **Title:** qualified attribution diff --git a/jsonschema/docs/constraints-and-restrictions.md b/jsonschema/docs/constraints-and-restrictions.md index ddb18c15..1e084aa5 100644 --- a/jsonschema/docs/constraints-and-restrictions.md +++ b/jsonschema/docs/constraints-and-restrictions.md @@ -4,7 +4,7 @@ Restriction classes describing access limits, controlled unclassified informatio -## AccessRestriction +## Class AccessRestriction **Title:** AccessRestriction @@ -33,7 +33,7 @@ Rules or indicators that describe who can access a resource | + [restrictionStatus](#access-restriction--restrictionStatus) | object | restriction status | | - [specificRestriction](#access-restriction--specificRestriction) | More than one type | specific restriction | -## [Optional] Property `AccessRestriction > @id` +## `AccessRestriction > @id` **Requirement:** Optional @@ -41,7 +41,7 @@ Rules or indicators that describe who can access a resource | ---------- | -------- | | **Format** | `iri` | -## [Optional] Property `AccessRestriction > @type` +## `AccessRestriction > @type` **Requirement:** Optional @@ -49,7 +49,7 @@ Rules or indicators that describe who can access a resource | ----------- | --------------------- | | **Default** | `"AccessRestriction"` | -## [Optional] Property `AccessRestriction > restrictionNote` +## `AccessRestriction > restrictionNote` **Title:** restriction note @@ -66,7 +66,7 @@ A note related to the access restriction "Access restricted to authorized personnel only." ``` -## [Optional] Property `AccessRestriction > restrictionStatus` +## `AccessRestriction > restrictionStatus` **Title:** restriction status @@ -90,7 +90,7 @@ The indication of whether or not there are access restrictions on the item, cons "Unrestricted" ``` -## [Optional] Property `AccessRestriction > specificRestriction` +## `AccessRestriction > specificRestriction` **Title:** specific restriction @@ -112,19 +112,19 @@ Authority, code list entry, or policy reference that defines the specific access "PRMPA - National Security Classified (B)" ``` -| Any of(Option) | +| Any of | | --------------------------------------------------------------- | | [Null allowed when not required](#access-restriction--specificRestriction_anyOf_i0) | | [Concept](#access-restriction--specificRestriction_anyOf_i1) | -### Property `AccessRestriction > specificRestriction > anyOf > Null allowed when not required` +### `AccessRestriction > specificRestriction > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `AccessRestriction > specificRestriction > anyOf > Concept` +### `AccessRestriction > specificRestriction > anyOf > Concept` **Title:** Concept @@ -139,7 +139,7 @@ inline description of the specific restriction -## CUIRestriction +## Class CUIRestriction **Title:** CUIRestriction @@ -167,7 +167,7 @@ Information describing Controlled Unclassified Information (CUI) restrictions fo | + [designationIndicator](#cui-restriction--designationIndicator) | string | CUI designation indicator | | - [requiredIndicatorPerAuthority](#cui-restriction--requiredIndicatorPerAuthority) | null or array of string | required indicator per authority | -## [Optional] Property `CUIRestriction > @id` +## `CUIRestriction > @id` **Requirement:** Optional @@ -181,7 +181,7 @@ Information describing Controlled Unclassified Information (CUI) restrictions fo "https://example.gov/cui-restrictions/dataset-001" ``` -## [Optional] Property `CUIRestriction > @type` +## `CUIRestriction > @type` **Requirement:** Optional @@ -189,7 +189,7 @@ Information describing Controlled Unclassified Information (CUI) restrictions fo | ----------- | ------------------ | | **Default** | `"CUIRestriction"` | -## [Optional] Property `CUIRestriction > cuiBannerMarking` +## `CUIRestriction > cuiBannerMarking` **Title:** CUI banner marking @@ -211,7 +211,7 @@ CUI (Controlled Unclassified Information) banner marking is required for any unc "CUI//SP-PRVCY//SP-LEGAL" ``` -## [Optional] Property `CUIRestriction > designationIndicator` +## `CUIRestriction > designationIndicator` **Title:** CUI designation indicator @@ -233,7 +233,7 @@ Agency that designated the information as CUI; include at least "Controlled by:" "Controlled by: DOC; POC: Jane Smith, mailto:jane.smith@example.gov, XXX-XXX-XXXX" ``` -## [Optional] Property `CUIRestriction > requiredIndicatorPerAuthority` +## `CUIRestriction > requiredIndicatorPerAuthority` **Title:** required indicator per authority @@ -257,7 +257,7 @@ List of free-text required indicators from the applicable authority (for example | -------------------------------------------------------- | ----------- | | [Indicator string](#cui-restriction--requiredIndicatorPerAuthority_items) | - | -### CUIRestriction > requiredIndicatorPerAuthority > Indicator string +### Indicator string **Title:** Indicator string @@ -268,7 +268,7 @@ List of free-text required indicators from the applicable authority (for example -## UseRestriction +## Class UseRestriction **Title:** UseRestriction @@ -297,7 +297,7 @@ Rules or legal limits on how a resource may be used | + [restrictionStatus](#use-restriction--restrictionStatus) | object | restriction status | | - [specificRestriction](#use-restriction--specificRestriction) | More than one type | specific restriction | -## [Optional] Property `UseRestriction > @id` +## `UseRestriction > @id` **Requirement:** Optional @@ -311,7 +311,7 @@ Rules or legal limits on how a resource may be used "https://example.gov/restrictions/use-restriction-001" ``` -## [Optional] Property `UseRestriction > @type` +## `UseRestriction > @type` **Requirement:** Optional @@ -319,7 +319,7 @@ Rules or legal limits on how a resource may be used | ----------- | ------------------ | | **Default** | `"UseRestriction"` | -## [Optional] Property `UseRestriction > restrictionNote` +## `UseRestriction > restrictionNote` **Title:** restriction note @@ -340,7 +340,7 @@ Significant information pertaining to the use or reproduction of the data "This data may be used for research purposes. Commercial use requires written permission from the data steward." ``` -## [Optional] Property `UseRestriction > restrictionStatus` +## `UseRestriction > restrictionStatus` **Title:** restriction status @@ -364,7 +364,7 @@ Indication of whether or not there are use restrictions on the archival material "Unrestricted" ``` -## [Optional] Property `UseRestriction > specificRestriction` +## `UseRestriction > specificRestriction` **Title:** specific restriction @@ -386,19 +386,19 @@ Authority, code list entry, or policy reference that defines the specific use re "Trademark" ``` -| Any of(Option) | +| Any of | | --------------------------------------------------------------- | | [Null allowed when not required](#use-restriction--specificRestriction_anyOf_i0) | | [Concept](#use-restriction--specificRestriction_anyOf_i1) | -### Property `UseRestriction > specificRestriction > anyOf > Null allowed when not required` +### `UseRestriction > specificRestriction > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `UseRestriction > specificRestriction > anyOf > Concept` +### `UseRestriction > specificRestriction > anyOf > Concept` **Title:** Concept diff --git a/jsonschema/docs/dataset-series.md b/jsonschema/docs/dataset-series.md index 0892c27f..f0b43dbb 100644 --- a/jsonschema/docs/dataset-series.md +++ b/jsonschema/docs/dataset-series.md @@ -160,7 +160,7 @@ A group of related datasets that are published separately | - [temporal](#temporal) | null or array | temporal coverage | | + [title](#title) | string | title | -## [Optional] Property `DatasetSeries > @id` +## `DatasetSeries > @id` **Requirement:** Optional @@ -174,7 +174,7 @@ A group of related datasets that are published separately "https://example.gov/series/annual-climate-observations" ``` -## [Optional] Property `DatasetSeries > @type` +## `DatasetSeries > @type` **Requirement:** Optional @@ -182,7 +182,7 @@ A group of related datasets that are published separately | ----------- | ----------------- | | **Default** | `"DatasetSeries"` | -## [Optional] Property `DatasetSeries > contactPoint` +## `DatasetSeries > contactPoint` **Title:** contact point @@ -197,7 +197,7 @@ List of contacts people can use to ask questions or send feedback about the data | ------------------------------- | ----------------------------------------------- | | [Kind](./agents.md#kind) | Contact information for an individual or entity | -## [Optional] Property `DatasetSeries > first` +## `DatasetSeries > first` **Title:** first @@ -209,19 +209,19 @@ The first dataset in an ordered dataset series | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------- | | [Null allowed when not required](#first_anyOf_i0) | | [Dataset](#first_anyOf_i1) | -### Property `DatasetSeries > first > anyOf > Null allowed when not required` +### `DatasetSeries > first > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DatasetSeries > first > anyOf > Dataset` +### `DatasetSeries > first > anyOf > Dataset` **Title:** Dataset @@ -232,7 +232,10 @@ inline description of the first dataset | **Additional properties** | Any type allowed | | **Defined in** | [Dataset](./dataset.md#root) | -## [Optional] Property `DatasetSeries > last` +--- +**See Also:** (related supporting classes) + +## `DatasetSeries > last` **Title:** last @@ -244,19 +247,19 @@ The last dataset in an ordered dataset series | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------ | | [Null allowed when not required](#last_anyOf_i0) | | [Dataset](#last_anyOf_i1) | -### Property `DatasetSeries > last > anyOf > Null allowed when not required` +### `DatasetSeries > last > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DatasetSeries > last > anyOf > Dataset` +### `DatasetSeries > last > anyOf > Dataset` **Title:** Dataset @@ -267,7 +270,10 @@ inline description of the last dataset | **Additional properties** | Any type allowed | | **Same definition as** | [Dataset](./dataset.md#root) | -## [Optional] Property `DatasetSeries > seriesMember` +--- +**See Also:** (related supporting classes) + +## `DatasetSeries > seriesMember` **Title:** series member @@ -282,7 +288,7 @@ List of members of the Dataset Series | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## [Optional] Property `DatasetSeries > accrualPeriodicity` +## `DatasetSeries > accrualPeriodicity` **Title:** frequency @@ -300,21 +306,21 @@ The frequency at which the Dataset Series is updated. This is the series update "annually" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------------------- | | [Null allowed when not required](#accrualPeriodicity_anyOf_i0) | | [item 1](#accrualPeriodicity_anyOf_i1) | | [item 2](#accrualPeriodicity_anyOf_i2) | | [item 3](#accrualPeriodicity_anyOf_i3) | -### Property `DatasetSeries > accrualPeriodicity > anyOf > Null allowed when not required` +### `DatasetSeries > accrualPeriodicity > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DatasetSeries > accrualPeriodicity > anyOf > item 1` +### `DatasetSeries > accrualPeriodicity > anyOf > item 1` ISO 19115 Maintenance Frequency code @@ -335,7 +341,7 @@ Must be one of: * "notPlanned" * "unknown" -### Property `DatasetSeries > accrualPeriodicity > anyOf > item 2` +### `DatasetSeries > accrualPeriodicity > anyOf > item 2` ISO-8601 Maintenance Frequency code for recurring values, see https://www.iso.org/standard/70907.html @@ -346,7 +352,7 @@ ISO-8601 Maintenance Frequency code for recurring values, see https://www.iso.or | --------------------------------- | ----------------------------------------------------------------- | | **Must match regular expression** | ```^R/P.+$``` [Test](https://regex101.com/?regex=%5ER%2FP.%2B%24) | -### Property `DatasetSeries > accrualPeriodicity > anyOf > item 3` +### `DatasetSeries > accrualPeriodicity > anyOf > item 3` Dublin Core Collection Frequency Vocabulary, see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/#vocabulary-terms @@ -372,7 +378,7 @@ Must be one of: * "semiweekly" * "threeTimesAWeek" -## [Optional] Property `DatasetSeries > description` +## `DatasetSeries > description` **Title:** description @@ -390,7 +396,7 @@ Plain-language summary of the dataset series "An annual series of comprehensive climate observation datasets collected from monitoring stations across the United States. Each dataset in the series covers one calendar year of daily observations." ``` -## [Optional] Property `DatasetSeries > issued` +## `DatasetSeries > issued` **Title:** release date @@ -420,19 +426,19 @@ Date when the Dataset Series was formally established or published, not the rele "2024-01" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------- | | [Null allowed when not required](#issued_anyOf_i0) | | [Date string](#issued_anyOf_i1) | -### Property `DatasetSeries > issued > anyOf > Null allowed when not required` +### `DatasetSeries > issued > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DatasetSeries > issued > anyOf > Date string` +### `DatasetSeries > issued > anyOf > Date string` **Title:** Date string @@ -440,26 +446,26 @@ Date when the Dataset Series was formally established or published, not the rele | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------- | | [item 0](#issued_anyOf_i1_anyOf_i0) | | [item 1](#issued_anyOf_i1_anyOf_i1) | | [item 2](#issued_anyOf_i1_anyOf_i2) | | [item 3](#issued_anyOf_i1_anyOf_i3) | -#### Property `DatasetSeries > issued > anyOf > Date string > anyOf > item 0` +#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `DatasetSeries > issued > anyOf > Date string > anyOf > item 1` +#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `DatasetSeries > issued > anyOf > Date string > anyOf > item 2` +#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -470,7 +476,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `DatasetSeries > issued > anyOf > Date string > anyOf > item 3` +#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -481,7 +487,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `DatasetSeries > modified` +## `DatasetSeries > modified` **Title:** update/modification date @@ -515,19 +521,19 @@ Most recent date when the Dataset Series changed, not the modified date of the n "2024-01" ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#modified_anyOf_i0) | | [Date string](#modified_anyOf_i1) | -### Property `DatasetSeries > modified > anyOf > Null allowed when not required` +### `DatasetSeries > modified > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DatasetSeries > modified > anyOf > Date string` +### `DatasetSeries > modified > anyOf > Date string` **Title:** Date string @@ -535,26 +541,26 @@ Most recent date when the Dataset Series changed, not the modified date of the n | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------- | | [item 0](#modified_anyOf_i1_anyOf_i0) | | [item 1](#modified_anyOf_i1_anyOf_i1) | | [item 2](#modified_anyOf_i1_anyOf_i2) | | [item 3](#modified_anyOf_i1_anyOf_i3) | -#### Property `DatasetSeries > modified > anyOf > Date string > anyOf > item 0` +#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `DatasetSeries > modified > anyOf > Date string > anyOf > item 1` +#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `DatasetSeries > modified > anyOf > Date string > anyOf > item 2` +#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -565,7 +571,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `DatasetSeries > modified > anyOf > Date string > anyOf > item 3` +#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -576,7 +582,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `DatasetSeries > publisher` +## `DatasetSeries > publisher` **Title:** publisher @@ -588,19 +594,19 @@ Organization responsible for maintaining the Dataset Series as a coherent series | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------------------------- | | [Null allowed when not required](#publisher_anyOf_i0) | | [Agent](#publisher_anyOf_i1) | -### Property `DatasetSeries > publisher > anyOf > Null allowed when not required` +### `DatasetSeries > publisher > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DatasetSeries > publisher > anyOf > Agent` +### `DatasetSeries > publisher > anyOf > Agent` **Title:** Agent @@ -611,7 +617,7 @@ inline description of publisher | **Additional properties** | Any type allowed | | **Same definition as** | [Agent](./agents.md#agent) | -## [Optional] Property `DatasetSeries > spatial` +## `DatasetSeries > spatial` **Title:** spatial/geographic coverage @@ -626,7 +632,7 @@ A geographic region that is covered by the Dataset Series | -------------------------------------------------- | -------------------------------- | | [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | -## [Optional] Property `DatasetSeries > temporal` +## `DatasetSeries > temporal` **Title:** temporal coverage @@ -641,7 +647,7 @@ Time periods covered by the dataset series | ------------------------------------------------------------ | ---------------------------------------------------------------------- | | [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | -## [Optional] Property `DatasetSeries > title` +## `DatasetSeries > title` **Title:** title diff --git a/jsonschema/docs/dataset.md b/jsonschema/docs/dataset.md index 4464fb1f..ef16673e 100644 --- a/jsonschema/docs/dataset.md +++ b/jsonschema/docs/dataset.md @@ -160,7 +160,7 @@ A collection of data published or curated by one provider | - [image](#image) | More than one type | image | | - [scopeNote](#scopeNote) | null or string | usage note | -## [Optional] Property `Dataset > @id` +## `Dataset > @id` **Requirement:** Optional @@ -174,7 +174,7 @@ A collection of data published or curated by one provider "https://example.gov/datasets/national-climate-observations-2024" ``` -## [Optional] Property `Dataset > @type` +## `Dataset > @type` **Requirement:** Optional @@ -182,7 +182,7 @@ A collection of data published or curated by one provider | ----------- | ----------- | | **Default** | `"Dataset"` | -## [Optional] Property `Dataset > otherIdentifier` +## `Dataset > otherIdentifier` **Title:** other identifier @@ -197,7 +197,7 @@ Additional identifiers for the dataset besides the main identifier, such as a DO | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## [Optional] Property `Dataset > sample` +## `Dataset > sample` **Title:** sample @@ -212,7 +212,7 @@ List of sample distributions for the dataset | -------------------------------------- | ----------------------------------------------------------------------------- | | [Distribution](./distribution.md#root) | A specific representation of a dataset, such as a file, feed, or API response | -## [Optional] Property `Dataset > status` +## `Dataset > status` **Title:** lifecycle status @@ -224,19 +224,19 @@ Lifecycle status of the dataset, such as completed, deprecated, under developmen | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | -------------------------------------------------- | | [Null allowed when not required](#status_anyOf_i0) | | [Concept](#status_anyOf_i1) | -### Property `Dataset > status > anyOf > Null allowed when not required` +### `Dataset > status > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > status > anyOf > Concept` +### `Dataset > status > anyOf > Concept` **Title:** Concept @@ -247,7 +247,7 @@ inline description of Concept | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | -## [Optional] Property `Dataset > supportedSchema` +## `Dataset > supportedSchema` **Title:** supported schema @@ -259,19 +259,19 @@ supported schema for this dataset | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------------------------------- | | [Null allowed when not required](#supportedSchema_anyOf_i0) | | [Dataset](#supportedSchema_anyOf_i1) | -### Property `Dataset > supportedSchema > anyOf > Null allowed when not required` +### `Dataset > supportedSchema > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > supportedSchema > anyOf > Dataset` +### `Dataset > supportedSchema > anyOf > Dataset` **Title:** Dataset @@ -282,7 +282,10 @@ inline description of the supported schema | **Additional properties** | Any type allowed | | **Same definition as** | [Dataset](./dataset.md#root) | -## [Optional] Property `Dataset > versionNotes` +--- +**See Also:** (related supporting classes) + +## `Dataset > versionNotes` **Title:** version notes @@ -299,7 +302,7 @@ Notes describing how this version differs from earlier versions of the dataset "Initial release of 2024 climate observations data." ``` -## [Optional] Property `Dataset > contactPoint` +## `Dataset > contactPoint` **Title:** contact point @@ -312,12 +315,12 @@ A contact point for questions about the Dataset (single contact or list). Includ | **Required** | Yes | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------ | | [Kind](#contactPoint_anyOf_i0) | | [List of contacts](#contactPoint_anyOf_i1) | -### Property `Dataset > contactPoint > anyOf > Kind` +### `Dataset > contactPoint > anyOf > Kind` **Title:** Kind @@ -328,7 +331,7 @@ inline description of Kind | **Additional properties** | Any type allowed | | **Same definition as** | [Kind](./agents.md#kind) | -### Property `Dataset > contactPoint > anyOf > List of contacts` +### `Dataset > contactPoint > anyOf > List of contacts` **Title:** List of contacts @@ -339,7 +342,7 @@ inline description of Kind | ------------------------------- | ----------------------------------------------- | | [Kind](./agents.md#kind) | Contact information for an individual or entity | -## [Optional] Property `Dataset > distribution` +## `Dataset > distribution` **Title:** dataset distribution @@ -354,7 +357,7 @@ List of available distributions for the dataset. This can be omitted when no dis | -------------------------------------- | ----------------------------------------------------------------------------- | | [Distribution](./distribution.md#root) | A specific representation of a dataset, such as a file, feed, or API response | -## [Optional] Property `Dataset > first` +## `Dataset > first` **Title:** first @@ -366,19 +369,19 @@ the first item of the sequence the dataset belongs to | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------- | | [Null allowed when not required](#first_anyOf_i0) | | [Dataset](#first_anyOf_i1) | -### Property `Dataset > first > anyOf > Null allowed when not required` +### `Dataset > first > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > first > anyOf > Dataset` +### `Dataset > first > anyOf > Dataset` **Title:** Dataset @@ -389,7 +392,10 @@ inline description of Dataset | **Additional properties** | Any type allowed | | **Same definition as** | [Dataset](./dataset.md#root) | -## [Optional] Property `Dataset > hasCurrentVersion` +--- +**See Also:** (related supporting classes) + +## `Dataset > hasCurrentVersion` **Title:** current version @@ -401,19 +407,19 @@ reference to the current (latest) version of a dataset | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------------- | | [Null allowed when not required](#hasCurrentVersion_anyOf_i0) | | [Dataset](#hasCurrentVersion_anyOf_i1) | -### Property `Dataset > hasCurrentVersion > anyOf > Null allowed when not required` +### `Dataset > hasCurrentVersion > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > hasCurrentVersion > anyOf > Dataset` +### `Dataset > hasCurrentVersion > anyOf > Dataset` **Title:** Dataset @@ -424,7 +430,10 @@ inline description of Dataset | **Additional properties** | Any type allowed | | **Same definition as** | [Dataset](./dataset.md#root) | -## [Optional] Property `Dataset > hasVersion` +--- +**See Also:** (related supporting classes) + +## `Dataset > hasVersion` **Title:** has version @@ -439,7 +448,7 @@ List of related Datasets that are a version, edition, or adaptation of the descr | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## [Optional] Property `Dataset > inSeries` +## `Dataset > inSeries` **Title:** in series @@ -454,7 +463,7 @@ Dataset series this dataset belongs to | ----------------------------------------- | --------------------------------------------------------- | | [DatasetSeries](./dataset-series.md#root) | A group of related datasets that are published separately | -## [Optional] Property `Dataset > keyword` +## `Dataset > keyword` **Title:** keyword/tag @@ -492,7 +501,7 @@ List of keywords or tags describing the dataset | ---------------------------------- | ----------- | | [Non-empty string](#keyword_items) | - | -### Dataset > keyword > Non-empty string +### Non-empty string **Title:** Non-empty string @@ -503,7 +512,7 @@ List of keywords or tags describing the dataset | -------------- | - | | **Min length** | 1 | -## [Optional] Property `Dataset > landingPage` +## `Dataset > landingPage` **Title:** landing page @@ -515,19 +524,19 @@ A web page from the original data provider that gives access to the Dataset, its | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------- | | [Null allowed when not required](#landingPage_anyOf_i0) | | [Document](#landingPage_anyOf_i1) | -### Property `Dataset > landingPage > anyOf > Null allowed when not required` +### `Dataset > landingPage > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > landingPage > anyOf > Document` +### `Dataset > landingPage > anyOf > Document` **Title:** Document @@ -538,7 +547,7 @@ inline description of Document | **Additional properties** | Any type allowed | | **Same definition as** | [Document](./quality-governance.md#document) | -## [Optional] Property `Dataset > previousVersion` +## `Dataset > previousVersion` **Title:** previous version @@ -550,19 +559,19 @@ reference to the previous dataset version | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------------------------------- | | [Null allowed when not required](#previousVersion_anyOf_i0) | | [Dataset](#previousVersion_anyOf_i1) | -### Property `Dataset > previousVersion > anyOf > Null allowed when not required` +### `Dataset > previousVersion > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > previousVersion > anyOf > Dataset` +### `Dataset > previousVersion > anyOf > Dataset` **Title:** Dataset @@ -573,7 +582,10 @@ inline description of Dataset | **Additional properties** | Any type allowed | | **Same definition as** | [Dataset](./dataset.md#root) | -## [Optional] Property `Dataset > qualifiedRelation` +--- +**See Also:** (related supporting classes) + +## `Dataset > qualifiedRelation` **Title:** qualified relation @@ -588,7 +600,7 @@ Detailed relationship between the dataset and another resource, including the ro | --------------------------------------------------------------- | ------------------------------------------------------------------- | | [Relationship](./identifiers-and-relationships.md#relationship) | Additional information about how one resource is related to another | -## [Optional] Property `Dataset > spatialResolutionInMeters` +## `Dataset > spatialResolutionInMeters` **Title:** Spatial resolution (meters) @@ -605,7 +617,7 @@ Smallest spatial distance between data points, in meters, represented as a singl "1000" ``` -## [Optional] Property `Dataset > temporalResolution` +## `Dataset > temporalResolution` **Title:** temporal resolution @@ -622,7 +634,7 @@ Smallest time interval between data points, using xsd:duration format (for examp "P1D" ``` -## [Optional] Property `Dataset > theme` +## `Dataset > theme` **Title:** theme/category @@ -637,7 +649,7 @@ List of themes or categories for the dataset | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `Dataset > version` +## `Dataset > version` **Title:** version @@ -654,7 +666,7 @@ The version indicator (name or identifier) of a resource "2024.1" ``` -## [Optional] Property `Dataset > describedBy` +## `Dataset > describedBy` **Title:** data dictionary @@ -666,19 +678,19 @@ A distribution describing the Data Dictionary for this dataset | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------- | | [Null allowed when not required](#describedBy_anyOf_i0) | | [Distribution](#describedBy_anyOf_i1) | -### Property `Dataset > describedBy > anyOf > Null allowed when not required` +### `Dataset > describedBy > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > describedBy > anyOf > Distribution` +### `Dataset > describedBy > anyOf > Distribution` **Title:** Distribution @@ -689,7 +701,10 @@ inline description of Distribution | **Additional properties** | Any type allowed | | **Same definition as** | [Distribution](./distribution.md#root) | -## [Optional] Property `Dataset > liabilityStatement` +--- +**See Also:** (related supporting classes) + +## `Dataset > liabilityStatement` **Title:** liability statement @@ -707,26 +722,26 @@ A liability statement about the dataset that may clarify limitations of responsi "This dataset is provided as-is without warranty of any kind. Users are responsible for determining fitness for their intended use." ``` -| Any of(Option) | +| Any of | | -------------------------------------------------------------- | | [Null allowed when not required](#liabilityStatement_anyOf_i0) | | [item 1](#liabilityStatement_anyOf_i1) | -### Property `Dataset > liabilityStatement > anyOf > Null allowed when not required` +### `Dataset > liabilityStatement > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > liabilityStatement > anyOf > item 1` +### `Dataset > liabilityStatement > anyOf > item 1` Full text of the liability statement | **Type** | `string` | | -------- | -------- | -## [Optional] Property `Dataset > metadataDistribution` +## `Dataset > metadataDistribution` **Title:** metadata distribution @@ -741,7 +756,7 @@ Distribution of the original metadata document this dataset was derived from | -------------------------------------- | ----------------------------------------------------------------------------- | | [Distribution](./distribution.md#root) | A specific representation of a dataset, such as a file, feed, or API response | -## [Optional] Property `Dataset > purpose` +## `Dataset > purpose` **Title:** purpose @@ -758,7 +773,7 @@ The purpose of the dataset "To provide comprehensive, high-quality climate observations for research, planning, and decision-making related to weather and climate." ``` -## [Optional] Property `Dataset > accessRights` +## `Dataset > accessRights` **Title:** access rights @@ -780,26 +795,26 @@ Information about whether the dataset is publicly accessible, restricted, or not "Public access with no restrictions. Data is freely available for download and use." ``` -| Any of(Option) | +| Any of | | -------------------------------------------------------- | | [Null allowed when not required](#accessRights_anyOf_i0) | | [item 1](#accessRights_anyOf_i1) | -### Property `Dataset > accessRights > anyOf > Null allowed when not required` +### `Dataset > accessRights > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > accessRights > anyOf > item 1` +### `Dataset > accessRights > anyOf > item 1` Text description of the access rights | **Type** | `string` | | -------- | -------- | -## [Optional] Property `Dataset > accrualPeriodicity` +## `Dataset > accrualPeriodicity` **Title:** frequency @@ -817,21 +832,21 @@ The frequency at which the Dataset is updated "daily" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------------------- | | [Null allowed when not required](#accrualPeriodicity_anyOf_i0) | | [item 1](#accrualPeriodicity_anyOf_i1) | | [item 2](#accrualPeriodicity_anyOf_i2) | | [item 3](#accrualPeriodicity_anyOf_i3) | -### Property `Dataset > accrualPeriodicity > anyOf > Null allowed when not required` +### `Dataset > accrualPeriodicity > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > accrualPeriodicity > anyOf > item 1` +### `Dataset > accrualPeriodicity > anyOf > item 1` ISO 19115 Maintenance Frequency code @@ -852,7 +867,7 @@ Must be one of: * "notPlanned" * "unknown" -### Property `Dataset > accrualPeriodicity > anyOf > item 2` +### `Dataset > accrualPeriodicity > anyOf > item 2` ISO-8601 Maintenance Frequency code for recurring values, see https://www.iso.org/standard/70907.html @@ -863,7 +878,7 @@ ISO-8601 Maintenance Frequency code for recurring values, see https://www.iso.or | --------------------------------- | ----------------------------------------------------------------- | | **Must match regular expression** | ```^R/P.+$``` [Test](https://regex101.com/?regex=%5ER%2FP.%2B%24) | -### Property `Dataset > accrualPeriodicity > anyOf > item 3` +### `Dataset > accrualPeriodicity > anyOf > item 3` Dublin Core Collection Frequency Vocabulary, see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/#vocabulary-terms @@ -889,7 +904,7 @@ Must be one of: * "semiweekly" * "threeTimesAWeek" -## [Optional] Property `Dataset > conformsTo` +## `Dataset > conformsTo` **Title:** conforms to @@ -904,7 +919,7 @@ List of standards, schemas, or profiles the dataset follows | -------------------------------------------- | ------------------------------------------------------------- | | [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | -## [Optional] Property `Dataset > contributor` +## `Dataset > contributor` **Title:** contributor @@ -919,7 +934,7 @@ List of agents contributing to the Dataset | ------------------------------- | -------------------------------------------------------------------------------- | | [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | -## [Optional] Property `Dataset > created` +## `Dataset > created` **Title:** creation date @@ -949,19 +964,19 @@ The date on which the Dataset was first created "2024-01" ``` -| Any of(Option) | +| Any of | | --------------------------------------------------- | | [Null allowed when not required](#created_anyOf_i0) | | [Date string](#created_anyOf_i1) | -### Property `Dataset > created > anyOf > Null allowed when not required` +### `Dataset > created > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > created > anyOf > Date string` +### `Dataset > created > anyOf > Date string` **Title:** Date string @@ -969,26 +984,26 @@ The date on which the Dataset was first created | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------ | | [item 0](#created_anyOf_i1_anyOf_i0) | | [item 1](#created_anyOf_i1_anyOf_i1) | | [item 2](#created_anyOf_i1_anyOf_i2) | | [item 3](#created_anyOf_i1_anyOf_i3) | -#### Property `Dataset > created > anyOf > Date string > anyOf > item 0` +#### `Dataset > created > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `Dataset > created > anyOf > Date string > anyOf > item 1` +#### `Dataset > created > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `Dataset > created > anyOf > Date string > anyOf > item 2` +#### `Dataset > created > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -999,7 +1014,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `Dataset > created > anyOf > Date string > anyOf > item 3` +#### `Dataset > created > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -1010,7 +1025,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `Dataset > creator` +## `Dataset > creator` **Title:** creator @@ -1022,19 +1037,19 @@ Person or organization responsible for creating the dataset | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | --------------------------------------------------- | | [Null allowed when not required](#creator_anyOf_i0) | | [Agent](#creator_anyOf_i1) | -### Property `Dataset > creator > anyOf > Null allowed when not required` +### `Dataset > creator > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > creator > anyOf > Agent` +### `Dataset > creator > anyOf > Agent` **Title:** Agent @@ -1045,7 +1060,7 @@ inline description of Agent | **Additional properties** | Any type allowed | | **Same definition as** | [Agent](./agents.md#agent) | -## [Optional] Property `Dataset > description` +## `Dataset > description` **Title:** description @@ -1067,7 +1082,7 @@ Plain-language summary of the dataset "Comprehensive daily climate observations collected from monitoring stations across the United States, including temperature, precipitation, humidity, and wind measurements." ``` -## [Optional] Property `Dataset > hasPart` +## `Dataset > hasPart` **Title:** has part @@ -1082,7 +1097,7 @@ List of related datasets that are part of the described dataset | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## [Optional] Property `Dataset > identifier` +## `Dataset > identifier` **Title:** identifier @@ -1095,19 +1110,19 @@ The unique identifier for the Dataset, e.g. the URI or other unique identifier i | **Required** | Yes | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------ | | [Null allowed when not required](#identifier_anyOf_i0) | | [Identifier](#identifier_anyOf_i1) | -### Property `Dataset > identifier > anyOf > Null allowed when not required` +### `Dataset > identifier > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > identifier > anyOf > Identifier` +### `Dataset > identifier > anyOf > Identifier` **Title:** Identifier @@ -1118,7 +1133,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | -## [Optional] Property `Dataset > isReferencedBy` +## `Dataset > isReferencedBy` **Title:** is referenced by @@ -1141,7 +1156,7 @@ List of links to related resources, such as publications, that reference, cite, | ------------------------------- | ------------------------- | | [Link](#isReferencedBy_items) | reference iri of Resource | -### Dataset > isReferencedBy > Link +### Link **Title:** Link @@ -1151,7 +1166,7 @@ reference iri of Resource | ---------- | -------- | | **Format** | `iri` | -## [Optional] Property `Dataset > issued` +## `Dataset > issued` **Title:** release date @@ -1181,19 +1196,19 @@ Date when the dataset was first published. If the exact publication date is unkn "2024-01" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------- | | [Null allowed when not required](#issued_anyOf_i0) | | [Date string](#issued_anyOf_i1) | -### Property `Dataset > issued > anyOf > Null allowed when not required` +### `Dataset > issued > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > issued > anyOf > Date string` +### `Dataset > issued > anyOf > Date string` **Title:** Date string @@ -1201,26 +1216,26 @@ Date when the dataset was first published. If the exact publication date is unkn | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------- | | [item 0](#issued_anyOf_i1_anyOf_i0) | | [item 1](#issued_anyOf_i1_anyOf_i1) | | [item 2](#issued_anyOf_i1_anyOf_i2) | | [item 3](#issued_anyOf_i1_anyOf_i3) | -#### Property `Dataset > issued > anyOf > Date string > anyOf > item 0` +#### `Dataset > issued > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `Dataset > issued > anyOf > Date string > anyOf > item 1` +#### `Dataset > issued > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `Dataset > issued > anyOf > Date string > anyOf > item 2` +#### `Dataset > issued > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -1231,7 +1246,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `Dataset > issued > anyOf > Date string > anyOf > item 3` +#### `Dataset > issued > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -1242,7 +1257,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `Dataset > language` +## `Dataset > language` **Title:** language @@ -1262,20 +1277,20 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en ] ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#language_anyOf_i0) | | [Language code](#language_anyOf_i1) | | [List of languages](#language_anyOf_i2) | -### Property `Dataset > language > anyOf > Null allowed when not required` +### `Dataset > language > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > language > anyOf > Language code` +### `Dataset > language > anyOf > Language code` **Title:** Language code @@ -1286,7 +1301,7 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en | -------------- | - | | **Max length** | 2 | -### Property `Dataset > language > anyOf > List of languages` +### `Dataset > language > anyOf > List of languages` **Title:** List of languages @@ -1297,7 +1312,7 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en | ----------------------------------------- | ----------- | | [Language code](#language_anyOf_i2_items) | - | -#### Dataset > language > anyOf > List of languages > Language code +#### Language code **Title:** Language code @@ -1308,7 +1323,7 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en | -------------- | - | | **Max length** | 2 | -## [Optional] Property `Dataset > modified` +## `Dataset > modified` **Title:** last modified @@ -1338,19 +1353,19 @@ Most recent date when the dataset's actual data changed, not just metadata "2024-01" ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#modified_anyOf_i0) | | [Date string](#modified_anyOf_i1) | -### Property `Dataset > modified > anyOf > Null allowed when not required` +### `Dataset > modified > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > modified > anyOf > Date string` +### `Dataset > modified > anyOf > Date string` **Title:** Date string @@ -1358,26 +1373,26 @@ Most recent date when the dataset's actual data changed, not just metadata | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------- | | [item 0](#modified_anyOf_i1_anyOf_i0) | | [item 1](#modified_anyOf_i1_anyOf_i1) | | [item 2](#modified_anyOf_i1_anyOf_i2) | | [item 3](#modified_anyOf_i1_anyOf_i3) | -#### Property `Dataset > modified > anyOf > Date string > anyOf > item 0` +#### `Dataset > modified > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `Dataset > modified > anyOf > Date string > anyOf > item 1` +#### `Dataset > modified > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `Dataset > modified > anyOf > Date string > anyOf > item 2` +#### `Dataset > modified > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -1388,7 +1403,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `Dataset > modified > anyOf > Date string > anyOf > item 3` +#### `Dataset > modified > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -1399,7 +1414,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `Dataset > provenance` +## `Dataset > provenance` **Title:** provenance @@ -1423,14 +1438,14 @@ List of statements about the lineage of a Dataset, including any changes in its | ------------------------------------- | ------------------------------------- | | [provenance items](#provenance_items) | Full text of the provenance statement | -### Dataset > provenance > provenance items +### Array Item Full text of the provenance statement | **Type** | `string` | | -------- | -------- | -## [Optional] Property `Dataset > publisher` +## `Dataset > publisher` **Title:** publisher @@ -1444,7 +1459,7 @@ Organization responsible for publishing and making the dataset available | **Additional properties** | Any type allowed | | **Defined in** | [Organization](./agents.md#organization) | -## [Optional] Property `Dataset > relation` +## `Dataset > relation` **Title:** related resource @@ -1467,7 +1482,7 @@ List of links to related resources when the relationship is not otherwise specif | ------------------------------- | ------------------------- | | [Link](#relation_items) | reference iri of Resource | -### Dataset > relation > Link +### Link **Title:** Link @@ -1477,7 +1492,7 @@ reference iri of Resource | ---------- | -------- | | **Format** | `iri` | -## [Optional] Property `Dataset > replaces` +## `Dataset > replaces` **Title:** replaces @@ -1492,7 +1507,7 @@ List of Datasets replaced by this Dataset | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## [Optional] Property `Dataset > rights` +## `Dataset > rights` **Title:** rights @@ -1521,14 +1536,14 @@ Rights statements not already covered by license or accessRights, such as copyri | ------------------------------- | ---------------------------------- | | [rights items](#rights_items) | Full text of a statement of rights | -### Dataset > rights > rights items +### Array Item Full text of a statement of rights | **Type** | `string` | | -------- | -------- | -## [Optional] Property `Dataset > rightsHolder` +## `Dataset > rightsHolder` **Title:** rights holder @@ -1543,7 +1558,7 @@ List of agents (organizations) holding rights on the Dataset | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## [Optional] Property `Dataset > source` +## `Dataset > source` **Title:** data source @@ -1558,7 +1573,7 @@ List of related Datasets from which the described Dataset is derived | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## [Optional] Property `Dataset > spatial` +## `Dataset > spatial` **Title:** spatial/geographic coverage @@ -1570,20 +1585,20 @@ A geographic region or regions that are covered by the Dataset | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | --------------------------------------------------- | | [Null allowed when not required](#spatial_anyOf_i0) | | [Location](#spatial_anyOf_i1) | | [List of geographic regions](#spatial_anyOf_i2) | -### Property `Dataset > spatial > anyOf > Null allowed when not required` +### `Dataset > spatial > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > spatial > anyOf > Location` +### `Dataset > spatial > anyOf > Location` **Title:** Location @@ -1594,7 +1609,7 @@ inline description of Location | **Additional properties** | Any type allowed | | **Same definition as** | [Location](./temporal-spatial-metrics.md#location) | -### Property `Dataset > spatial > anyOf > List of geographic regions` +### `Dataset > spatial > anyOf > List of geographic regions` **Title:** List of geographic regions @@ -1605,7 +1620,7 @@ inline description of Location | -------------------------------------------------- | -------------------------------- | | [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | -## [Optional] Property `Dataset > subject` +## `Dataset > subject` **Title:** subject @@ -1620,7 +1635,7 @@ List of primary subjects for the dataset, usually narrower than broad theme cate | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `Dataset > temporal` +## `Dataset > temporal` **Title:** temporal coverage @@ -1635,7 +1650,7 @@ Time periods covered by the dataset | ------------------------------------------------------------ | ---------------------------------------------------------------------- | | [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | -## [Optional] Property `Dataset > title` +## `Dataset > title` **Title:** title @@ -1657,7 +1672,7 @@ Human-readable title of the dataset "National Climate Observations 2024" ``` -## [Optional] Property `Dataset > category` +## `Dataset > category` **Title:** category @@ -1672,7 +1687,7 @@ List of high-level categories for the dataset | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `Dataset > hasQualityMeasurement` +## `Dataset > hasQualityMeasurement` **Title:** quality measurement @@ -1687,7 +1702,7 @@ List of quality measurements for the dataset (for example, completeness, accurac | ----------------------------------------------------------------------- | ------------------------------------------------------------- | | [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) | A measurement of a resource against a specific quality metric | -## [Optional] Property `Dataset > page` +## `Dataset > page` **Title:** documentation @@ -1702,7 +1717,7 @@ List of pages or documents about this dataset | -------------------------------------------- | ----------------------------------------------------- | | [Document](./quality-governance.md#document) | A publication or other document related to a resource | -## [Optional] Property `Dataset > qualifiedAttribution` +## `Dataset > qualifiedAttribution` **Title:** qualified attribution @@ -1717,7 +1732,7 @@ List of agents with specific responsibilities for the dataset | -------------------------------------------------- | ------------------------------------------------- | | [Attribution](./quality-governance.md#attribution) | A responsibility that an agent has for a resource | -## [Optional] Property `Dataset > wasAttributedTo` +## `Dataset > wasAttributedTo` **Title:** attribution @@ -1732,7 +1747,7 @@ List of agents attributed to this dataset | ------------------------------- | -------------------------------------------------------------------------------- | | [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | -## [Optional] Property `Dataset > wasGeneratedBy` +## `Dataset > wasGeneratedBy` **Title:** was generated by @@ -1747,7 +1762,7 @@ List of activities that generated, or provide the business context for the creat | -------------------------------------------------- | -------------------------------------------------------------- | | [Activity](./temporal-spatial-metrics.md#activity) | An activity related to creating, changing, or using a resource | -## [Optional] Property `Dataset > wasUsedBy` +## `Dataset > wasUsedBy` **Title:** used by @@ -1762,7 +1777,7 @@ List of activities that used the Dataset | -------------------------------------------------- | -------------------------------------------------------------- | | [Activity](./temporal-spatial-metrics.md#activity) | An activity related to creating, changing, or using a resource | -## [Optional] Property `Dataset > image` +## `Dataset > image` **Title:** image @@ -1774,19 +1789,19 @@ Thumbnail image illustrating the dataset, especially useful for visual data such | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------- | | [Null allowed when not required](#image_anyOf_i0) | | [Link](#image_anyOf_i1) | -### Property `Dataset > image > anyOf > Null allowed when not required` +### `Dataset > image > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Dataset > image > anyOf > Link` +### `Dataset > image > anyOf > Link` **Title:** Link @@ -1796,7 +1811,7 @@ The link to the image | ---------- | -------- | | **Format** | `iri` | -## [Optional] Property `Dataset > scopeNote` +## `Dataset > scopeNote` **Title:** usage note @@ -1812,3 +1827,6 @@ usage note for the dataset ```json "This dataset contains raw observational data. For derived products such as monthly averages or climate normals, see related datasets." ``` + +--- +**See Also:** (related supporting classes) diff --git a/jsonschema/docs/distribution.md b/jsonschema/docs/distribution.md index b694ab35..302b1657 100644 --- a/jsonschema/docs/distribution.md +++ b/jsonschema/docs/distribution.md @@ -76,7 +76,7 @@ A specific representation of a dataset, such as a file, feed, or API response | - [image](#image) | More than one type | image | | - [checksum](#checksum) | More than one type | checksum | -## [Optional] Property `Distribution > @id` +## `Distribution > @id` **Requirement:** Optional @@ -90,7 +90,7 @@ A specific representation of a dataset, such as a file, feed, or API response "https://example.gov/distributions/climate-data-csv-001" ``` -## [Optional] Property `Distribution > @type` +## `Distribution > @type` **Requirement:** Optional @@ -98,7 +98,7 @@ A specific representation of a dataset, such as a file, feed, or API response | ----------- | ---------------- | | **Default** | `"Distribution"` | -## [Optional] Property `Distribution > representationTechnique` +## `Distribution > representationTechnique` **Title:** representation technique @@ -110,19 +110,19 @@ Method or schema used to structure the distribution content (for example, CSV co | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------------------- | | [Null allowed when not required](#representationTechnique_anyOf_i0) | | [Concept](#representationTechnique_anyOf_i1) | -### Property `Distribution > representationTechnique > anyOf > Null allowed when not required` +### `Distribution > representationTechnique > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > representationTechnique > anyOf > Concept` +### `Distribution > representationTechnique > anyOf > Concept` **Title:** Concept @@ -133,7 +133,7 @@ inline description of Concept | **Additional properties** | Any type allowed | | **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | -## [Optional] Property `Distribution > status` +## `Distribution > status` **Title:** lifecycle status @@ -145,19 +145,19 @@ The status of the distribution in the context of maturity lifecycle | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | -------------------------------------------------- | | [Null allowed when not required](#status_anyOf_i0) | | [Concept](#status_anyOf_i1) | -### Property `Distribution > status > anyOf > Null allowed when not required` +### `Distribution > status > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > status > anyOf > Concept` +### `Distribution > status > anyOf > Concept` **Title:** Concept @@ -168,7 +168,7 @@ inline description of Concept | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | -## [Optional] Property `Distribution > characterEncoding` +## `Distribution > characterEncoding` **Title:** character encoding @@ -188,19 +188,19 @@ List of character encodings used in the Distribution, using IANA character set n ] ``` -| Any of(Option) | +| Any of | | ------------------------------------------------------------- | | [Null allowed when not required](#characterEncoding_anyOf_i0) | | [List of encodings](#characterEncoding_anyOf_i1) | -### Property `Distribution > characterEncoding > anyOf > Null allowed when not required` +### `Distribution > characterEncoding > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > characterEncoding > anyOf > List of encodings` +### `Distribution > characterEncoding > anyOf > List of encodings` **Title:** List of encodings @@ -211,14 +211,14 @@ List of character encodings used in the Distribution, using IANA character set n | ------------------------------------------------------- | ----------- | | [Character encoding](#characterEncoding_anyOf_i1_items) | - | -#### Distribution > characterEncoding > anyOf > List of encodings > Character encoding +#### Character encoding **Title:** Character encoding | **Type** | `string` | | -------- | -------- | -## [Optional] Property `Distribution > accessService` +## `Distribution > accessService` **Title:** access service @@ -233,7 +233,7 @@ A data service that gives access to the distribution of the dataset | --------------------------------------------------- | ------------------------------------------------------------------- | | [DataService](./quality-governance.md#data-service) | A service that provides access to data or data processing functions | -## [Optional] Property `Distribution > accessURL` +## `Distribution > accessURL` **Title:** access URL @@ -255,19 +255,19 @@ URL for indirect access to the Distribution (for example, a landing page, API do "https://example.gov/data/climate/access" ``` -| Any of(Option) | +| Any of | | ----------------------------------------------------- | | [Null allowed when not required](#accessURL_anyOf_i0) | | [URL](#accessURL_anyOf_i1) | -### Property `Distribution > accessURL > anyOf > Null allowed when not required` +### `Distribution > accessURL > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > accessURL > anyOf > URL` +### `Distribution > accessURL > anyOf > URL` **Title:** URL @@ -277,7 +277,7 @@ reference iri of Resource | ---------- | -------- | | **Format** | `iri` | -## [Optional] Property `Distribution > byteSize` +## `Distribution > byteSize` **Title:** byte size @@ -294,7 +294,7 @@ The size of a Distribution in bytes "52428800" ``` -## [Optional] Property `Distribution > compressFormat` +## `Distribution > compressFormat` **Title:** compression format @@ -311,7 +311,7 @@ The format of the file in which the data is contained in a compressed form, e.g. "application/gzip" ``` -## [Optional] Property `Distribution > downloadURL` +## `Distribution > downloadURL` **Title:** download URL @@ -329,19 +329,19 @@ Direct URL to a downloadable file for the Distribution; use accessURL for indire "https://example.gov/data/climate/climate-data-2023.csv" ``` -| Any of(Option) | +| Any of | | ------------------------------------------------------- | | [Null allowed when not required](#downloadURL_anyOf_i0) | | [URL](#downloadURL_anyOf_i1) | -### Property `Distribution > downloadURL > anyOf > Null allowed when not required` +### `Distribution > downloadURL > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > downloadURL > anyOf > URL` +### `Distribution > downloadURL > anyOf > URL` **Title:** URL @@ -351,7 +351,7 @@ reference iri of Resource | ---------- | -------- | | **Format** | `iri` | -## [Optional] Property `Distribution > mediaType` +## `Distribution > mediaType` **Title:** media type @@ -368,7 +368,7 @@ MIME type of the Distribution (for example, text/csv or application/json), from "text/csv" ``` -## [Optional] Property `Distribution > packageFormat` +## `Distribution > packageFormat` **Title:** packaging format @@ -385,7 +385,7 @@ The format of the file in which one or more data files are grouped together, e.g "application/zip" ``` -## [Optional] Property `Distribution > spatialResolutionInMeters` +## `Distribution > spatialResolutionInMeters` **Title:** Spatial resolution (meters) @@ -402,7 +402,7 @@ The minimum spatial separation resolvable in a dataset distribution, measured in "1000" ``` -## [Optional] Property `Distribution > temporalResolution` +## `Distribution > temporalResolution` **Title:** termporal resolution @@ -419,7 +419,7 @@ The minimum time period resolvable in the dataset distribution "P1D" ``` -## [Optional] Property `Distribution > availability` +## `Distribution > availability` **Title:** availability @@ -431,19 +431,19 @@ An indication how long it is planned to keep the Distribution of the Dataset ava | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | -------------------------------------------------------- | | [Null allowed when not required](#availability_anyOf_i0) | | [Concept](#availability_anyOf_i1) | -### Property `Distribution > availability > anyOf > Null allowed when not required` +### `Distribution > availability > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > availability > anyOf > Concept` +### `Distribution > availability > anyOf > Concept` **Title:** Concept @@ -454,7 +454,7 @@ inline description of Concept | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | -## [Optional] Property `Distribution > accessRestriction` +## `Distribution > accessRestriction` **Title:** access restriction @@ -469,7 +469,7 @@ List of access restrictions related to the distribution | ------------------------------------------------------------------------- | ----------------------------------------------------------- | | [AccessRestriction](./constraints-and-restrictions.md#access-restriction) | Rules or indicators that describe who can access a resource | -## [Optional] Property `Distribution > cuiRestriction` +## `Distribution > cuiRestriction` **Title:** CUI restriction @@ -481,19 +481,19 @@ Controlled Unclassified Information restriction related to the distribution | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ---------------------------------------------------------- | | [Null allowed when not required](#cuiRestriction_anyOf_i0) | | [CUIRestriction](#cuiRestriction_anyOf_i1) | -### Property `Distribution > cuiRestriction > anyOf > Null allowed when not required` +### `Distribution > cuiRestriction > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > cuiRestriction > anyOf > CUIRestriction` +### `Distribution > cuiRestriction > anyOf > CUIRestriction` **Title:** CUIRestriction @@ -504,7 +504,7 @@ inline description of CUIRestriction | **Additional properties** | Any type allowed | | **Same definition as** | [CUIRestriction](./constraints-and-restrictions.md#cui-restriction) | -## [Optional] Property `Distribution > describedBy` +## `Distribution > describedBy` **Title:** data dictionary @@ -516,19 +516,19 @@ A distribution containing the Data Dictionary for this distribution | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------- | | [Null allowed when not required](#describedBy_anyOf_i0) | | [Distribution](#describedBy_anyOf_i1) | -### Property `Distribution > describedBy > anyOf > Null allowed when not required` +### `Distribution > describedBy > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > describedBy > anyOf > Distribution` +### `Distribution > describedBy > anyOf > Distribution` **Title:** Distribution @@ -539,7 +539,10 @@ inline description of the data dictionary | **Additional properties** | Any type allowed | | **Same definition as** | [Distribution](./distribution.md#root) | -## [Optional] Property `Distribution > useRestriction` +--- +**See Also:** (related supporting classes) + +## `Distribution > useRestriction` **Title:** use restriction @@ -554,7 +557,7 @@ Use restriction related to the distribution | ------------------------------------------------------------------- | --------------------------------------------------- | | [UseRestriction](./constraints-and-restrictions.md#use-restriction) | Rules or legal limits on how a resource may be used | -## [Optional] Property `Distribution > accessRights` +## `Distribution > accessRights` **Title:** access rights @@ -572,26 +575,26 @@ Information about whether the distribution is publicly accessible, restricted, o "Public access without restrictions" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------------- | | [Null allowed when not required](#accessRights_anyOf_i0) | | [item 1](#accessRights_anyOf_i1) | -### Property `Distribution > accessRights > anyOf > Null allowed when not required` +### `Distribution > accessRights > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > accessRights > anyOf > item 1` +### `Distribution > accessRights > anyOf > item 1` Text description of the access rights | **Type** | `string` | | -------- | -------- | -## [Optional] Property `Distribution > conformsTo` +## `Distribution > conformsTo` **Title:** linked schemas @@ -606,7 +609,7 @@ List of standards, schemas, or reference systems the Distribution follows (prefe | -------------------------------------------- | ------------------------------------------------------------- | | [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | -## [Optional] Property `Distribution > description` +## `Distribution > description` **Title:** description @@ -627,7 +630,7 @@ Plain-language summary of the distribution "A CSV file containing historical climate data including daily temperature and precipitation readings." ``` -## [Optional] Property `Distribution > format` +## `Distribution > format` **Title:** format @@ -644,7 +647,7 @@ A human-readable description of the file format of the Distribution that provide "CSV" ``` -## [Optional] Property `Distribution > identifier` +## `Distribution > identifier` **Title:** identifier @@ -656,19 +659,19 @@ The unique identifier for the Distribution (e.g. DOI, ISBN) | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------ | | [Null allowed when not required](#identifier_anyOf_i0) | | [Identifier](#identifier_anyOf_i1) | -### Property `Distribution > identifier > anyOf > Null allowed when not required` +### `Distribution > identifier > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > identifier > anyOf > Identifier` +### `Distribution > identifier > anyOf > Identifier` **Title:** Identifier @@ -679,7 +682,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | -## [Optional] Property `Distribution > otherIdentifier` +## `Distribution > otherIdentifier` **Title:** other identifier @@ -694,7 +697,7 @@ A list of identifiers for the Distribution besides the main identifier, e.g. the | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## [Optional] Property `Distribution > issued` +## `Distribution > issued` **Title:** release date @@ -724,19 +727,19 @@ The date of formal issuance (e.g., publication) of the Distribution "2024-01" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------- | | [Null allowed when not required](#issued_anyOf_i0) | | [Date string](#issued_anyOf_i1) | -### Property `Distribution > issued > anyOf > Null allowed when not required` +### `Distribution > issued > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > issued > anyOf > Date string` +### `Distribution > issued > anyOf > Date string` **Title:** Date string @@ -744,26 +747,26 @@ The date of formal issuance (e.g., publication) of the Distribution | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------- | | [item 0](#issued_anyOf_i1_anyOf_i0) | | [item 1](#issued_anyOf_i1_anyOf_i1) | | [item 2](#issued_anyOf_i1_anyOf_i2) | | [item 3](#issued_anyOf_i1_anyOf_i3) | -#### Property `Distribution > issued > anyOf > Date string > anyOf > item 0` +#### `Distribution > issued > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `Distribution > issued > anyOf > Date string > anyOf > item 1` +#### `Distribution > issued > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `Distribution > issued > anyOf > Date string > anyOf > item 2` +#### `Distribution > issued > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -774,7 +777,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `Distribution > issued > anyOf > Date string > anyOf > item 3` +#### `Distribution > issued > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -785,7 +788,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `Distribution > language` +## `Distribution > language` **Title:** language @@ -810,20 +813,20 @@ ISO 639-1 language code values used in the distribution metadata text, such as e ] ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#language_anyOf_i0) | | [Language code](#language_anyOf_i1) | | [List of languages](#language_anyOf_i2) | -### Property `Distribution > language > anyOf > Null allowed when not required` +### `Distribution > language > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > language > anyOf > Language code` +### `Distribution > language > anyOf > Language code` **Title:** Language code @@ -834,7 +837,7 @@ ISO 639-1 language code values used in the distribution metadata text, such as e | -------------- | - | | **Max length** | 2 | -### Property `Distribution > language > anyOf > List of languages` +### `Distribution > language > anyOf > List of languages` **Title:** List of languages @@ -845,7 +848,7 @@ ISO 639-1 language code values used in the distribution metadata text, such as e | ----------------------------------------- | ----------- | | [Language code](#language_anyOf_i2_items) | - | -#### Distribution > language > anyOf > List of languages > Language code +#### Language code **Title:** Language code @@ -856,7 +859,7 @@ ISO 639-1 language code values used in the distribution metadata text, such as e | -------------- | - | | **Max length** | 2 | -## [Optional] Property `Distribution > license` +## `Distribution > license` **Title:** license @@ -874,26 +877,26 @@ License that governs how the distribution can be used or reused "https://creativecommons.org/publicdomain/zero/1.0/" ``` -| Any of(Option) | +| Any of | | --------------------------------------------------- | | [Null allowed when not required](#license_anyOf_i0) | | [item 1](#license_anyOf_i1) | -### Property `Distribution > license > anyOf > Null allowed when not required` +### `Distribution > license > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > license > anyOf > item 1` +### `Distribution > license > anyOf > item 1` Full text of the license | **Type** | `string` | | -------- | -------- | -## [Optional] Property `Distribution > modified` +## `Distribution > modified` **Title:** last modified @@ -927,19 +930,19 @@ The most recent date on which the Distribution was changed or modified "2024-01" ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#modified_anyOf_i0) | | [Date string](#modified_anyOf_i1) | -### Property `Distribution > modified > anyOf > Null allowed when not required` +### `Distribution > modified > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > modified > anyOf > Date string` +### `Distribution > modified > anyOf > Date string` **Title:** Date string @@ -947,26 +950,26 @@ The most recent date on which the Distribution was changed or modified | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------- | | [item 0](#modified_anyOf_i1_anyOf_i0) | | [item 1](#modified_anyOf_i1_anyOf_i1) | | [item 2](#modified_anyOf_i1_anyOf_i2) | | [item 3](#modified_anyOf_i1_anyOf_i3) | -#### Property `Distribution > modified > anyOf > Date string > anyOf > item 0` +#### `Distribution > modified > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `Distribution > modified > anyOf > Date string > anyOf > item 1` +#### `Distribution > modified > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `Distribution > modified > anyOf > Date string > anyOf > item 2` +#### `Distribution > modified > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -977,7 +980,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `Distribution > modified > anyOf > Date string > anyOf > item 3` +#### `Distribution > modified > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -988,7 +991,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `Distribution > rights` +## `Distribution > rights` **Title:** rights @@ -1017,14 +1020,14 @@ Rights statements not already covered by license or accessRights, such as copyri | ------------------------------- | ---------------------------------- | | [rights items](#rights_items) | Full text of a statement of rights | -### Distribution > rights > rights items +### Array Item Full text of a statement of rights | **Type** | `string` | | -------- | -------- | -## [Optional] Property `Distribution > title` +## `Distribution > title` **Title:** title @@ -1041,7 +1044,7 @@ Human-readable title of the distribution "Climate Data CSV" ``` -## [Optional] Property `Distribution > hasQualityMeasurement` +## `Distribution > hasQualityMeasurement` **Title:** quality measurement @@ -1056,7 +1059,7 @@ Quality measurements for the distribution (for example, completeness, accuracy, | ----------------------------------------------------------------------- | ------------------------------------------------------------- | | [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) | A measurement of a resource against a specific quality metric | -## [Optional] Property `Distribution > page` +## `Distribution > page` **Title:** documentation @@ -1071,7 +1074,7 @@ A page or document about this Distribution | -------------------------------------------- | ----------------------------------------------------- | | [Document](./quality-governance.md#document) | A publication or other document related to a resource | -## [Optional] Property `Distribution > image` +## `Distribution > image` **Title:** image @@ -1083,19 +1086,19 @@ A link to a thumbnail picture illustrating the content of the distribution | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------- | | [Null allowed when not required](#image_anyOf_i0) | | [Link](#image_anyOf_i1) | -### Property `Distribution > image > anyOf > Null allowed when not required` +### `Distribution > image > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > image > anyOf > Link` +### `Distribution > image > anyOf > Link` **Title:** Link @@ -1105,7 +1108,7 @@ The link to the image | ---------- | -------- | | **Format** | `iri` | -## [Optional] Property `Distribution > checksum` +## `Distribution > checksum` **Title:** checksum @@ -1117,19 +1120,19 @@ Checksum used to verify that the downloadable file content has not changed | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#checksum_anyOf_i0) | | [Checksum](#checksum_anyOf_i1) | -### Property `Distribution > checksum > anyOf > Null allowed when not required` +### `Distribution > checksum > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Distribution > checksum > anyOf > Checksum` +### `Distribution > checksum > anyOf > Checksum` **Title:** Checksum @@ -1139,3 +1142,6 @@ inline description of Checksum | ------------------------- | ------------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Checksum](./identifiers-and-relationships.md#checksum) | + +--- +**See Also:** (related supporting classes) diff --git a/jsonschema/docs/identifiers-and-relationships.md b/jsonschema/docs/identifiers-and-relationships.md index 64fec193..5dbd27a7 100644 --- a/jsonschema/docs/identifiers-and-relationships.md +++ b/jsonschema/docs/identifiers-and-relationships.md @@ -4,7 +4,7 @@ Supporting classes for identifiers, relationships, checksums, and controlled con -## Identifier +## Class Identifier **Title:** Identifier @@ -14,19 +14,19 @@ A unique identifier and optionally it's scheme and other relevant information | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------- | | [Simple string identifier](#identifier--anyOf_i0) | | [Identifier as a complex object](#identifier--anyOf_i1) | -## Property `Identifier > anyOf > Simple string identifier` +## `Identifier > anyOf > Simple string identifier` **Title:** Simple string identifier | **Type** | `string` | | -------- | -------- | -## Property `Identifier > anyOf > Identifier as a complex object` +## `Identifier > anyOf > Identifier as a complex object` **Title:** Identifier as a complex object @@ -44,7 +44,7 @@ A unique identifier and optionally it's scheme and other relevant information | - [version](#identifier--anyOf_i1_version) | null or string | version | | - [notation](#identifier--anyOf_i1_notation) | null or string | notation | -### Property `Identifier > anyOf > Identifier as a complex object > @id` +### `Identifier > anyOf > Identifier as a complex object > @id` **Requirement:** Optional @@ -52,7 +52,7 @@ A unique identifier and optionally it's scheme and other relevant information | ---------- | -------- | | **Format** | `iri` | -### Property `Identifier > anyOf > Identifier as a complex object > @type` +### `Identifier > anyOf > Identifier as a complex object > @type` **Requirement:** Optional @@ -60,7 +60,7 @@ A unique identifier and optionally it's scheme and other relevant information | ----------- | -------------- | | **Default** | `"Identifier"` | -### Property `Identifier > anyOf > Identifier as a complex object > schemaAgency` +### `Identifier > anyOf > Identifier as a complex object > schemaAgency` **Title:** schema agency @@ -71,7 +71,7 @@ The name of the agency that issued the identifier | **Type** | `null or string` | | -------- | ---------------- | -### Property `Identifier > anyOf > Identifier as a complex object > creator` +### `Identifier > anyOf > Identifier as a complex object > creator` **Title:** creator @@ -83,19 +83,19 @@ the agency that manages the identifier scheme | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------------ | | [Null allowed when not required](#identifier--anyOf_i1_creator_anyOf_i0) | | [Organization](#identifier--anyOf_i1_creator_anyOf_i1) | -#### Property `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Null allowed when not required` +#### `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -#### Property `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Organization` +#### `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Organization` **Title:** Organization @@ -106,7 +106,7 @@ inline description of the creator | **Additional properties** | Any type allowed | | **Defined in** | [Organization](./agents.md#organization) | -### Property `Identifier > anyOf > Identifier as a complex object > issued` +### `Identifier > anyOf > Identifier as a complex object > issued` **Title:** issued @@ -118,19 +118,19 @@ The date of formal issuance (e.g., publication) of the Identifier | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------------------------------- | | [Null allowed when not required](#identifier--anyOf_i1_issued_anyOf_i0) | | [Date string](#identifier--anyOf_i1_issued_anyOf_i1) | -#### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Null allowed when not required` +#### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -#### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string` +#### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string` **Title:** Date string @@ -138,26 +138,26 @@ The date of formal issuance (e.g., publication) of the Identifier | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | -------------------------------------------- | | [item 0](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i0) | | [item 1](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i1) | | [item 2](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i2) | | [item 3](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i3) | -##### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 0` +##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -##### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 1` +##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -##### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 2` +##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -168,7 +168,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -##### Property `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 3` +##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -179,7 +179,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -### Property `Identifier > anyOf > Identifier as a complex object > version` +### `Identifier > anyOf > Identifier as a complex object > version` **Title:** version @@ -190,7 +190,7 @@ version of the identifier scheme | **Type** | `null or string` | | -------- | ---------------- | -### Property `Identifier > anyOf > Identifier as a complex object > notation` +### `Identifier > anyOf > Identifier as a complex object > notation` **Title:** notation @@ -205,7 +205,7 @@ abbreviation or code from code lists for an identifier -## Relationship +## Class Relationship **Title:** Relationship @@ -232,7 +232,7 @@ Additional information about how one resource is related to another | + [hadRole](#relationship--hadRole) | string | role | | + [relation](#relationship--relation) | string | relation | -## [Optional] Property `Relationship > @id` +## `Relationship > @id` **Requirement:** Optional @@ -246,7 +246,7 @@ Additional information about how one resource is related to another "https://example.gov/relationships/dataset-001-data-provider" ``` -## [Optional] Property `Relationship > @type` +## `Relationship > @type` **Requirement:** Optional @@ -254,7 +254,7 @@ Additional information about how one resource is related to another | ----------- | ---------------- | | **Default** | `"Relationship"` | -## [Optional] Property `Relationship > hadRole` +## `Relationship > hadRole` **Title:** role @@ -276,7 +276,7 @@ The function of an entity or agent with respect to a dataset "dataProvider" ``` -## [Optional] Property `Relationship > relation` +## `Relationship > relation` **Title:** relation @@ -302,7 +302,7 @@ The entity related to the dataset. This string should unambiguously identify the -## Checksum +## Class Checksum **Title:** Checksum @@ -329,7 +329,7 @@ A mechanism that can be used to verify that the contents of a distribution have | + [algorithm](#checksum--algorithm) | string | algorithm | | + [checksumValue](#checksum--checksumValue) | string | checksum value | -## [Optional] Property `Checksum > @id` +## `Checksum > @id` **Requirement:** Optional @@ -343,7 +343,7 @@ A mechanism that can be used to verify that the contents of a distribution have "https://example.gov/checksums/dataset-001-sha256" ``` -## [Optional] Property `Checksum > @type` +## `Checksum > @type` **Requirement:** Optional @@ -351,7 +351,7 @@ A mechanism that can be used to verify that the contents of a distribution have | ----------- | ------------ | | **Default** | `"Checksum"` | -## [Optional] Property `Checksum > algorithm` +## `Checksum > algorithm` **Title:** algorithm @@ -369,7 +369,7 @@ The algorithm used to produce the checksum "SHA-256" ``` -## [Optional] Property `Checksum > checksumValue` +## `Checksum > checksumValue` **Title:** checksum value @@ -395,7 +395,7 @@ A lower case hexadecimal encoded digest value produced using a specific algorith -## Concept +## Class Concept **Title:** Concept @@ -405,12 +405,12 @@ A controlled term or label, optionally drawn from a concept scheme | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | -------------------- | | [Concept](#concept--anyOf_i0) | | [item 1](#concept--anyOf_i1) | -## Property `Concept > anyOf > Concept` +## `Concept > anyOf > Concept` **Title:** Concept @@ -419,7 +419,7 @@ The value of the concept, expressed as a string. This is only used when the conc | **Type** | `string` | | -------- | -------- | -## Property `Concept > anyOf > item 1` +## `Concept > anyOf > item 1` | **Type** | `object` | | ------------------------- | ---------------- | @@ -435,7 +435,7 @@ The value of the concept, expressed as a string. This is only used when the conc | - [notation](#concept--anyOf_i1_notation) | More than one type | notation | | + [prefLabel](#concept--anyOf_i1_prefLabel) | string | preferred label | -### Property `Concept > anyOf > item 1 > @id` +### `Concept > anyOf > item 1 > @id` **Requirement:** Optional @@ -443,7 +443,7 @@ The value of the concept, expressed as a string. This is only used when the conc | ---------- | -------- | | **Format** | `iri` | -### Property `Concept > anyOf > item 1 > @type` +### `Concept > anyOf > item 1 > @type` **Requirement:** Optional @@ -451,7 +451,7 @@ The value of the concept, expressed as a string. This is only used when the conc | ----------- | ----------- | | **Default** | `"Concept"` | -### Property `Concept > anyOf > item 1 > altLabel` +### `Concept > anyOf > item 1 > altLabel` **Title:** alternate label @@ -462,7 +462,7 @@ Alternative label for a concept | **Type** | `null or string` | | -------- | ---------------- | -### Property `Concept > anyOf > item 1 > definition` +### `Concept > anyOf > item 1 > definition` **Title:** definition @@ -473,7 +473,7 @@ Definition of the controlled vocabulary term | **Type** | `null or string` | | -------- | ---------------- | -### Property `Concept > anyOf > item 1 > inScheme` +### `Concept > anyOf > item 1 > inScheme` **Title:** in scheme @@ -486,7 +486,7 @@ Concept scheme defining this concept | **Additional properties** | Any type allowed | | **Defined in** | [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) | -### Property `Concept > anyOf > item 1 > notation` +### `Concept > anyOf > item 1 > notation` **Title:** notation @@ -498,17 +498,17 @@ List of abbreviations or codes from code lists for the Concept | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------- | | [item 0](#concept--anyOf_i1_notation_anyOf_i0) | | [item 1](#concept--anyOf_i1_notation_anyOf_i1) | -#### Property `Concept > anyOf > item 1 > notation > anyOf > item 0` +#### `Concept > anyOf > item 1 > notation > anyOf > item 0` | **Type** | `null` | | -------- | ------ | -#### Property `Concept > anyOf > item 1 > notation > anyOf > item 1` +#### `Concept > anyOf > item 1 > notation > anyOf > item 1` | **Type** | `array of string` | | -------- | ----------------- | @@ -517,12 +517,12 @@ List of abbreviations or codes from code lists for the Concept | ------------------------------------------------- | ----------- | | [item 1 items](#concept--anyOf_i1_notation_anyOf_i1_items) | - | -##### Concept > anyOf > item 1 > notation > anyOf > item 1 > item 1 items +##### Array Item | **Type** | `string` | | -------- | -------- | -### Property `Concept > anyOf > item 1 > prefLabel` +### `Concept > anyOf > item 1 > prefLabel` **Title:** preferred label @@ -538,7 +538,7 @@ Preferred label for the term -## ConceptScheme +## Class ConceptScheme **Title:** ConceptScheme @@ -570,7 +570,7 @@ A controlled vocabulary or other list of approved terms for a concept | - [modified](#concept-scheme--modified) | More than one type | update/modification date | | + [title](#concept-scheme--title) | string | title | -## [Optional] Property `ConceptScheme > @id` +## `ConceptScheme > @id` **Requirement:** Optional @@ -584,7 +584,7 @@ A controlled vocabulary or other list of approved terms for a concept "https://example.gov/concept-schemes/data-classification" ``` -## [Optional] Property `ConceptScheme > @type` +## `ConceptScheme > @type` **Requirement:** Optional @@ -592,7 +592,7 @@ A controlled vocabulary or other list of approved terms for a concept | ----------- | ----------------- | | **Default** | `"ConceptScheme"` | -## [Optional] Property `ConceptScheme > version` +## `ConceptScheme > version` **Title:** version info @@ -609,7 +609,7 @@ A version number or other version designation of the concept scheme "2.0.1" ``` -## [Optional] Property `ConceptScheme > created` +## `ConceptScheme > created` **Title:** creation date @@ -639,19 +639,19 @@ The date on which the Concept Scheme was first created "2024-01" ``` -| Any of(Option) | +| Any of | | --------------------------------------------------- | | [Null allowed when not required](#concept-scheme--created_anyOf_i0) | | [Date string](#concept-scheme--created_anyOf_i1) | -### Property `ConceptScheme > created > anyOf > Null allowed when not required` +### `ConceptScheme > created > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `ConceptScheme > created > anyOf > Date string` +### `ConceptScheme > created > anyOf > Date string` **Title:** Date string @@ -659,26 +659,26 @@ The date on which the Concept Scheme was first created | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------ | | [item 0](#concept-scheme--created_anyOf_i1_anyOf_i0) | | [item 1](#concept-scheme--created_anyOf_i1_anyOf_i1) | | [item 2](#concept-scheme--created_anyOf_i1_anyOf_i2) | | [item 3](#concept-scheme--created_anyOf_i1_anyOf_i3) | -#### Property `ConceptScheme > created > anyOf > Date string > anyOf > item 0` +#### `ConceptScheme > created > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `ConceptScheme > created > anyOf > Date string > anyOf > item 1` +#### `ConceptScheme > created > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `ConceptScheme > created > anyOf > Date string > anyOf > item 2` +#### `ConceptScheme > created > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -689,7 +689,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `ConceptScheme > created > anyOf > Date string > anyOf > item 3` +#### `ConceptScheme > created > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -700,7 +700,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `ConceptScheme > description` +## `ConceptScheme > description` **Title:** description @@ -721,7 +721,7 @@ A description of the concept scheme "A controlled vocabulary for classifying federal government data assets by sensitivity and access requirements." ``` -## [Optional] Property `ConceptScheme > issued` +## `ConceptScheme > issued` **Title:** publication date @@ -751,19 +751,19 @@ The date of formal issuance (e.g., publication) of the concept scheme "2024-01" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------- | | [Null allowed when not required](#concept-scheme--issued_anyOf_i0) | | [Date string](#concept-scheme--issued_anyOf_i1) | -### Property `ConceptScheme > issued > anyOf > Null allowed when not required` +### `ConceptScheme > issued > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `ConceptScheme > issued > anyOf > Date string` +### `ConceptScheme > issued > anyOf > Date string` **Title:** Date string @@ -771,26 +771,26 @@ The date of formal issuance (e.g., publication) of the concept scheme | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------- | | [item 0](#concept-scheme--issued_anyOf_i1_anyOf_i0) | | [item 1](#concept-scheme--issued_anyOf_i1_anyOf_i1) | | [item 2](#concept-scheme--issued_anyOf_i1_anyOf_i2) | | [item 3](#concept-scheme--issued_anyOf_i1_anyOf_i3) | -#### Property `ConceptScheme > issued > anyOf > Date string > anyOf > item 0` +#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `ConceptScheme > issued > anyOf > Date string > anyOf > item 1` +#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `ConceptScheme > issued > anyOf > Date string > anyOf > item 2` +#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -801,7 +801,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `ConceptScheme > issued > anyOf > Date string > anyOf > item 3` +#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -812,7 +812,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `ConceptScheme > modified` +## `ConceptScheme > modified` **Title:** update/modification date @@ -842,19 +842,19 @@ The most recent date at which the concept scheme was changed or modified "2024-01" ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#concept-scheme--modified_anyOf_i0) | | [Date string](#concept-scheme--modified_anyOf_i1) | -### Property `ConceptScheme > modified > anyOf > Null allowed when not required` +### `ConceptScheme > modified > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `ConceptScheme > modified > anyOf > Date string` +### `ConceptScheme > modified > anyOf > Date string` **Title:** Date string @@ -862,26 +862,26 @@ The most recent date at which the concept scheme was changed or modified | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------- | | [item 0](#concept-scheme--modified_anyOf_i1_anyOf_i0) | | [item 1](#concept-scheme--modified_anyOf_i1_anyOf_i1) | | [item 2](#concept-scheme--modified_anyOf_i1_anyOf_i2) | | [item 3](#concept-scheme--modified_anyOf_i1_anyOf_i3) | -#### Property `ConceptScheme > modified > anyOf > Date string > anyOf > item 0` +#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `ConceptScheme > modified > anyOf > Date string > anyOf > item 1` +#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `ConceptScheme > modified > anyOf > Date string > anyOf > item 2` +#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -892,7 +892,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `ConceptScheme > modified > anyOf > Date string > anyOf > item 3` +#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -903,7 +903,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `ConceptScheme > title` +## `ConceptScheme > title` **Title:** title diff --git a/jsonschema/docs/quality-governance.md b/jsonschema/docs/quality-governance.md index 9f5045f9..4c020e55 100644 --- a/jsonschema/docs/quality-governance.md +++ b/jsonschema/docs/quality-governance.md @@ -4,7 +4,7 @@ Supporting classes for standards, documents, catalog records, data services, and -## Standard +## Class Standard **Title:** Standard @@ -49,7 +49,7 @@ A standard or specification that another resource conforms to | - [category](#standard--category) | null or array | category | | - [inScheme](#standard--inScheme) | More than one type | in scheme | -## [Optional] Property `Standard > @id` +## `Standard > @id` **Requirement:** Optional @@ -63,7 +63,7 @@ A standard or specification that another resource conforms to "https://example.gov/standards/dcat-us-3" ``` -## [Optional] Property `Standard > @type` +## `Standard > @type` **Requirement:** Optional @@ -71,7 +71,7 @@ A standard or specification that another resource conforms to | ----------- | ------------ | | **Default** | `"Standard"` | -## [Optional] Property `Standard > created` +## `Standard > created` **Title:** creation date @@ -101,19 +101,19 @@ The date on which the Standard has been first created "2024-01" ``` -| Any of(Option) | +| Any of | | --------------------------------------------------- | | [Null allowed when not required](#standard--created_anyOf_i0) | | [Date string](#standard--created_anyOf_i1) | -### Property `Standard > created > anyOf > Null allowed when not required` +### `Standard > created > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Standard > created > anyOf > Date string` +### `Standard > created > anyOf > Date string` **Title:** Date string @@ -121,26 +121,26 @@ The date on which the Standard has been first created | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------ | | [item 0](#standard--created_anyOf_i1_anyOf_i0) | | [item 1](#standard--created_anyOf_i1_anyOf_i1) | | [item 2](#standard--created_anyOf_i1_anyOf_i2) | | [item 3](#standard--created_anyOf_i1_anyOf_i3) | -#### Property `Standard > created > anyOf > Date string > anyOf > item 0` +#### `Standard > created > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `Standard > created > anyOf > Date string > anyOf > item 1` +#### `Standard > created > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `Standard > created > anyOf > Date string > anyOf > item 2` +#### `Standard > created > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -151,7 +151,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `Standard > created > anyOf > Date string > anyOf > item 3` +#### `Standard > created > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -162,7 +162,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `Standard > description` +## `Standard > description` **Title:** description @@ -183,7 +183,7 @@ Plain-language summary of the standard "The DCAT-US 3.0 schema defines a standard metadata format for data catalogs in the United States government, based on W3C DCAT." ``` -## [Optional] Property `Standard > identifier` +## `Standard > identifier` **Title:** identifier @@ -195,19 +195,19 @@ The unique identifier for the Standard, e.g. the URI or other unique identifier | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------ | | [Null allowed when not required](#standard--identifier_anyOf_i0) | | [Identifier](#standard--identifier_anyOf_i1) | -### Property `Standard > identifier > anyOf > Null allowed when not required` +### `Standard > identifier > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Standard > identifier > anyOf > Identifier` +### `Standard > identifier > anyOf > Identifier` **Title:** Identifier @@ -218,7 +218,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | -## [Optional] Property `Standard > otherIdentifier` +## `Standard > otherIdentifier` **Title:** other identifier @@ -233,7 +233,7 @@ A list of identifiers for the Standard besides the main identifier, e.g. the URI | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## [Optional] Property `Standard > issued` +## `Standard > issued` **Title:** issued @@ -263,19 +263,19 @@ The date of formal issuance (e.g., publication) of the Standard "2024-01" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------- | | [Null allowed when not required](#standard--issued_anyOf_i0) | | [Date string](#standard--issued_anyOf_i1) | -### Property `Standard > issued > anyOf > Null allowed when not required` +### `Standard > issued > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Standard > issued > anyOf > Date string` +### `Standard > issued > anyOf > Date string` **Title:** Date string @@ -283,26 +283,26 @@ The date of formal issuance (e.g., publication) of the Standard | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------- | | [item 0](#standard--issued_anyOf_i1_anyOf_i0) | | [item 1](#standard--issued_anyOf_i1_anyOf_i1) | | [item 2](#standard--issued_anyOf_i1_anyOf_i2) | | [item 3](#standard--issued_anyOf_i1_anyOf_i3) | -#### Property `Standard > issued > anyOf > Date string > anyOf > item 0` +#### `Standard > issued > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `Standard > issued > anyOf > Date string > anyOf > item 1` +#### `Standard > issued > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `Standard > issued > anyOf > Date string > anyOf > item 2` +#### `Standard > issued > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -313,7 +313,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `Standard > issued > anyOf > Date string > anyOf > item 3` +#### `Standard > issued > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -324,7 +324,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `Standard > modified` +## `Standard > modified` **Title:** last modified @@ -354,19 +354,19 @@ The most recent date on which the Standard was changed or modified "2024-01" ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#standard--modified_anyOf_i0) | | [Date string](#standard--modified_anyOf_i1) | -### Property `Standard > modified > anyOf > Null allowed when not required` +### `Standard > modified > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Standard > modified > anyOf > Date string` +### `Standard > modified > anyOf > Date string` **Title:** Date string @@ -374,26 +374,26 @@ The most recent date on which the Standard was changed or modified | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------- | | [item 0](#standard--modified_anyOf_i1_anyOf_i0) | | [item 1](#standard--modified_anyOf_i1_anyOf_i1) | | [item 2](#standard--modified_anyOf_i1_anyOf_i2) | | [item 3](#standard--modified_anyOf_i1_anyOf_i3) | -#### Property `Standard > modified > anyOf > Date string > anyOf > item 0` +#### `Standard > modified > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `Standard > modified > anyOf > Date string > anyOf > item 1` +#### `Standard > modified > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `Standard > modified > anyOf > Date string > anyOf > item 2` +#### `Standard > modified > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -404,7 +404,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `Standard > modified > anyOf > Date string > anyOf > item 3` +#### `Standard > modified > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -415,7 +415,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `Standard > title` +## `Standard > title` **Title:** title @@ -436,7 +436,7 @@ Human-readable title of the standard "DCAT-US 3.0 - Data Catalog Vocabulary United States Profile" ``` -## [Optional] Property `Standard > category` +## `Standard > category` **Title:** category @@ -451,7 +451,7 @@ List of categories for the Standard | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `Standard > inScheme` +## `Standard > inScheme` **Title:** in scheme @@ -463,19 +463,19 @@ The reference register to which the Standard belongs | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#standard--inScheme_anyOf_i0) | | [ConceptScheme](#standard--inScheme_anyOf_i1) | -### Property `Standard > inScheme > anyOf > Null allowed when not required` +### `Standard > inScheme > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Standard > inScheme > anyOf > ConceptScheme` +### `Standard > inScheme > anyOf > ConceptScheme` **Title:** ConceptScheme @@ -490,7 +490,7 @@ inline description of ConceptScheme -## Document +## Class Document **Title:** Document @@ -541,7 +541,7 @@ A publication or other document related to a resource | + [title](#document--title) | string | title | | - [category](#document--category) | null or array | category | -## [Optional] Property `Document > @id` +## `Document > @id` **Requirement:** Optional @@ -555,7 +555,7 @@ A publication or other document related to a resource "https://example.gov/documents/climate-user-guide-001" ``` -## [Optional] Property `Document > @type` +## `Document > @type` **Requirement:** Optional @@ -563,7 +563,7 @@ A publication or other document related to a resource | ----------- | ------------ | | **Default** | `"Document"` | -## [Optional] Property `Document > accessURL` +## `Document > accessURL` **Title:** access URL @@ -581,19 +581,19 @@ A URL that gives access to the Document "https://example.gov/docs/climate-user-guide" ``` -| Any of(Option) | +| Any of | | ----------------------------------------------------- | | [Null allowed when not required](#document--accessURL_anyOf_i0) | | [URL](#document--accessURL_anyOf_i1) | -### Property `Document > accessURL > anyOf > Null allowed when not required` +### `Document > accessURL > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Document > accessURL > anyOf > URL` +### `Document > accessURL > anyOf > URL` **Title:** URL @@ -603,7 +603,7 @@ reference iri of Document | ---------- | -------- | | **Format** | `iri` | -## [Optional] Property `Document > downloadURL` +## `Document > downloadURL` **Title:** download URL @@ -621,19 +621,19 @@ A URL that is a direct link to a downloadable file of the Document in a given fo "https://example.gov/docs/climate-user-guide.pdf" ``` -| Any of(Option) | +| Any of | | ------------------------------------------------------- | | [Null allowed when not required](#document--downloadURL_anyOf_i0) | | [URL](#document--downloadURL_anyOf_i1) | -### Property `Document > downloadURL > anyOf > Null allowed when not required` +### `Document > downloadURL > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Document > downloadURL > anyOf > URL` +### `Document > downloadURL > anyOf > URL` **Title:** URL @@ -643,7 +643,7 @@ reference iri of Document | ---------- | -------- | | **Format** | `iri` | -## [Optional] Property `Document > creator` +## `Document > creator` **Title:** author @@ -658,7 +658,7 @@ The individual(s) responsible for creating the Document | ------------------------------- | ----------------------------------------------- | | [Kind](./agents.md#kind) | Contact information for an individual or entity | -## [Optional] Property `Document > mediaType` +## `Document > mediaType` **Title:** media type @@ -675,7 +675,7 @@ The file format of the Document as defined in the official register of media typ "application/pdf" ``` -## [Optional] Property `Document > abstract` +## `Document > abstract` **Title:** abstract @@ -692,7 +692,7 @@ Text abstract of the Document "This document provides detailed instructions for using climate data products, including API access, file formats, and data interpretation guidelines." ``` -## [Optional] Property `Document > bibliographicCitation` +## `Document > bibliographicCitation` **Title:** bibliographic citation @@ -713,7 +713,7 @@ Bibliographic citation as text "National Climate Data Center. (2024). Climate Data User Guide. U.S. Department of Commerce." ``` -## [Optional] Property `Document > conformsTo` +## `Document > conformsTo` **Title:** conforms to @@ -728,7 +728,7 @@ List of standards or specifications the document follows | -------------------------------------------- | ------------------------------------------------------------- | | [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | -## [Optional] Property `Document > corporateCreator` +## `Document > corporateCreator` **Title:** corporate author @@ -743,7 +743,7 @@ The corporate organization(s) responsible for creating the Document | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## [Optional] Property `Document > description` +## `Document > description` **Title:** description @@ -764,7 +764,7 @@ Plain-language summary of the document "A comprehensive guide for accessing and using the National Climate Data Center's data products and services." ``` -## [Optional] Property `Document > identifier` +## `Document > identifier` **Title:** identifier @@ -776,19 +776,19 @@ The unique identifier for the Document (e.g. DOI, ISBN) | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------ | | [Null allowed when not required](#document--identifier_anyOf_i0) | | [Identifier](#document--identifier_anyOf_i1) | -### Property `Document > identifier > anyOf > Null allowed when not required` +### `Document > identifier > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Document > identifier > anyOf > Identifier` +### `Document > identifier > anyOf > Identifier` **Title:** Identifier @@ -799,7 +799,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | -## [Optional] Property `Document > otherIdentifier` +## `Document > otherIdentifier` **Title:** other identifier @@ -814,7 +814,7 @@ A list of identifiers for the Document besides the main identifier, e.g. the URI | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## [Optional] Property `Document > issued` +## `Document > issued` **Title:** publication date @@ -844,44 +844,44 @@ Publication date of the Document "2024-01" ``` -| Any of(Option) | +| Any of | | -------------------------------------------------- | | [Null allowed when not required](#document--issued_anyOf_i0) | | [item 1](#document--issued_anyOf_i1) | -### Property `Document > issued > anyOf > Null allowed when not required` +### `Document > issued > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `Document > issued > anyOf > item 1` +### `Document > issued > anyOf > item 1` | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------- | | [item 0](#document--issued_anyOf_i1_anyOf_i0) | | [item 1](#document--issued_anyOf_i1_anyOf_i1) | | [item 2](#document--issued_anyOf_i1_anyOf_i2) | | [item 3](#document--issued_anyOf_i1_anyOf_i3) | -#### Property `Document > issued > anyOf > item 1 > anyOf > item 0` +#### `Document > issued > anyOf > item 1 > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `Document > issued > anyOf > item 1 > anyOf > item 1` +#### `Document > issued > anyOf > item 1 > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `Document > issued > anyOf > item 1 > anyOf > item 2` +#### `Document > issued > anyOf > item 1 > anyOf > item 2` A year in YYYY format @@ -892,7 +892,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `Document > issued > anyOf > item 1 > anyOf > item 3` +#### `Document > issued > anyOf > item 1 > anyOf > item 3` A year and month in YYYY-MM format @@ -903,7 +903,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `Document > publisher` +## `Document > publisher` **Title:** publisher @@ -918,7 +918,7 @@ The organization(s) that published the Document | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## [Optional] Property `Document > title` +## `Document > title` **Title:** title @@ -936,7 +936,7 @@ The title of the Document "Climate Data User Guide" ``` -## [Optional] Property `Document > category` +## `Document > category` **Title:** category @@ -955,7 +955,7 @@ List of categories/genres for the Document -## CatalogRecord +## Class CatalogRecord **Title:** CatalogRecord @@ -998,7 +998,7 @@ A record in a catalog, describing the registration of a single resource | - [title](#catalog-record--title) | null or string | title | | + [primaryTopic](#catalog-record--primaryTopic) | string | primary topic | -## [Optional] Property `CatalogRecord > @id` +## `CatalogRecord > @id` **Requirement:** Optional @@ -1012,7 +1012,7 @@ A record in a catalog, describing the registration of a single resource "https://example.gov/catalog-records/climate-dataset-record-001" ``` -## [Optional] Property `CatalogRecord > @type` +## `CatalogRecord > @type` **Requirement:** Optional @@ -1020,7 +1020,7 @@ A record in a catalog, describing the registration of a single resource | ----------- | ----------------- | | **Default** | `"CatalogRecord"` | -## [Optional] Property `CatalogRecord > status` +## `CatalogRecord > status` **Title:** change type @@ -1032,19 +1032,19 @@ The status of the catalog record in the context of editorial flow of the dataset | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | -------------------------------------------------- | | [Null allowed when not required](#catalog-record--status_anyOf_i0) | | [Concept](#catalog-record--status_anyOf_i1) | -### Property `CatalogRecord > status > anyOf > Null allowed when not required` +### `CatalogRecord > status > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `CatalogRecord > status > anyOf > Concept` +### `CatalogRecord > status > anyOf > Concept` **Title:** Concept @@ -1055,7 +1055,7 @@ inline description of status | **Additional properties** | Any type allowed | | **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | -## [Optional] Property `CatalogRecord > conformsTo` +## `CatalogRecord > conformsTo` **Title:** application profile @@ -1067,19 +1067,19 @@ An Application Profile that the Catalog Record's metadata conforms to | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------------------------ | | [Null allowed when not required](#catalog-record--conformsTo_anyOf_i0) | | [Standard](#catalog-record--conformsTo_anyOf_i1) | -### Property `CatalogRecord > conformsTo > anyOf > Null allowed when not required` +### `CatalogRecord > conformsTo > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `CatalogRecord > conformsTo > anyOf > Standard` +### `CatalogRecord > conformsTo > anyOf > Standard` **Title:** Standard @@ -1090,7 +1090,7 @@ inline description of application profile | **Additional properties** | Any type allowed | | **Defined in** | [Standard](./quality-governance.md#standard) | -## [Optional] Property `CatalogRecord > description` +## `CatalogRecord > description` **Title:** Descriptions @@ -1114,14 +1114,14 @@ A list of free-text accounts of the catalog record | ---------------------------------------- | ----------- | | [Description string](#catalog-record--description_items) | - | -### CatalogRecord > description > Description string +### Description string **Title:** Description string | **Type** | `string` | | -------- | -------- | -## [Optional] Property `CatalogRecord > issued` +## `CatalogRecord > issued` **Title:** listing date @@ -1162,7 +1162,7 @@ List of dates on which the catalog record was included in the catalog | ------------------------------- | ----------- | | [Date string](#catalog-record--issued_items) | - | -### CatalogRecord > issued > Date string +### Date string **Title:** Date string @@ -1170,26 +1170,26 @@ List of dates on which the catalog record was included in the catalog | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | -------------------------------- | | [item 0](#catalog-record--issued_items_anyOf_i0) | | [item 1](#catalog-record--issued_items_anyOf_i1) | | [item 2](#catalog-record--issued_items_anyOf_i2) | | [item 3](#catalog-record--issued_items_anyOf_i3) | -#### Property `CatalogRecord > issued > Date string > anyOf > item 0` +#### `CatalogRecord > issued > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `CatalogRecord > issued > Date string > anyOf > item 1` +#### `CatalogRecord > issued > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `CatalogRecord > issued > Date string > anyOf > item 2` +#### `CatalogRecord > issued > Date string > anyOf > item 2` A year in YYYY format @@ -1200,7 +1200,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `CatalogRecord > issued > Date string > anyOf > item 3` +#### `CatalogRecord > issued > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -1211,7 +1211,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `CatalogRecord > language` +## `CatalogRecord > language` **Title:** language @@ -1236,20 +1236,20 @@ Language code used in catalog record metadata text, using ISO 639-1 values such ] ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#catalog-record--language_anyOf_i0) | | [Language code](#catalog-record--language_anyOf_i1) | | [Array of language codes](#catalog-record--language_anyOf_i2) | -### Property `CatalogRecord > language > anyOf > Null allowed when not required` +### `CatalogRecord > language > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `CatalogRecord > language > anyOf > Language code` +### `CatalogRecord > language > anyOf > Language code` **Title:** Language code @@ -1260,7 +1260,7 @@ Language code used in catalog record metadata text, using ISO 639-1 values such | -------------- | - | | **Max length** | 2 | -### Property `CatalogRecord > language > anyOf > Array of language codes` +### `CatalogRecord > language > anyOf > Array of language codes` **Title:** Array of language codes @@ -1271,7 +1271,7 @@ Language code used in catalog record metadata text, using ISO 639-1 values such | ----------------------------------------- | ----------- | | [Language code](#catalog-record--language_anyOf_i2_items) | - | -#### CatalogRecord > language > anyOf > Array of language codes > Language code +#### Language code **Title:** Language code @@ -1282,7 +1282,7 @@ Language code used in catalog record metadata text, using ISO 639-1 values such | -------------- | - | | **Max length** | 2 | -## [Optional] Property `CatalogRecord > modified` +## `CatalogRecord > modified` **Title:** update/modification date @@ -1313,26 +1313,26 @@ The most recent date on which the catalog record was changed or modified "2024-01" ``` -| Any of(Option) | +| Any of | | ---------------------------- | | [item 0](#catalog-record--modified_anyOf_i0) | | [item 1](#catalog-record--modified_anyOf_i1) | | [item 2](#catalog-record--modified_anyOf_i2) | | [item 3](#catalog-record--modified_anyOf_i3) | -### Property `CatalogRecord > modified > anyOf > item 0` +### `CatalogRecord > modified > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -### Property `CatalogRecord > modified > anyOf > item 1` +### `CatalogRecord > modified > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -### Property `CatalogRecord > modified > anyOf > item 2` +### `CatalogRecord > modified > anyOf > item 2` A year in YYYY format @@ -1343,7 +1343,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -### Property `CatalogRecord > modified > anyOf > item 3` +### `CatalogRecord > modified > anyOf > item 3` A year and month in YYYY-MM format @@ -1354,7 +1354,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `CatalogRecord > source` +## `CatalogRecord > source` **Title:** source metadata @@ -1371,7 +1371,7 @@ The original metadata that was used in creating metadata for the items in the ca "Original metadata harvested from NOAA data portal" ``` -## [Optional] Property `CatalogRecord > title` +## `CatalogRecord > title` **Title:** title @@ -1392,7 +1392,7 @@ A name given to the Catalog Record "Climate Data 2023 Catalog Record" ``` -## [Optional] Property `CatalogRecord > primaryTopic` +## `CatalogRecord > primaryTopic` **Title:** primary topic @@ -1418,7 +1418,7 @@ A link to the Dataset, Data service or Catalog described in the Catalog Record -## DataService +## Class DataService **Title:** DataService @@ -1509,7 +1509,7 @@ A service that provides access to data or data processing functions | - [qualifiedAttribution](#data-service--qualifiedAttribution) | null or array | qualified attribution | | - [wasUsedBy](#data-service--wasUsedBy) | null or array | was used by | -## [Optional] Property `DataService > @id` +## `DataService > @id` **Requirement:** Optional @@ -1523,7 +1523,7 @@ A service that provides access to data or data processing functions "https://example.gov/data-services/climate-api-001" ``` -## [Optional] Property `DataService > @type` +## `DataService > @type` **Requirement:** Optional @@ -1531,7 +1531,7 @@ A service that provides access to data or data processing functions | ----------- | --------------- | | **Default** | `"DataService"` | -## [Optional] Property `DataService > contactPoint` +## `DataService > contactPoint` **Title:** contact point @@ -1547,7 +1547,7 @@ Contact information for questions about the Data Service. Include an email addre | ------------------------------- | ----------------------------------------------- | | [Kind](./agents.md#kind) | Contact information for an individual or entity | -## [Optional] Property `DataService > endpointDescription` +## `DataService > endpointDescription` **Title:** endpoint description @@ -1576,12 +1576,12 @@ List of endpoint descriptions with operations and parameters (for example, OpenA | ------------------------------------------------------- | ----------- | | [endpointDescription items](#data-service--endpointDescription_items) | - | -### DataService > endpointDescription > endpointDescription items +### Array Item | **Type** | `string` | | -------- | -------- | -## [Optional] Property `DataService > endpointURL` +## `DataService > endpointURL` **Title:** endpoint URL @@ -1612,7 +1612,7 @@ A list of root locations or primary endpoints of the service (a Web-resolvable I | ------------------------------- | --------------------------------------------------------------------------- | | [URLs](#data-service--endpointURL_items) | The root location or primary endpoint of the service (a Web-resolvable IRI) | -### DataService > endpointURL > URLs +### URLs **Title:** URLs @@ -1622,7 +1622,7 @@ The root location or primary endpoint of the service (a Web-resolvable IRI) | ---------- | -------- | | **Format** | `iri` | -## [Optional] Property `DataService > keyword` +## `DataService > keyword` **Title:** keyword/tag @@ -1657,7 +1657,7 @@ List of keywords or tags describing the data service | ----------------------------------- | ----------- | | [Non-empty strings](#data-service--keyword_items) | - | -### DataService > keyword > Non-empty strings +### Non-empty strings **Title:** Non-empty strings @@ -1668,7 +1668,7 @@ List of keywords or tags describing the data service | -------------- | - | | **Min length** | 1 | -## [Optional] Property `DataService > servesDataset` +## `DataService > servesDataset` **Title:** serves dataset @@ -1683,7 +1683,7 @@ List of datasets this service provides access to | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## [Optional] Property `DataService > spatialResolutionInMeters` +## `DataService > spatialResolutionInMeters` **Title:** spatial resolution in meters @@ -1700,7 +1700,7 @@ The minimum spatial separation resolvable in a Data Service, measured in meters "1000" ``` -## [Optional] Property `DataService > temporalResolution` +## `DataService > temporalResolution` **Title:** temporal resolution @@ -1717,7 +1717,7 @@ The minimum time period resolvable by the Data Service "P1D" ``` -## [Optional] Property `DataService > theme` +## `DataService > theme` **Title:** theme/category @@ -1732,7 +1732,7 @@ List of themes or categories for the data service | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `DataService > accessRights` +## `DataService > accessRights` **Title:** access rights @@ -1750,24 +1750,24 @@ Information about whether the data service is publicly accessible, restricted, o "Public access with no restrictions" ``` -| Any of(Option) | +| Any of | | -------------------------------- | | [item 0](#data-service--accessRights_anyOf_i0) | | [item 1](#data-service--accessRights_anyOf_i1) | -### Property `DataService > accessRights > anyOf > item 0` +### `DataService > accessRights > anyOf > item 0` | **Type** | `null` | | -------- | ------ | -### Property `DataService > accessRights > anyOf > item 1` +### `DataService > accessRights > anyOf > item 1` Text description of the access rights | **Type** | `string` | | -------- | -------- | -## [Optional] Property `DataService > conformsTo` +## `DataService > conformsTo` **Title:** conforms to @@ -1782,7 +1782,7 @@ List of general standards or specifications that the Data Service endpoints impl | -------------------------------------------- | ------------------------------------------------------------- | | [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | -## [Optional] Property `DataService > created` +## `DataService > created` **Title:** creation date @@ -1812,17 +1812,17 @@ The date on which the Data Service was first created "2024-01" ``` -| Any of(Option) | +| Any of | | -------------------------------- | | [item 0](#data-service--created_anyOf_i0) | | [Date string](#data-service--created_anyOf_i1) | -### Property `DataService > created > anyOf > item 0` +### `DataService > created > anyOf > item 0` | **Type** | `null` | | -------- | ------ | -### Property `DataService > created > anyOf > Date string` +### `DataService > created > anyOf > Date string` **Title:** Date string @@ -1830,26 +1830,26 @@ The date on which the Data Service was first created | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------ | | [item 0](#data-service--created_anyOf_i1_anyOf_i0) | | [item 1](#data-service--created_anyOf_i1_anyOf_i1) | | [item 2](#data-service--created_anyOf_i1_anyOf_i2) | | [item 3](#data-service--created_anyOf_i1_anyOf_i3) | -#### Property `DataService > created > anyOf > Date string > anyOf > item 0` +#### `DataService > created > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `DataService > created > anyOf > Date string > anyOf > item 1` +#### `DataService > created > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `DataService > created > anyOf > Date string > anyOf > item 2` +#### `DataService > created > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -1860,7 +1860,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `DataService > created > anyOf > Date string > anyOf > item 3` +#### `DataService > created > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -1871,7 +1871,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `DataService > creator` +## `DataService > creator` **Title:** creator @@ -1886,7 +1886,7 @@ List of agents primarily responsible for producing the Data Service | ------------------------------- | -------------------------------------------------------------------------------- | | [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | -## [Optional] Property `DataService > description` +## `DataService > description` **Title:** description @@ -1903,7 +1903,7 @@ Plain-language summary of the data service "A RESTful API providing access to historical and real-time climate data including temperature, precipitation, and atmospheric conditions." ``` -## [Optional] Property `DataService > identifier` +## `DataService > identifier` **Title:** identifier @@ -1915,17 +1915,17 @@ The unique identifier for the Data Service, e.g. the URI or other unique identif | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ---------------------------------- | | [item 0](#data-service--identifier_anyOf_i0) | | [Identifier](#data-service--identifier_anyOf_i1) | -### Property `DataService > identifier > anyOf > item 0` +### `DataService > identifier > anyOf > item 0` | **Type** | `null` | | -------- | ------ | -### Property `DataService > identifier > anyOf > Identifier` +### `DataService > identifier > anyOf > Identifier` **Title:** Identifier @@ -1936,7 +1936,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | -## [Optional] Property `DataService > otherIdentifier` +## `DataService > otherIdentifier` **Title:** other identifier @@ -1951,7 +1951,7 @@ A list of identifiers for the Data Service besides the main identifier, e.g. the | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## [Optional] Property `DataService > language` +## `DataService > language` **Title:** language @@ -1976,20 +1976,20 @@ ISO 639-1 language code values supported by the data service, such as en or es, ] ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#data-service--language_anyOf_i0) | | [Language code](#data-service--language_anyOf_i1) | | [List of lanuages](#data-service--language_anyOf_i2) | -### Property `DataService > language > anyOf > Null allowed when not required` +### `DataService > language > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DataService > language > anyOf > Language code` +### `DataService > language > anyOf > Language code` **Title:** Language code @@ -2000,7 +2000,7 @@ ISO 639-1 language code values supported by the data service, such as en or es, | -------------- | - | | **Max length** | 2 | -### Property `DataService > language > anyOf > List of lanuages` +### `DataService > language > anyOf > List of lanuages` **Title:** List of lanuages @@ -2011,7 +2011,7 @@ ISO 639-1 language code values supported by the data service, such as en or es, | ----------------------------------------- | ----------- | | [Language code](#data-service--language_anyOf_i2_items) | - | -#### DataService > language > anyOf > List of lanuages > Language code +#### Language code **Title:** Language code @@ -2022,7 +2022,7 @@ ISO 639-1 language code values supported by the data service, such as en or es, | -------------- | - | | **Max length** | 2 | -## [Optional] Property `DataService > license` +## `DataService > license` **Title:** license @@ -2040,26 +2040,26 @@ License that governs how the data service can be used or reused "https://creativecommons.org/publicdomain/zero/1.0/" ``` -| Any of(Option) | +| Any of | | --------------------------------------------------- | | [Null allowed when not required](#data-service--license_anyOf_i0) | | [item 1](#data-service--license_anyOf_i1) | -### Property `DataService > license > anyOf > Null allowed when not required` +### `DataService > license > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DataService > license > anyOf > item 1` +### `DataService > license > anyOf > item 1` Full text of the license | **Type** | `string` | | -------- | -------- | -## [Optional] Property `DataService > modified` +## `DataService > modified` **Title:** update/modification date @@ -2089,19 +2089,19 @@ The most recent date on which the Data Service was changed or modified "2024-01" ``` -| Any of(Option) | +| Any of | | ---------------------------------------------------- | | [Null allowed when not required](#data-service--modified_anyOf_i0) | | [Date string](#data-service--modified_anyOf_i1) | -### Property `DataService > modified > anyOf > Null allowed when not required` +### `DataService > modified > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `DataService > modified > anyOf > Date string` +### `DataService > modified > anyOf > Date string` **Title:** Date string @@ -2109,26 +2109,26 @@ The most recent date on which the Data Service was changed or modified | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------- | | [item 0](#data-service--modified_anyOf_i1_anyOf_i0) | | [item 1](#data-service--modified_anyOf_i1_anyOf_i1) | | [item 2](#data-service--modified_anyOf_i1_anyOf_i2) | | [item 3](#data-service--modified_anyOf_i1_anyOf_i3) | -#### Property `DataService > modified > anyOf > Date string > anyOf > item 0` +#### `DataService > modified > anyOf > Date string > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `DataService > modified > anyOf > Date string > anyOf > item 1` +#### `DataService > modified > anyOf > Date string > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `DataService > modified > anyOf > Date string > anyOf > item 2` +#### `DataService > modified > anyOf > Date string > anyOf > item 2` A year in YYYY format @@ -2139,7 +2139,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `DataService > modified > anyOf > Date string > anyOf > item 3` +#### `DataService > modified > anyOf > Date string > anyOf > item 3` A year and month in YYYY-MM format @@ -2150,7 +2150,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `DataService > publisher` +## `DataService > publisher` **Title:** publisher @@ -2164,7 +2164,7 @@ Person or organization responsible for publishing and making the data service av | **Additional properties** | Any type allowed | | **Defined in** | [Agent](./agents.md#agent) | -## [Optional] Property `DataService > rights` +## `DataService > rights` **Title:** rights @@ -2187,12 +2187,12 @@ Rights statements not already covered by license or accessRights, such as copyri | ------------------------------- | ----------- | | [rights items](#data-service--rights_items) | - | -### DataService > rights > rights items +### Array Item | **Type** | `string` | | -------- | -------- | -## [Optional] Property `DataService > rightsHolder` +## `DataService > rightsHolder` **Title:** rights holder @@ -2207,7 +2207,7 @@ A list of Agents (organizations) holding rights on the Data Service | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## [Optional] Property `DataService > spatial` +## `DataService > spatial` **Title:** spatial/geographic coverage @@ -2222,7 +2222,7 @@ A geographic region that is covered by the Data Service | -------------------------------------------------- | -------------------------------- | | [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | -## [Optional] Property `DataService > temporal` +## `DataService > temporal` **Title:** temporal coverage @@ -2237,7 +2237,7 @@ Time periods covered by the data service | ------------------------------------------------------------ | ---------------------------------------------------------------------- | | [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | -## [Optional] Property `DataService > title` +## `DataService > title` **Title:** title @@ -2255,7 +2255,7 @@ Human-readable title of the data service "Climate Data REST API" ``` -## [Optional] Property `DataService > category` +## `DataService > category` **Title:** category @@ -2270,7 +2270,7 @@ List of high-level categories for the data service | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `DataService > hasQualityMeasurement` +## `DataService > hasQualityMeasurement` **Title:** quality measurement @@ -2285,7 +2285,7 @@ Quality measurements for the data service (for example, availability, response t | ----------------------------------------------------------------------- | ------------------------------------------------------------- | | [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) | A measurement of a resource against a specific quality metric | -## [Optional] Property `DataService > qualifiedAttribution` +## `DataService > qualifiedAttribution` **Title:** qualified attribution @@ -2300,7 +2300,7 @@ List of agents with specific responsibilities for the data service | -------------------------------------------------- | ------------------------------------------------- | | [Attribution](./quality-governance.md#attribution) | A responsibility that an agent has for a resource | -## [Optional] Property `DataService > wasUsedBy` +## `DataService > wasUsedBy` **Title:** was used by @@ -2319,7 +2319,7 @@ List of activities that used or tested the data service -## Attribution +## Class Attribution **Title:** Attribution @@ -2348,7 +2348,7 @@ A responsibility that an agent has for a resource | + [hadRole](#attribution--hadRole) | string | role | | + [agent](#attribution--agent) | object | agent | -## [Optional] Property `Attribution > @id` +## `Attribution > @id` **Requirement:** Optional @@ -2362,7 +2362,7 @@ A responsibility that an agent has for a resource "https://example.gov/attributions/dataset-steward-001" ``` -## [Optional] Property `Attribution > @type` +## `Attribution > @type` **Requirement:** Optional @@ -2370,7 +2370,7 @@ A responsibility that an agent has for a resource | ----------- | --------------- | | **Default** | `"Attribution"` | -## [Optional] Property `Attribution > hadRole` +## `Attribution > hadRole` **Title:** role @@ -2388,7 +2388,7 @@ The function of an entity or agent with respect to another entity or resource "Data Steward" ``` -## [Optional] Property `Attribution > agent` +## `Attribution > agent` **Title:** agent diff --git a/jsonschema/docs/temporal-spatial-metrics.md b/jsonschema/docs/temporal-spatial-metrics.md index c7e184c0..77630726 100644 --- a/jsonschema/docs/temporal-spatial-metrics.md +++ b/jsonschema/docs/temporal-spatial-metrics.md @@ -4,7 +4,7 @@ Supporting classes for time periods, locations, quality metrics, measurements, a -## PeriodOfTime +## Class PeriodOfTime **Title:** PeriodOfTime @@ -31,12 +31,12 @@ Information about a specific time period with a start- and/or end-time | - [endDate](#period-of-time--endDate) | More than one type | end date | | - [startDate](#period-of-time--startDate) | More than one type | start date | -| Any of(Option) | +| Any of | | ------------------- | | [item 0](#period-of-time--anyOf_i0) | | [item 1](#period-of-time--anyOf_i1) | -## Property `PeriodOfTime > anyOf > item 0` +## `PeriodOfTime > anyOf > item 0` | **Type** | `object` | | ------------------------- | ---------------- | @@ -45,7 +45,7 @@ Information about a specific time period with a start- and/or end-time ### The following properties are required * startDate -## Property `PeriodOfTime > anyOf > item 1` +## `PeriodOfTime > anyOf > item 1` | **Type** | `object` | | ------------------------- | ---------------- | @@ -54,7 +54,7 @@ Information about a specific time period with a start- and/or end-time ### The following properties are required * endDate -## [Optional] Property `PeriodOfTime > @id` +## `PeriodOfTime > @id` **Requirement:** Optional @@ -68,7 +68,7 @@ Information about a specific time period with a start- and/or end-time "https://example.gov/periods/fiscal-year-2024" ``` -## [Optional] Property `PeriodOfTime > @type` +## `PeriodOfTime > @type` **Requirement:** Optional @@ -76,7 +76,7 @@ Information about a specific time period with a start- and/or end-time | ----------- | ---------------- | | **Default** | `"PeriodOfTime"` | -## [Optional] Property `PeriodOfTime > endDate` +## `PeriodOfTime > endDate` **Title:** end date @@ -106,44 +106,44 @@ The end date of the period of time "2024-01" ``` -| Any of(Option) | +| Any of | | --------------------------------------------------- | | [Null allowed when not required](#period-of-time--endDate_anyOf_i0) | | [item 1](#period-of-time--endDate_anyOf_i1) | -### Property `PeriodOfTime > endDate > anyOf > Null allowed when not required` +### `PeriodOfTime > endDate > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `PeriodOfTime > endDate > anyOf > item 1` +### `PeriodOfTime > endDate > anyOf > item 1` | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ------------------------------------ | | [item 0](#period-of-time--endDate_anyOf_i1_anyOf_i0) | | [item 1](#period-of-time--endDate_anyOf_i1_anyOf_i1) | | [item 2](#period-of-time--endDate_anyOf_i1_anyOf_i2) | | [item 3](#period-of-time--endDate_anyOf_i1_anyOf_i3) | -#### Property `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 0` +#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 1` +#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 2` +#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 2` A year in YYYY format @@ -154,7 +154,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 3` +#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 3` A year and month in YYYY-MM format @@ -165,7 +165,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## [Optional] Property `PeriodOfTime > startDate` +## `PeriodOfTime > startDate` **Title:** start date @@ -195,44 +195,44 @@ The start date of the period of time "2024-01" ``` -| Any of(Option) | +| Any of | | ----------------------------------------------------- | | [Null allowed when not required](#period-of-time--startDate_anyOf_i0) | | [item 1](#period-of-time--startDate_anyOf_i1) | -### Property `PeriodOfTime > startDate > anyOf > Null allowed when not required` +### `PeriodOfTime > startDate > anyOf > Null allowed when not required` **Title:** Null allowed when not required | **Type** | `null` | | -------- | ------ | -### Property `PeriodOfTime > startDate > anyOf > item 1` +### `PeriodOfTime > startDate > anyOf > item 1` | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | -------------------------------------- | | [item 0](#period-of-time--startDate_anyOf_i1_anyOf_i0) | | [item 1](#period-of-time--startDate_anyOf_i1_anyOf_i1) | | [item 2](#period-of-time--startDate_anyOf_i1_anyOf_i2) | | [item 3](#period-of-time--startDate_anyOf_i1_anyOf_i3) | -#### Property `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 0` +#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 0` | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### Property `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 1` +#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 1` | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### Property `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 2` +#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 2` A year in YYYY format @@ -243,7 +243,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### Property `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 3` +#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 3` A year and month in YYYY-MM format @@ -258,7 +258,7 @@ A year and month in YYYY-MM format -## Location +## Class Location **Title:** Location @@ -391,7 +391,7 @@ A named place or geographic area | - [altLabel](#location--altLabel) | null or string | alternative name | | - [prefLabel](#location--prefLabel) | null or string | geographic name | -## [Optional] Property `Location > @id` +## `Location > @id` **Requirement:** Optional @@ -405,7 +405,7 @@ A named place or geographic area "https://example.gov/locations/washington-dc" ``` -## [Optional] Property `Location > @type` +## `Location > @type` **Requirement:** Optional @@ -413,7 +413,7 @@ A named place or geographic area | ----------- | ------------ | | **Default** | `"Location"` | -## [Optional] Property `Location > bbox` +## `Location > bbox` **Title:** bounding box @@ -461,25 +461,25 @@ Bounding box for the location, described in WKT, GeoJSON, or GML format } ``` -| Any of(Option) | +| Any of | | ------------------------ | | [item 0](#location--bbox_anyOf_i0) | | [item 1](#location--bbox_anyOf_i1) | | [item 2](#location--bbox_anyOf_i2) | -### Property `Location > bbox > anyOf > item 0` +### `Location > bbox > anyOf > item 0` | **Type** | `null` | | -------- | ------ | -### Property `Location > bbox > anyOf > item 1` +### `Location > bbox > anyOf > item 1` Bounding box represented in WKT, GeoJSON (stringified), or GML format | **Type** | `string` | | -------- | -------- | -### Property `Location > bbox > anyOf > item 2` +### `Location > bbox > anyOf > item 2` Bounding box represented in GeoJSON format, either as a Polygon or in bbox array format @@ -492,7 +492,7 @@ Bounding box represented in GeoJSON format, either as a Polygon or in bbox array | + [coordinates](#location--bbox_anyOf_i2_coordinates) | array | - | | + [type](#location--bbox_anyOf_i2_type) | const | - | -#### Property `Location > bbox > anyOf > item 2 > coordinates` +#### `Location > bbox > anyOf > item 2 > coordinates` **Requirement:** Optional @@ -500,7 +500,7 @@ Bounding box represented in GeoJSON format, either as a Polygon or in bbox array | ------------ | ------- | | **Required** | Yes | -#### Property `Location > bbox > anyOf > item 2 > type` +#### `Location > bbox > anyOf > item 2 > type` **Requirement:** Optional @@ -510,7 +510,7 @@ Bounding box represented in GeoJSON format, either as a Polygon or in bbox array Specific value: `"Polygon"` -## [Optional] Property `Location > centroid` +## `Location > centroid` **Title:** centroid @@ -534,25 +534,25 @@ The geographic center (centroid) of a location described in WKT, GeoJSON, or GML } ``` -| Any of(Option) | +| Any of | | ---------------------------- | | [item 0](#location--centroid_anyOf_i0) | | [item 1](#location--centroid_anyOf_i1) | | [item 2](#location--centroid_anyOf_i2) | -### Property `Location > centroid > anyOf > item 0` +### `Location > centroid > anyOf > item 0` | **Type** | `null` | | -------- | ------ | -### Property `Location > centroid > anyOf > item 1` +### `Location > centroid > anyOf > item 1` Center point represented in WKT, GeoJSON (stringified), or GML format | **Type** | `string` | | -------- | -------- | -### Property `Location > centroid > anyOf > item 2` +### `Location > centroid > anyOf > item 2` Centroid represented in GeoJSON format; force point usage with coordinates of longitude and latitude @@ -565,7 +565,7 @@ Centroid represented in GeoJSON format; force point usage with coordinates of lo | + [coordinates](#location--centroid_anyOf_i2_coordinates) | array of number | - | | + [type](#location--centroid_anyOf_i2_type) | const | - | -#### Property `Location > centroid > anyOf > item 2 > coordinates` +#### `Location > centroid > anyOf > item 2 > coordinates` **Requirement:** Optional @@ -577,12 +577,12 @@ Centroid represented in GeoJSON format; force point usage with coordinates of lo | --------------------------------------------------------- | ----------- | | [coordinates items](#location--centroid_anyOf_i2_coordinates_items) | - | -##### Location > centroid > anyOf > item 2 > coordinates > coordinates items +##### Array Item | **Type** | `number` | | -------- | -------- | -#### Property `Location > centroid > anyOf > item 2 > type` +#### `Location > centroid > anyOf > item 2 > type` **Requirement:** Optional @@ -592,7 +592,7 @@ Centroid represented in GeoJSON format; force point usage with coordinates of lo Specific value: `"Point"` -## [Optional] Property `Location > identifier` +## `Location > identifier` **Title:** identifier @@ -604,17 +604,17 @@ The unique geographic identifier for the Location, e.g., the URI or other unique | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ---------------------------------- | | [item 0](#location--identifier_anyOf_i0) | | [Identifier](#location--identifier_anyOf_i1) | -### Property `Location > identifier > anyOf > item 0` +### `Location > identifier > anyOf > item 0` | **Type** | `null` | | -------- | ------ | -### Property `Location > identifier > anyOf > Identifier` +### `Location > identifier > anyOf > Identifier` **Title:** Identifier @@ -625,7 +625,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | -## [Optional] Property `Location > otherIdentifier` +## `Location > otherIdentifier` **Title:** other identifier @@ -640,7 +640,7 @@ A list of geographic identifiers for the Location besides the main identifier, e | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## [Optional] Property `Location > geometry` +## `Location > geometry` **Title:** geometry @@ -708,25 +708,25 @@ Associates a location with a corresponding geometry described in WKT, GeoJSON, o } ``` -| Any of(Option) | +| Any of | | ---------------------------- | | [item 0](#location--geometry_anyOf_i0) | | [item 1](#location--geometry_anyOf_i1) | | [item 2](#location--geometry_anyOf_i2) | -### Property `Location > geometry > anyOf > item 0` +### `Location > geometry > anyOf > item 0` | **Type** | `null` | | -------- | ------ | -### Property `Location > geometry > anyOf > item 1` +### `Location > geometry > anyOf > item 1` String format of the full geometry of the location in WKT, GeoJSON, or GML format | **Type** | `string` | | -------- | -------- | -### Property `Location > geometry > anyOf > item 2` +### `Location > geometry > anyOf > item 2` Geometry represented in GeoJSON format @@ -738,7 +738,7 @@ Geometry represented in GeoJSON format * type * coordinates -## [Optional] Property `Location > inScheme` +## `Location > inScheme` **Title:** gazetteer @@ -750,17 +750,17 @@ The gazetteer to which the location belongs | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | -| Any of(Option) | +| Any of | | ----------------------------------- | | [item 0](#location--inScheme_anyOf_i0) | | [ConceptScheme](#location--inScheme_anyOf_i1) | -### Property `Location > inScheme > anyOf > item 0` +### `Location > inScheme > anyOf > item 0` | **Type** | `null` | | -------- | ------ | -### Property `Location > inScheme > anyOf > ConceptScheme` +### `Location > inScheme > anyOf > ConceptScheme` **Title:** ConceptScheme @@ -771,7 +771,7 @@ inline description of the gazetteer | **Additional properties** | Any type allowed | | **Defined in** | [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) | -## [Optional] Property `Location > altLabel` +## `Location > altLabel` **Title:** alternative name @@ -788,7 +788,7 @@ An alternative label or name for a location "DC" ``` -## [Optional] Property `Location > prefLabel` +## `Location > prefLabel` **Title:** geographic name @@ -813,7 +813,7 @@ Preferred label or name of the Location -## Metric +## Class Metric **Title:** Metric @@ -842,7 +842,7 @@ A standard used to measure one aspect of data quality | + [inDimension](#metric--inDimension) | string | in dimension | | - [definition](#metric--definition) | null or string | definition | -## [Optional] Property `Metric > @id` +## `Metric > @id` **Requirement:** Optional @@ -856,7 +856,7 @@ A standard used to measure one aspect of data quality "https://example.gov/metrics/record-completeness" ``` -## [Optional] Property `Metric > @type` +## `Metric > @type` **Requirement:** Optional @@ -864,7 +864,7 @@ A standard used to measure one aspect of data quality | ----------- | ---------- | | **Default** | `"Metric"` | -## [Optional] Property `Metric > expectedDataType` +## `Metric > expectedDataType` **Title:** expected datatype @@ -886,7 +886,7 @@ Represents the expected data type for the metric's observed value (e.g., xsd:boo "xsd:double" ``` -## [Optional] Property `Metric > inDimension` +## `Metric > inDimension` **Title:** in dimension @@ -908,7 +908,7 @@ Represents the dimensions a quality metric, certificate and annotation allow a m "https://www.w3.org/TR/vocab-dqv/#dqv:completeness" ``` -## [Optional] Property `Metric > definition` +## `Metric > definition` **Title:** definition @@ -933,7 +933,7 @@ Definition of the metric. -## QualityMeasurement +## Class QualityMeasurement **Title:** QualityMeasurement @@ -965,7 +965,7 @@ A measurement of a resource against a specific quality metric | + [value](#quality-measurement--value) | string | value | | - [unitMeasure](#quality-measurement--unitMeasure) | null or string | unit of measure | -## [Optional] Property `QualityMeasurement > @id` +## `QualityMeasurement > @id` **Requirement:** Optional @@ -979,7 +979,7 @@ A measurement of a resource against a specific quality metric "https://example.gov/quality-measurements/completeness-001" ``` -## [Optional] Property `QualityMeasurement > @type` +## `QualityMeasurement > @type` **Requirement:** Optional @@ -987,7 +987,7 @@ A measurement of a resource against a specific quality metric | ----------- | ---------------------- | | **Default** | `"QualityMeasurement"` | -## [Optional] Property `QualityMeasurement > isMeasurementOf` +## `QualityMeasurement > isMeasurementOf` **Title:** is measurement of @@ -1001,7 +1001,7 @@ The metric being observed | **Additional properties** | Any type allowed | | **Defined in** | [Metric](./temporal-spatial-metrics.md#metric) | -## [Optional] Property `QualityMeasurement > value` +## `QualityMeasurement > value` **Title:** value @@ -1019,7 +1019,7 @@ The value computed by metric "98.5" ``` -## [Optional] Property `QualityMeasurement > unitMeasure` +## `QualityMeasurement > unitMeasure` **Title:** unit of measure @@ -1040,7 +1040,7 @@ Unit of measure associated with the value -## Activity +## Class Activity **Title:** Activity @@ -1069,7 +1069,7 @@ An activity related to creating, changing, or using a resource | - [category](#activity--category) | null or array | category | | + [label](#activity--label) | string | label | -## [Optional] Property `Activity > @id` +## `Activity > @id` **Requirement:** Optional @@ -1083,7 +1083,7 @@ An activity related to creating, changing, or using a resource "https://example.gov/activities/data-processing-001" ``` -## [Optional] Property `Activity > @type` +## `Activity > @type` **Requirement:** Optional @@ -1091,7 +1091,7 @@ An activity related to creating, changing, or using a resource | ----------- | ------------ | | **Default** | `"Activity"` | -## [Optional] Property `Activity > category` +## `Activity > category` **Title:** category @@ -1106,7 +1106,7 @@ List of categories for the Activity | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## [Optional] Property `Activity > label` +## `Activity > label` **Title:** label @@ -1132,7 +1132,7 @@ A human-readable label for the activity -## Address +## Class Address **Title:** Address @@ -1165,7 +1165,7 @@ A single physical address | - [region](#address--region) | null or string | administrative area | | - [street-address](#address--street-address) | null or string | street address | -## [Optional] Property `Address > @id` +## `Address > @id` **Requirement:** Optional @@ -1179,7 +1179,7 @@ A single physical address "https://example.gov/addresses/hq-001" ``` -## [Optional] Property `Address > @type` +## `Address > @type` **Requirement:** Optional @@ -1187,7 +1187,7 @@ A single physical address | ----------- | ----------- | | **Default** | `"Address"` | -## [Optional] Property `Address > country-name` +## `Address > country-name` **Title:** country @@ -1204,7 +1204,7 @@ The country of the Address "United States" ``` -## [Optional] Property `Address > locality` +## `Address > locality` **Title:** locality @@ -1225,7 +1225,7 @@ The city of the Address "Washington" ``` -## [Optional] Property `Address > postal-code` +## `Address > postal-code` **Title:** postal code @@ -1246,7 +1246,7 @@ The postal code of the Address "20230" ``` -## [Optional] Property `Address > region` +## `Address > region` **Title:** administrative area @@ -1267,7 +1267,7 @@ The administrative area of the Address. Depending on the country, this correspon "DC" ``` -## [Optional] Property `Address > street-address` +## `Address > street-address` **Title:** street address diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index bba8d85c..69984ed0 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -335,7 +335,7 @@ def _build_public_docs(rendered_docs_dir, output_dir): root_anchor=section_anchor, ) sections.append( - f'\n\n## {class_name}\n\n{section_content}' + f'\n\n## Class {class_name}\n\n{section_content}' ) page_content = "\n\n---\n\n".join(sections) @@ -385,12 +385,6 @@ def schema_requirement_level(schema): return _normalize_requirement_level(old_docs.get("requirementLevel")) -def requirement_badge(schema): - """Template helper that formats requirement level as an inline badge.""" - requirement = schema_requirement_level(schema) - return f"[{requirement}]" - - def properties_table_wrap(properties_list, schema): """Edit the properties list for our preferred format. @@ -497,7 +491,6 @@ def _render_raw_docs(output_dir): template_renderer.template.environment.filters["schema_requirement_level"] = ( schema_requirement_level ) - template_renderer.template.environment.filters["requirement_badge"] = requirement_badge template_renderer.template.environment.filters["md_properties_table"] = ( lambda schema: properties_table_wrap( original_md_properties_table(schema), From 02f3d51d189fc1ad12f63bc0a47dd77b36963b8a Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 22:04:52 -0600 Subject: [PATCH 05/13] Make requirement level more explicit in the class summary table. Co-authored-by: Copilot --- jsonschema/docs/agents.md | 62 ++--- jsonschema/docs/catalog.md | 84 +++---- .../docs/constraints-and-restrictions.md | 54 ++--- jsonschema/docs/dataset-series.md | 52 ++--- jsonschema/docs/dataset.md | 148 ++++++------ jsonschema/docs/distribution.md | 96 ++++---- .../docs/identifiers-and-relationships.md | 92 ++++---- jsonschema/docs/quality-governance.md | 214 +++++++++--------- jsonschema/docs/temporal-spatial-metrics.md | 140 ++++++------ jsonschema/generate_schema_docs.py | 26 ++- 10 files changed, 495 insertions(+), 473 deletions(-) diff --git a/jsonschema/docs/agents.md b/jsonschema/docs/agents.md index 15dcb2c4..b76db950 100644 --- a/jsonschema/docs/agents.md +++ b/jsonschema/docs/agents.md @@ -26,12 +26,12 @@ A person, organization, software agent, or other entity involved with a resource } ``` -| Property | Type | Title/Description | -| ------------------------ | ------------- | ----------------- | -| - [@id](#agent--@id) | string | - | -| - [@type](#agent--@type) | string | - | -| - [category](#agent--category) | null or array | category | -| + [name](#agent--name) | string | name | +| Property | Type | Requirement Level | Title/Description | +| ---------------------- | ------------- | ----------------- | ----------------- | +| [@id](#agent--@id) | string | Optional | - | +| [@type](#agent--@type) | string | Optional | - | +| [category](#agent--category) | null or array | Optional | category | +| [name](#agent--name) | string | Mandatory | name | ## `Agent > @id` @@ -74,7 +74,7 @@ The type of the agent that makes the item available **Title:** name -**Requirement:** Optional +**Requirement:** Mandatory The name of the agent @@ -137,15 +137,15 @@ An organization involved with a resource, including parent or child organization } ``` -| Property | Type | Title/Description | -| ------------------------------------------ | ----------------------- | ------------------ | -| - [@id](#organization--@id) | string | - | -| - [@type](#organization--@type) | string | - | -| + [name](#organization--name) | string | name | -| - [subOrganizationOf](#organization--subOrganizationOf) | null or array | suborganization of | -| - [altLabel](#organization--altLabel) | null or string | alternative label | -| - [notation](#organization--notation) | null or array of string | notation | -| - [prefLabel](#organization--prefLabel) | null or string | preferred label | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------- | ----------------------- | ----------------- | ------------------ | +| [@id](#organization--@id) | string | Optional | - | +| [@type](#organization--@type) | string | Optional | - | +| [name](#organization--name) | string | Mandatory | name | +| [subOrganizationOf](#organization--subOrganizationOf) | null or array | Optional | suborganization of | +| [altLabel](#organization--altLabel) | null or string | Optional | alternative label | +| [notation](#organization--notation) | null or array of string | Optional | notation | +| [prefLabel](#organization--prefLabel) | null or string | Optional | preferred label | ## `Organization > @id` @@ -173,7 +173,7 @@ An organization involved with a resource, including parent or child organization **Title:** name -**Requirement:** Optional +**Requirement:** Mandatory The full name of the Organization @@ -309,18 +309,18 @@ Contact information for an individual or entity } ``` -| Property | Type | Title/Description | -| ------------------------------------------ | -------------- | ----------------- | -| - [@id](#kind--@id) | string | - | -| - [@type](#kind--@type) | string | - | -| - [address](#kind--address) | null or array | address | -| + [hasEmail](#kind--hasEmail) | string | Email | -| - [family-name](#kind--family-name) | null or string | family name | -| + [fn](#kind--fn) | string | formatted name | -| - [given-name](#kind--given-name) | null or string | given name | -| - [organization-name](#kind--organization-name) | null or string | organization name | -| - [tel](#kind--tel) | null or string | telephone | -| - [title](#kind--title) | null or string | position title | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------- | -------------- | ----------------- | ----------------- | +| [@id](#kind--@id) | string | Optional | - | +| [@type](#kind--@type) | string | Optional | - | +| [address](#kind--address) | null or array | Optional | address | +| [hasEmail](#kind--hasEmail) | string | Mandatory | Email | +| [family-name](#kind--family-name) | null or string | Optional | family name | +| [fn](#kind--fn) | string | Mandatory | formatted name | +| [given-name](#kind--given-name) | null or string | Optional | given name | +| [organization-name](#kind--organization-name) | null or string | Optional | organization name | +| [tel](#kind--tel) | null or string | Optional | telephone | +| [title](#kind--title) | null or string | Optional | position title | ## `Kind > @id` @@ -363,7 +363,7 @@ The address of the contact **Title:** Email -**Requirement:** Optional +**Requirement:** Mandatory Email address for the contact in mailto: format (for example, mailto:support@example.gov) @@ -406,7 +406,7 @@ The family name of the contact **Title:** formatted name -**Requirement:** Optional +**Requirement:** Mandatory The formatted text of the name of the contact diff --git a/jsonschema/docs/catalog.md b/jsonschema/docs/catalog.md index 62f98c41..d14a4327 100644 --- a/jsonschema/docs/catalog.md +++ b/jsonschema/docs/catalog.md @@ -69,39 +69,39 @@ A curated collection of metadata about datasets, data services, or other resourc } ``` -| Property | Type | Title/Description | -| ------------------------------------------------ | ----------------------- | --------------------------- | -| - [@id](#@id) | string | - | -| - [@type](#@type) | string | - | -| - [catalog](#catalog) | null or array | Related catalogs | -| - [contactPoint](#contactPoint) | null or array | Contact points | -| + [dataset](#dataset) | array | dataset | -| - [keyword](#keyword) | null or array of string | keyword/tag | -| - [record](#record) | null or array | catalog record | -| - [service](#service) | null or array | service | -| - [theme](#theme) | null or array | theme/category | -| - [themeTaxonomy](#themeTaxonomy) | null or array | themes | -| - [accessRights](#accessRights) | More than one type | access rights | -| - [conformsTo](#conformsTo) | More than one type | schema version | -| - [creator](#creator) | null or array | creator | -| - [description](#description) | null or string | description | -| - [hasPart](#hasPart) | null or array | has part | -| - [identifier](#identifier) | More than one type | identifier | -| - [otherIdentifier](#otherIdentifier) | null or array | other identifier | -| - [issued](#issued) | More than one type | release date | -| - [language](#language) | More than one type | language | -| - [license](#license) | More than one type | license | -| - [modified](#modified) | More than one type | update/modification date | -| - [publisher](#publisher) | More than one type | publisher | -| - [rights](#rights) | null or array of string | rights | -| - [rightsHolder](#rightsHolder) | null or array | rights holder | -| - [spatial](#spatial) | null or array | spatial/geographic coverage | -| - [subject](#subject) | null or array | subject | -| - [temporal](#temporal) | null or array | temporal coverage | -| - [title](#title) | null or string | title | -| - [category](#category) | null or array | category | -| - [homepage](#homepage) | More than one type | homepage | -| - [qualifiedAttribution](#qualifiedAttribution) | null or array | qualified attribution | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------------- | ----------------------- | ----------------- | --------------------------- | +| [@id](#@id) | string | Optional | - | +| [@type](#@type) | string | Optional | - | +| [catalog](#catalog) | null or array | Optional | Related catalogs | +| [contactPoint](#contactPoint) | null or array | Optional | Contact points | +| [dataset](#dataset) | array | Mandatory | dataset | +| [keyword](#keyword) | null or array of string | Optional | keyword/tag | +| [record](#record) | null or array | Optional | catalog record | +| [service](#service) | null or array | Optional | service | +| [theme](#theme) | null or array | Optional | theme/category | +| [themeTaxonomy](#themeTaxonomy) | null or array | Recommended | themes | +| [accessRights](#accessRights) | More than one type | Optional | access rights | +| [conformsTo](#conformsTo) | More than one type | Recommended | schema version | +| [creator](#creator) | null or array | Optional | creator | +| [description](#description) | null or string | Optional | description | +| [hasPart](#hasPart) | null or array | Optional | has part | +| [identifier](#identifier) | More than one type | Optional | identifier | +| [otherIdentifier](#otherIdentifier) | null or array | Optional | other identifier | +| [issued](#issued) | More than one type | Recommended | release date | +| [language](#language) | More than one type | Recommended | language | +| [license](#license) | More than one type | Optional | license | +| [modified](#modified) | More than one type | Recommended | update/modification date | +| [publisher](#publisher) | More than one type | Optional | publisher | +| [rights](#rights) | null or array of string | Recommended | rights | +| [rightsHolder](#rightsHolder) | null or array | Optional | rights holder | +| [spatial](#spatial) | null or array | Recommended | spatial/geographic coverage | +| [subject](#subject) | null or array | Optional | subject | +| [temporal](#temporal) | null or array | Optional | temporal coverage | +| [title](#title) | null or string | Optional | title | +| [category](#category) | null or array | Optional | category | +| [homepage](#homepage) | More than one type | Recommended | homepage | +| [qualifiedAttribution](#qualifiedAttribution) | null or array | Optional | qualified attribution | ## `DCAT-US 3 Catalog > @id` @@ -159,7 +159,7 @@ Contact information people can use to ask questions or send feedback about the c **Title:** dataset -**Requirement:** Optional +**Requirement:** Mandatory List of datasets included in the catalog. Use this together with service so the catalog is not empty. @@ -255,7 +255,7 @@ List of themes or categories for the catalog. A catalog can have more than one t **Title:** themes -**Requirement:** Optional +**Requirement:** Recommended Controlled vocabulary or taxonomy used to classify catalog resources, such as datasets and services @@ -307,7 +307,7 @@ Text description of the access rights **Title:** schema version -**Requirement:** Optional +**Requirement:** Recommended Standard, schema, profile, or model that this catalog follows @@ -443,7 +443,7 @@ A list of identifiers for the Catalog besides the main identifier, e.g. the URI **Title:** release date -**Requirement:** Optional +**Requirement:** Recommended Date when the catalog was formally issued, such as its initial publication date @@ -534,7 +534,7 @@ A year and month in YYYY-MM format **Title:** language -**Requirement:** Optional +**Requirement:** Recommended Language codes used for catalog metadata text (such as titles and descriptions), using ISO 639-1 codes like en or es @@ -644,7 +644,7 @@ Full text of the license **Title:** update/modification date -**Requirement:** Optional +**Requirement:** Recommended Most recent date when the catalog content changed, not just catalog-record metadata @@ -770,7 +770,7 @@ inline description of the publisher **Title:** rights -**Requirement:** Optional +**Requirement:** Recommended Rights statements about the catalog that are not already covered by license or accessRights, such as copyright or policy restrictions @@ -822,7 +822,7 @@ Organizations that hold rights in the catalog **Title:** spatial/geographic coverage -**Requirement:** Optional +**Requirement:** Recommended Geographic area covered by the catalog @@ -903,7 +903,7 @@ List of high-level categories for the catalog **Title:** homepage -**Requirement:** Optional +**Requirement:** Recommended Main public web page for the catalog, usually an HTML page diff --git a/jsonschema/docs/constraints-and-restrictions.md b/jsonschema/docs/constraints-and-restrictions.md index 1e084aa5..ac9f6524 100644 --- a/jsonschema/docs/constraints-and-restrictions.md +++ b/jsonschema/docs/constraints-and-restrictions.md @@ -25,13 +25,13 @@ Rules or indicators that describe who can access a resource } ``` -| Property | Type | Title/Description | -| ---------------------------------------------- | ------------------ | -------------------- | -| - [@id](#access-restriction--@id) | string | - | -| - [@type](#access-restriction--@type) | string | - | -| - [restrictionNote](#access-restriction--restrictionNote) | null or string | restriction note | -| + [restrictionStatus](#access-restriction--restrictionStatus) | object | restriction status | -| - [specificRestriction](#access-restriction--specificRestriction) | More than one type | specific restriction | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------- | ------------------ | ----------------- | -------------------- | +| [@id](#access-restriction--@id) | string | Optional | - | +| [@type](#access-restriction--@type) | string | Optional | - | +| [restrictionNote](#access-restriction--restrictionNote) | null or string | Optional | restriction note | +| [restrictionStatus](#access-restriction--restrictionStatus) | object | Mandatory | restriction status | +| [specificRestriction](#access-restriction--specificRestriction) | More than one type | Recommended | specific restriction | ## `AccessRestriction > @id` @@ -70,7 +70,7 @@ A note related to the access restriction **Title:** restriction status -**Requirement:** Optional +**Requirement:** Mandatory The indication of whether or not there are access restrictions on the item, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/access-restriction-status @@ -94,7 +94,7 @@ The indication of whether or not there are access restrictions on the item, cons **Title:** specific restriction -**Requirement:** Optional +**Requirement:** Recommended Authority, code list entry, or policy reference that defines the specific access restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-access-restriction @@ -159,13 +159,13 @@ Information describing Controlled Unclassified Information (CUI) restrictions fo } ``` -| Property | Type | Title/Description | -| ------------------------------------------------------------------ | ----------------------- | -------------------------------- | -| - [@id](#cui-restriction--@id) | string | - | -| - [@type](#cui-restriction--@type) | string | - | -| + [cuiBannerMarking](#cui-restriction--cuiBannerMarking) | string | CUI banner marking | -| + [designationIndicator](#cui-restriction--designationIndicator) | string | CUI designation indicator | -| - [requiredIndicatorPerAuthority](#cui-restriction--requiredIndicatorPerAuthority) | null or array of string | required indicator per authority | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------------------------------- | ----------------------- | ----------------- | -------------------------------- | +| [@id](#cui-restriction--@id) | string | Optional | - | +| [@type](#cui-restriction--@type) | string | Optional | - | +| [cuiBannerMarking](#cui-restriction--cuiBannerMarking) | string | Mandatory | CUI banner marking | +| [designationIndicator](#cui-restriction--designationIndicator) | string | Mandatory | CUI designation indicator | +| [requiredIndicatorPerAuthority](#cui-restriction--requiredIndicatorPerAuthority) | null or array of string | Optional | required indicator per authority | ## `CUIRestriction > @id` @@ -193,7 +193,7 @@ Information describing Controlled Unclassified Information (CUI) restrictions fo **Title:** CUI banner marking -**Requirement:** Optional +**Requirement:** Mandatory CUI (Controlled Unclassified Information) banner marking is required for any unclassified information that is deemed sensitive and requires protection; see information at https://www.archives.gov/cui/registry/category-marking-list @@ -215,7 +215,7 @@ CUI (Controlled Unclassified Information) banner marking is required for any unc **Title:** CUI designation indicator -**Requirement:** Optional +**Requirement:** Mandatory Agency that designated the information as CUI; include at least "Controlled by:" and, when possible, contact information @@ -289,13 +289,13 @@ Rules or legal limits on how a resource may be used } ``` -| Property | Type | Title/Description | -| ---------------------------------------------- | ------------------ | -------------------- | -| - [@id](#use-restriction--@id) | string | - | -| - [@type](#use-restriction--@type) | string | - | -| - [restrictionNote](#use-restriction--restrictionNote) | null or string | restriction note | -| + [restrictionStatus](#use-restriction--restrictionStatus) | object | restriction status | -| - [specificRestriction](#use-restriction--specificRestriction) | More than one type | specific restriction | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------- | ------------------ | ----------------- | -------------------- | +| [@id](#use-restriction--@id) | string | Optional | - | +| [@type](#use-restriction--@type) | string | Optional | - | +| [restrictionNote](#use-restriction--restrictionNote) | null or string | Optional | restriction note | +| [restrictionStatus](#use-restriction--restrictionStatus) | object | Mandatory | restriction status | +| [specificRestriction](#use-restriction--specificRestriction) | More than one type | Recommended | specific restriction | ## `UseRestriction > @id` @@ -344,7 +344,7 @@ Significant information pertaining to the use or reproduction of the data **Title:** restriction status -**Requirement:** Optional +**Requirement:** Mandatory Indication of whether or not there are use restrictions on the archival materials, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/use-restriction-status @@ -368,7 +368,7 @@ Indication of whether or not there are use restrictions on the archival material **Title:** specific restriction -**Requirement:** Optional +**Requirement:** Recommended Authority, code list entry, or policy reference that defines the specific use restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-use-restriction diff --git a/jsonschema/docs/dataset-series.md b/jsonschema/docs/dataset-series.md index f0b43dbb..0586e6f5 100644 --- a/jsonschema/docs/dataset-series.md +++ b/jsonschema/docs/dataset-series.md @@ -143,22 +143,22 @@ A group of related datasets that are published separately } ``` -| Property | Type | Title/Description | -| -------------------------------------------- | ------------------ | --------------------------- | -| - [@id](#@id) | string | - | -| - [@type](#@type) | string | - | -| - [contactPoint](#contactPoint) | null or array | contact point | -| - [first](#first) | More than one type | first | -| - [last](#last) | More than one type | last | -| - [seriesMember](#seriesMember) | null or array | series member | -| - [accrualPeriodicity](#accrualPeriodicity) | More than one type | frequency | -| + [description](#description) | string | description | -| - [issued](#issued) | More than one type | release date | -| - [modified](#modified) | More than one type | update/modification date | -| - [publisher](#publisher) | More than one type | publisher | -| - [spatial](#spatial) | null or array | spatial/geographic coverage | -| - [temporal](#temporal) | null or array | temporal coverage | -| + [title](#title) | string | title | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------------ | ------------------ | ----------------- | --------------------------- | +| [@id](#@id) | string | Optional | - | +| [@type](#@type) | string | Optional | - | +| [contactPoint](#contactPoint) | null or array | Recommended | contact point | +| [first](#first) | More than one type | Recommended | first | +| [last](#last) | More than one type | Recommended | last | +| [seriesMember](#seriesMember) | null or array | Recommended | series member | +| [accrualPeriodicity](#accrualPeriodicity) | More than one type | Optional | frequency | +| [description](#description) | string | Mandatory | description | +| [issued](#issued) | More than one type | Optional | release date | +| [modified](#modified) | More than one type | Recommended | update/modification date | +| [publisher](#publisher) | More than one type | Recommended | publisher | +| [spatial](#spatial) | null or array | Recommended | spatial/geographic coverage | +| [temporal](#temporal) | null or array | Recommended | temporal coverage | +| [title](#title) | string | Mandatory | title | ## `DatasetSeries > @id` @@ -186,7 +186,7 @@ A group of related datasets that are published separately **Title:** contact point -**Requirement:** Optional +**Requirement:** Recommended List of contacts people can use to ask questions or send feedback about the dataset series @@ -201,7 +201,7 @@ List of contacts people can use to ask questions or send feedback about the data **Title:** first -**Requirement:** Optional +**Requirement:** Recommended The first dataset in an ordered dataset series @@ -239,7 +239,7 @@ inline description of the first dataset **Title:** last -**Requirement:** Optional +**Requirement:** Recommended The last dataset in an ordered dataset series @@ -277,7 +277,7 @@ inline description of the last dataset **Title:** series member -**Requirement:** Optional +**Requirement:** Recommended List of members of the Dataset Series @@ -382,7 +382,7 @@ Must be one of: **Title:** description -**Requirement:** Optional +**Requirement:** Mandatory Plain-language summary of the dataset series @@ -491,7 +491,7 @@ A year and month in YYYY-MM format **Title:** update/modification date -**Requirement:** Optional +**Requirement:** Recommended Most recent date when the Dataset Series changed, not the modified date of the newest dataset in the series @@ -586,7 +586,7 @@ A year and month in YYYY-MM format **Title:** publisher -**Requirement:** Optional +**Requirement:** Recommended Organization responsible for maintaining the Dataset Series as a coherent series; this may differ from publishers of individual datasets @@ -621,7 +621,7 @@ inline description of publisher **Title:** spatial/geographic coverage -**Requirement:** Optional +**Requirement:** Recommended A geographic region that is covered by the Dataset Series @@ -636,7 +636,7 @@ A geographic region that is covered by the Dataset Series **Title:** temporal coverage -**Requirement:** Optional +**Requirement:** Recommended Time periods covered by the dataset series @@ -651,7 +651,7 @@ Time periods covered by the dataset series **Title:** title -**Requirement:** Optional +**Requirement:** Mandatory Human-readable title of the dataset series diff --git a/jsonschema/docs/dataset.md b/jsonschema/docs/dataset.md index ef16673e..7c21e9bd 100644 --- a/jsonschema/docs/dataset.md +++ b/jsonschema/docs/dataset.md @@ -99,66 +99,66 @@ A collection of data published or curated by one provider } ``` -| Property | Type | Title/Description | -| ---------------------------------------------------------- | ----------------------- | --------------------------- | -| - [@id](#@id) | string | - | -| - [@type](#@type) | string | - | -| - [otherIdentifier](#otherIdentifier) | null or array | other identifier | -| - [sample](#sample) | null or array | sample | -| - [status](#status) | More than one type | lifecycle status | -| - [supportedSchema](#supportedSchema) | More than one type | supported schema | -| - [versionNotes](#versionNotes) | null or string | version notes | -| + [contactPoint](#contactPoint) | More than one type | contact point | -| - [distribution](#distribution) | null or array | dataset distribution | -| - [first](#first) | More than one type | first | -| - [hasCurrentVersion](#hasCurrentVersion) | More than one type | current version | -| - [hasVersion](#hasVersion) | null or array | has version | -| - [inSeries](#inSeries) | null or array | in series | -| - [keyword](#keyword) | null or array of string | keyword/tag | -| - [landingPage](#landingPage) | More than one type | landing page | -| - [previousVersion](#previousVersion) | More than one type | previous version | -| - [qualifiedRelation](#qualifiedRelation) | null or array | qualified relation | -| - [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Spatial resolution (meters) | -| - [temporalResolution](#temporalResolution) | null or string | temporal resolution | -| - [theme](#theme) | null or array | theme/category | -| - [version](#version) | null or string | version | -| - [describedBy](#describedBy) | More than one type | data dictionary | -| - [liabilityStatement](#liabilityStatement) | More than one type | liability statement | -| - [metadataDistribution](#metadataDistribution) | null or array | metadata distribution | -| - [purpose](#purpose) | null or string | purpose | -| - [accessRights](#accessRights) | More than one type | access rights | -| - [accrualPeriodicity](#accrualPeriodicity) | More than one type | frequency | -| - [conformsTo](#conformsTo) | null or array | conforms to | -| - [contributor](#contributor) | null or array | contributor | -| - [created](#created) | More than one type | creation date | -| - [creator](#creator) | More than one type | creator | -| + [description](#description) | string | description | -| - [hasPart](#hasPart) | null or array | has part | -| + [identifier](#identifier) | More than one type | identifier | -| - [isReferencedBy](#isReferencedBy) | null or array of string | is referenced by | -| - [issued](#issued) | More than one type | release date | -| - [language](#language) | More than one type | language | -| - [modified](#modified) | More than one type | last modified | -| - [provenance](#provenance) | null or array of string | provenance | -| + [publisher](#publisher) | object | publisher | -| - [relation](#relation) | null or array of string | related resource | -| - [replaces](#replaces) | null or array | replaces | -| - [rights](#rights) | null or array of string | rights | -| - [rightsHolder](#rightsHolder) | null or array | rights holder | -| - [source](#source) | null or array | data source | -| - [spatial](#spatial) | More than one type | spatial/geographic coverage | -| - [subject](#subject) | null or array | subject | -| - [temporal](#temporal) | null or array | temporal coverage | -| + [title](#title) | string | title | -| - [category](#category) | null or array | category | -| - [hasQualityMeasurement](#hasQualityMeasurement) | null or array | quality measurement | -| - [page](#page) | null or array | documentation | -| - [qualifiedAttribution](#qualifiedAttribution) | null or array | qualified attribution | -| - [wasAttributedTo](#wasAttributedTo) | null or array | attribution | -| - [wasGeneratedBy](#wasGeneratedBy) | null or array | was generated by | -| - [wasUsedBy](#wasUsedBy) | null or array | used by | -| - [image](#image) | More than one type | image | -| - [scopeNote](#scopeNote) | null or string | usage note | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------------------- | ----------------------- | ----------------- | --------------------------- | +| [@id](#@id) | string | Optional | - | +| [@type](#@type) | string | Optional | - | +| [otherIdentifier](#otherIdentifier) | null or array | Optional | other identifier | +| [sample](#sample) | null or array | Optional | sample | +| [status](#status) | More than one type | Optional | lifecycle status | +| [supportedSchema](#supportedSchema) | More than one type | Optional | supported schema | +| [versionNotes](#versionNotes) | null or string | Optional | version notes | +| [contactPoint](#contactPoint) | More than one type | Mandatory | contact point | +| [distribution](#distribution) | null or array | Recommended | dataset distribution | +| [first](#first) | More than one type | Optional | first | +| [hasCurrentVersion](#hasCurrentVersion) | More than one type | Optional | current version | +| [hasVersion](#hasVersion) | null or array | Optional | has version | +| [inSeries](#inSeries) | null or array | Optional | in series | +| [keyword](#keyword) | null or array of string | Recommended | keyword/tag | +| [landingPage](#landingPage) | More than one type | Recommended | landing page | +| [previousVersion](#previousVersion) | More than one type | Optional | previous version | +| [qualifiedRelation](#qualifiedRelation) | null or array | Optional | qualified relation | +| [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Optional | Spatial resolution (meters) | +| [temporalResolution](#temporalResolution) | null or string | Optional | temporal resolution | +| [theme](#theme) | null or array | Recommended | theme/category | +| [version](#version) | null or string | Optional | version | +| [describedBy](#describedBy) | More than one type | Recommended | data dictionary | +| [liabilityStatement](#liabilityStatement) | More than one type | Optional | liability statement | +| [metadataDistribution](#metadataDistribution) | null or array | Optional | metadata distribution | +| [purpose](#purpose) | null or string | Optional | purpose | +| [accessRights](#accessRights) | More than one type | Optional | access rights | +| [accrualPeriodicity](#accrualPeriodicity) | More than one type | Optional | frequency | +| [conformsTo](#conformsTo) | null or array | Optional | conforms to | +| [contributor](#contributor) | null or array | Optional | contributor | +| [created](#created) | More than one type | Optional | creation date | +| [creator](#creator) | More than one type | Optional | creator | +| [description](#description) | string | Mandatory | description | +| [hasPart](#hasPart) | null or array | Optional | has part | +| [identifier](#identifier) | More than one type | Mandatory | identifier | +| [isReferencedBy](#isReferencedBy) | null or array of string | Optional | is referenced by | +| [issued](#issued) | More than one type | Optional | release date | +| [language](#language) | More than one type | Optional | language | +| [modified](#modified) | More than one type | Recommended | last modified | +| [provenance](#provenance) | null or array of string | Optional | provenance | +| [publisher](#publisher) | object | Mandatory | publisher | +| [relation](#relation) | null or array of string | Optional | related resource | +| [replaces](#replaces) | null or array | Optional | replaces | +| [rights](#rights) | null or array of string | Recommended | rights | +| [rightsHolder](#rightsHolder) | null or array | Optional | rights holder | +| [source](#source) | null or array | Optional | data source | +| [spatial](#spatial) | More than one type | Recommended | spatial/geographic coverage | +| [subject](#subject) | null or array | Optional | subject | +| [temporal](#temporal) | null or array | Recommended | temporal coverage | +| [title](#title) | string | Mandatory | title | +| [category](#category) | null or array | Optional | category | +| [hasQualityMeasurement](#hasQualityMeasurement) | null or array | Optional | quality measurement | +| [page](#page) | null or array | Optional | documentation | +| [qualifiedAttribution](#qualifiedAttribution) | null or array | Optional | qualified attribution | +| [wasAttributedTo](#wasAttributedTo) | null or array | Optional | attribution | +| [wasGeneratedBy](#wasGeneratedBy) | null or array | Optional | was generated by | +| [wasUsedBy](#wasUsedBy) | null or array | Optional | used by | +| [image](#image) | More than one type | Optional | image | +| [scopeNote](#scopeNote) | null or string | Optional | usage note | ## `Dataset > @id` @@ -306,7 +306,7 @@ Notes describing how this version differs from earlier versions of the dataset **Title:** contact point -**Requirement:** Optional +**Requirement:** Mandatory A contact point for questions about the Dataset (single contact or list). Include an email address that is continuously monitored @@ -346,7 +346,7 @@ inline description of Kind **Title:** dataset distribution -**Requirement:** Optional +**Requirement:** Recommended List of available distributions for the dataset. This can be omitted when no distribution is available yet. @@ -467,7 +467,7 @@ Dataset series this dataset belongs to **Title:** keyword/tag -**Requirement:** Optional +**Requirement:** Recommended List of keywords or tags describing the dataset @@ -516,7 +516,7 @@ List of keywords or tags describing the dataset **Title:** landing page -**Requirement:** Optional +**Requirement:** Recommended A web page from the original data provider that gives access to the Dataset, its Distributions, and related information @@ -638,7 +638,7 @@ Smallest time interval between data points, using xsd:duration format (for examp **Title:** theme/category -**Requirement:** Optional +**Requirement:** Recommended List of themes or categories for the dataset @@ -670,7 +670,7 @@ The version indicator (name or identifier) of a resource **Title:** data dictionary -**Requirement:** Optional +**Requirement:** Recommended A distribution describing the Data Dictionary for this dataset @@ -1064,7 +1064,7 @@ inline description of Agent **Title:** description -**Requirement:** Optional +**Requirement:** Mandatory Plain-language summary of the dataset @@ -1101,7 +1101,7 @@ List of related datasets that are part of the described dataset **Title:** identifier -**Requirement:** Optional +**Requirement:** Mandatory The unique identifier for the Dataset, e.g. the URI or other unique identifier in the context of the Catalog @@ -1327,7 +1327,7 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en **Title:** last modified -**Requirement:** Optional +**Requirement:** Recommended Most recent date when the dataset's actual data changed, not just metadata @@ -1449,7 +1449,7 @@ Full text of the provenance statement **Title:** publisher -**Requirement:** Optional +**Requirement:** Mandatory Organization responsible for publishing and making the dataset available @@ -1511,7 +1511,7 @@ List of Datasets replaced by this Dataset **Title:** rights -**Requirement:** Optional +**Requirement:** Recommended Rights statements not already covered by license or accessRights, such as copyright or policy restrictions @@ -1577,7 +1577,7 @@ List of related Datasets from which the described Dataset is derived **Title:** spatial/geographic coverage -**Requirement:** Optional +**Requirement:** Recommended A geographic region or regions that are covered by the Dataset @@ -1639,7 +1639,7 @@ List of primary subjects for the dataset, usually narrower than broad theme cate **Title:** temporal coverage -**Requirement:** Optional +**Requirement:** Recommended Time periods covered by the dataset @@ -1654,7 +1654,7 @@ Time periods covered by the dataset **Title:** title -**Requirement:** Optional +**Requirement:** Mandatory Human-readable title of the dataset diff --git a/jsonschema/docs/distribution.md b/jsonschema/docs/distribution.md index 302b1657..615de563 100644 --- a/jsonschema/docs/distribution.md +++ b/jsonschema/docs/distribution.md @@ -38,43 +38,43 @@ A specific representation of a dataset, such as a file, feed, or API response } ``` -| Property | Type | Title/Description | -| ---------------------------------------------------------- | ----------------------- | --------------------------- | -| - [@id](#@id) | string | - | -| - [@type](#@type) | string | - | -| - [representationTechnique](#representationTechnique) | More than one type | representation technique | -| - [status](#status) | More than one type | lifecycle status | -| - [characterEncoding](#characterEncoding) | More than one type | character encoding | -| - [accessService](#accessService) | null or array | access service | -| - [accessURL](#accessURL) | More than one type | access URL | -| - [byteSize](#byteSize) | null or string | byte size | -| - [compressFormat](#compressFormat) | null or string | compression format | -| - [downloadURL](#downloadURL) | More than one type | download URL | -| - [mediaType](#mediaType) | null or string | media type | -| - [packageFormat](#packageFormat) | null or string | packaging format | -| - [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Spatial resolution (meters) | -| - [temporalResolution](#temporalResolution) | null or string | termporal resolution | -| - [availability](#availability) | More than one type | availability | -| - [accessRestriction](#accessRestriction) | null or array | access restriction | -| - [cuiRestriction](#cuiRestriction) | More than one type | CUI restriction | -| - [describedBy](#describedBy) | More than one type | data dictionary | -| - [useRestriction](#useRestriction) | null or array | use restriction | -| - [accessRights](#accessRights) | More than one type | access rights | -| - [conformsTo](#conformsTo) | null or array | linked schemas | -| - [description](#description) | null or string | description | -| - [format](#format) | null or string | format | -| - [identifier](#identifier) | More than one type | identifier | -| - [otherIdentifier](#otherIdentifier) | null or array | other identifier | -| - [issued](#issued) | More than one type | release date | -| - [language](#language) | More than one type | language | -| - [license](#license) | More than one type | license | -| - [modified](#modified) | More than one type | last modified | -| - [rights](#rights) | null or array of string | rights | -| - [title](#title) | null or string | title | -| - [hasQualityMeasurement](#hasQualityMeasurement) | null or array | quality measurement | -| - [page](#page) | null or array | documentation | -| - [image](#image) | More than one type | image | -| - [checksum](#checksum) | More than one type | checksum | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------------------- | ----------------------- | ----------------- | --------------------------- | +| [@id](#@id) | string | Optional | - | +| [@type](#@type) | string | Optional | - | +| [representationTechnique](#representationTechnique) | More than one type | Optional | representation technique | +| [status](#status) | More than one type | Optional | lifecycle status | +| [characterEncoding](#characterEncoding) | More than one type | Optional | character encoding | +| [accessService](#accessService) | null or array | Optional | access service | +| [accessURL](#accessURL) | More than one type | Recommended | access URL | +| [byteSize](#byteSize) | null or string | Optional | byte size | +| [compressFormat](#compressFormat) | null or string | Optional | compression format | +| [downloadURL](#downloadURL) | More than one type | Optional | download URL | +| [mediaType](#mediaType) | null or string | Optional | media type | +| [packageFormat](#packageFormat) | null or string | Optional | packaging format | +| [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Optional | Spatial resolution (meters) | +| [temporalResolution](#temporalResolution) | null or string | Optional | termporal resolution | +| [availability](#availability) | More than one type | Optional | availability | +| [accessRestriction](#accessRestriction) | null or array | Recommended | access restriction | +| [cuiRestriction](#cuiRestriction) | More than one type | Recommended | CUI restriction | +| [describedBy](#describedBy) | More than one type | Recommended | data dictionary | +| [useRestriction](#useRestriction) | null or array | Recommended | use restriction | +| [accessRights](#accessRights) | More than one type | Optional | access rights | +| [conformsTo](#conformsTo) | null or array | Optional | linked schemas | +| [description](#description) | null or string | Recommended | description | +| [format](#format) | null or string | Recommended | format | +| [identifier](#identifier) | More than one type | Optional | identifier | +| [otherIdentifier](#otherIdentifier) | null or array | Optional | other identifier | +| [issued](#issued) | More than one type | Optional | release date | +| [language](#language) | More than one type | Optional | language | +| [license](#license) | More than one type | Recommended | license | +| [modified](#modified) | More than one type | Recommended | last modified | +| [rights](#rights) | null or array of string | Recommended | rights | +| [title](#title) | null or string | Recommended | title | +| [hasQualityMeasurement](#hasQualityMeasurement) | null or array | Optional | quality measurement | +| [page](#page) | null or array | Optional | documentation | +| [image](#image) | More than one type | Optional | image | +| [checksum](#checksum) | More than one type | Optional | checksum | ## `Distribution > @id` @@ -237,7 +237,7 @@ A data service that gives access to the distribution of the dataset **Title:** access URL -**Requirement:** Optional +**Requirement:** Recommended URL for indirect access to the Distribution (for example, a landing page, API docs, or request form), not a direct file download @@ -458,7 +458,7 @@ inline description of Concept **Title:** access restriction -**Requirement:** Optional +**Requirement:** Recommended List of access restrictions related to the distribution @@ -473,7 +473,7 @@ List of access restrictions related to the distribution **Title:** CUI restriction -**Requirement:** Optional +**Requirement:** Recommended Controlled Unclassified Information restriction related to the distribution @@ -508,7 +508,7 @@ inline description of CUIRestriction **Title:** data dictionary -**Requirement:** Optional +**Requirement:** Recommended A distribution containing the Data Dictionary for this distribution @@ -546,7 +546,7 @@ inline description of the data dictionary **Title:** use restriction -**Requirement:** Optional +**Requirement:** Recommended Use restriction related to the distribution @@ -613,7 +613,7 @@ List of standards, schemas, or reference systems the Distribution follows (prefe **Title:** description -**Requirement:** Optional +**Requirement:** Recommended Plain-language summary of the distribution @@ -634,7 +634,7 @@ Plain-language summary of the distribution **Title:** format -**Requirement:** Optional +**Requirement:** Recommended A human-readable description of the file format of the Distribution that provides useful information that might not be apparent from mediaType @@ -863,7 +863,7 @@ ISO 639-1 language code values used in the distribution metadata text, such as e **Title:** license -**Requirement:** Optional +**Requirement:** Recommended License that governs how the distribution can be used or reused @@ -900,7 +900,7 @@ Full text of the license **Title:** last modified -**Requirement:** Optional +**Requirement:** Recommended The most recent date on which the Distribution was changed or modified @@ -995,7 +995,7 @@ A year and month in YYYY-MM format **Title:** rights -**Requirement:** Optional +**Requirement:** Recommended Rights statements not already covered by license or accessRights, such as copyright or policy restrictions @@ -1031,7 +1031,7 @@ Full text of a statement of rights **Title:** title -**Requirement:** Optional +**Requirement:** Recommended Human-readable title of the distribution diff --git a/jsonschema/docs/identifiers-and-relationships.md b/jsonschema/docs/identifiers-and-relationships.md index 5dbd27a7..6fb2ff24 100644 --- a/jsonschema/docs/identifiers-and-relationships.md +++ b/jsonschema/docs/identifiers-and-relationships.md @@ -34,15 +34,15 @@ A unique identifier and optionally it's scheme and other relevant information | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | -| Property | Type | Title/Description | -| ----------------------------------------- | ------------------ | ----------------- | -| - [@id](#identifier--anyOf_i1_@id) | string | - | -| - [@type](#identifier--anyOf_i1_@type) | string | - | -| - [schemaAgency](#identifier--anyOf_i1_schemaAgency) | null or string | schema agency | -| - [creator](#identifier--anyOf_i1_creator) | More than one type | creator | -| - [issued](#identifier--anyOf_i1_issued) | More than one type | issued | -| - [version](#identifier--anyOf_i1_version) | null or string | version | -| - [notation](#identifier--anyOf_i1_notation) | null or string | notation | +| Property | Type | Requirement Level | Title/Description | +| --------------------------------------- | ------------------ | ----------------- | ----------------- | +| [@id](#identifier--anyOf_i1_@id) | string | Optional | - | +| [@type](#identifier--anyOf_i1_@type) | string | Optional | - | +| [schemaAgency](#identifier--anyOf_i1_schemaAgency) | null or string | Optional | schema agency | +| [creator](#identifier--anyOf_i1_creator) | More than one type | Optional | creator | +| [issued](#identifier--anyOf_i1_issued) | More than one type | Optional | issued | +| [version](#identifier--anyOf_i1_version) | null or string | Optional | version | +| [notation](#identifier--anyOf_i1_notation) | null or string | Optional | notation | ### `Identifier > anyOf > Identifier as a complex object > @id` @@ -225,12 +225,12 @@ Additional information about how one resource is related to another } ``` -| Property | Type | Title/Description | -| ------------------------ | ------ | ----------------- | -| - [@id](#relationship--@id) | string | - | -| - [@type](#relationship--@type) | string | - | -| + [hadRole](#relationship--hadRole) | string | role | -| + [relation](#relationship--relation) | string | relation | +| Property | Type | Requirement Level | Title/Description | +| ---------------------- | ------ | ----------------- | ----------------- | +| [@id](#relationship--@id) | string | Optional | - | +| [@type](#relationship--@type) | string | Optional | - | +| [hadRole](#relationship--hadRole) | string | Mandatory | role | +| [relation](#relationship--relation) | string | Mandatory | relation | ## `Relationship > @id` @@ -258,7 +258,7 @@ Additional information about how one resource is related to another **Title:** role -**Requirement:** Optional +**Requirement:** Mandatory The function of an entity or agent with respect to a dataset @@ -280,7 +280,7 @@ The function of an entity or agent with respect to a dataset **Title:** relation -**Requirement:** Optional +**Requirement:** Mandatory The entity related to the dataset. This string should unambiguously identify the related resource using an appropriate identifier. @@ -322,12 +322,12 @@ A mechanism that can be used to verify that the contents of a distribution have } ``` -| Property | Type | Title/Description | -| ---------------------------------- | ------ | ----------------- | -| - [@id](#checksum--@id) | string | - | -| - [@type](#checksum--@type) | string | - | -| + [algorithm](#checksum--algorithm) | string | algorithm | -| + [checksumValue](#checksum--checksumValue) | string | checksum value | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------- | ------ | ----------------- | ----------------- | +| [@id](#checksum--@id) | string | Optional | - | +| [@type](#checksum--@type) | string | Optional | - | +| [algorithm](#checksum--algorithm) | string | Mandatory | algorithm | +| [checksumValue](#checksum--checksumValue) | string | Mandatory | checksum value | ## `Checksum > @id` @@ -355,7 +355,7 @@ A mechanism that can be used to verify that the contents of a distribution have **Title:** algorithm -**Requirement:** Optional +**Requirement:** Mandatory The algorithm used to produce the checksum @@ -373,7 +373,7 @@ The algorithm used to produce the checksum **Title:** checksum value -**Requirement:** Optional +**Requirement:** Mandatory A lower case hexadecimal encoded digest value produced using a specific algorithm @@ -425,15 +425,15 @@ The value of the concept, expressed as a string. This is only used when the conc | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | -| Property | Type | Title/Description | -| ------------------------------------- | ------------------ | ----------------- | -| - [@id](#concept--anyOf_i1_@id) | string | - | -| - [@type](#concept--anyOf_i1_@type) | string | - | -| - [altLabel](#concept--anyOf_i1_altLabel) | null or string | alternate label | -| - [definition](#concept--anyOf_i1_definition) | null or string | definition | -| - [inScheme](#concept--anyOf_i1_inScheme) | object | in scheme | -| - [notation](#concept--anyOf_i1_notation) | More than one type | notation | -| + [prefLabel](#concept--anyOf_i1_prefLabel) | string | preferred label | +| Property | Type | Requirement Level | Title/Description | +| ----------------------------------- | ------------------ | ----------------- | ----------------- | +| [@id](#concept--anyOf_i1_@id) | string | Optional | - | +| [@type](#concept--anyOf_i1_@type) | string | Optional | - | +| [altLabel](#concept--anyOf_i1_altLabel) | null or string | Optional | alternate label | +| [definition](#concept--anyOf_i1_definition) | null or string | Optional | definition | +| [inScheme](#concept--anyOf_i1_inScheme) | object | Optional | in scheme | +| [notation](#concept--anyOf_i1_notation) | More than one type | Optional | notation | +| [prefLabel](#concept--anyOf_i1_prefLabel) | string | Optional | preferred label | ### `Concept > anyOf > item 1 > @id` @@ -559,16 +559,16 @@ A controlled vocabulary or other list of approved terms for a concept } ``` -| Property | Type | Title/Description | -| ------------------------------ | ------------------ | ------------------------ | -| - [@id](#concept-scheme--@id) | string | - | -| - [@type](#concept-scheme--@type) | string | - | -| - [version](#concept-scheme--version) | null or string | version info | -| - [created](#concept-scheme--created) | More than one type | creation date | -| - [description](#concept-scheme--description) | null or string | description | -| - [issued](#concept-scheme--issued) | More than one type | publication date | -| - [modified](#concept-scheme--modified) | More than one type | update/modification date | -| + [title](#concept-scheme--title) | string | title | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------- | ------------------ | ----------------- | ------------------------ | +| [@id](#concept-scheme--@id) | string | Optional | - | +| [@type](#concept-scheme--@type) | string | Optional | - | +| [version](#concept-scheme--version) | null or string | Optional | version info | +| [created](#concept-scheme--created) | More than one type | Optional | creation date | +| [description](#concept-scheme--description) | null or string | Recommended | description | +| [issued](#concept-scheme--issued) | More than one type | Optional | publication date | +| [modified](#concept-scheme--modified) | More than one type | Optional | update/modification date | +| [title](#concept-scheme--title) | string | Mandatory | title | ## `ConceptScheme > @id` @@ -704,7 +704,7 @@ A year and month in YYYY-MM format **Title:** description -**Requirement:** Optional +**Requirement:** Recommended A description of the concept scheme @@ -907,7 +907,7 @@ A year and month in YYYY-MM format **Title:** title -**Requirement:** Optional +**Requirement:** Mandatory The title of the concept scheme diff --git a/jsonschema/docs/quality-governance.md b/jsonschema/docs/quality-governance.md index 4c020e55..28aad2fb 100644 --- a/jsonschema/docs/quality-governance.md +++ b/jsonschema/docs/quality-governance.md @@ -35,19 +35,19 @@ A standard or specification that another resource conforms to } ``` -| Property | Type | Title/Description | -| -------------------------------------- | ------------------ | ----------------- | -| - [@id](#standard--@id) | string | - | -| - [@type](#standard--@type) | string | - | -| - [created](#standard--created) | More than one type | creation date | -| - [description](#standard--description) | null or string | description | -| - [identifier](#standard--identifier) | More than one type | identifier | -| - [otherIdentifier](#standard--otherIdentifier) | null or array | other identifier | -| - [issued](#standard--issued) | More than one type | issued | -| - [modified](#standard--modified) | More than one type | last modified | -| - [title](#standard--title) | null or string | title | -| - [category](#standard--category) | null or array | category | -| - [inScheme](#standard--inScheme) | More than one type | in scheme | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------ | ------------------ | ----------------- | ----------------- | +| [@id](#standard--@id) | string | Optional | - | +| [@type](#standard--@type) | string | Optional | - | +| [created](#standard--created) | More than one type | Optional | creation date | +| [description](#standard--description) | null or string | Recommended | description | +| [identifier](#standard--identifier) | More than one type | Recommended | identifier | +| [otherIdentifier](#standard--otherIdentifier) | null or array | Optional | other identifier | +| [issued](#standard--issued) | More than one type | Recommended | issued | +| [modified](#standard--modified) | More than one type | Optional | last modified | +| [title](#standard--title) | null or string | Recommended | title | +| [category](#standard--category) | null or array | Optional | category | +| [inScheme](#standard--inScheme) | More than one type | Recommended | in scheme | ## `Standard > @id` @@ -166,7 +166,7 @@ A year and month in YYYY-MM format **Title:** description -**Requirement:** Optional +**Requirement:** Recommended Plain-language summary of the standard @@ -187,7 +187,7 @@ Plain-language summary of the standard **Title:** identifier -**Requirement:** Optional +**Requirement:** Recommended The unique identifier for the Standard, e.g. the URI or other unique identifier in the context of the Catalog @@ -237,7 +237,7 @@ A list of identifiers for the Standard besides the main identifier, e.g. the URI **Title:** issued -**Requirement:** Optional +**Requirement:** Recommended The date of formal issuance (e.g., publication) of the Standard @@ -419,7 +419,7 @@ A year and month in YYYY-MM format **Title:** title -**Requirement:** Optional +**Requirement:** Recommended Human-readable title of the standard @@ -455,7 +455,7 @@ List of categories for the Standard **Title:** in scheme -**Requirement:** Optional +**Requirement:** Recommended The reference register to which the Standard belongs @@ -521,25 +521,25 @@ A publication or other document related to a resource } ``` -| Property | Type | Title/Description | -| -------------------------------------------------- | ------------------ | ---------------------- | -| - [@id](#document--@id) | string | - | -| - [@type](#document--@type) | string | - | -| - [accessURL](#document--accessURL) | More than one type | access URL | -| - [downloadURL](#document--downloadURL) | More than one type | download URL | -| - [creator](#document--creator) | null or array | author | -| - [mediaType](#document--mediaType) | null or string | media type | -| - [abstract](#document--abstract) | null or string | abstract | -| - [bibliographicCitation](#document--bibliographicCitation) | null or string | bibliographic citation | -| - [conformsTo](#document--conformsTo) | null or array | conforms to | -| - [corporateCreator](#document--corporateCreator) | null or array | corporate author | -| - [description](#document--description) | null or string | description | -| - [identifier](#document--identifier) | More than one type | identifier | -| - [otherIdentifier](#document--otherIdentifier) | null or array | other identifier | -| - [issued](#document--issued) | More than one type | publication date | -| - [publisher](#document--publisher) | null or array | publisher | -| + [title](#document--title) | string | title | -| - [category](#document--category) | null or array | category | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------------------ | ------------------ | ----------------- | ---------------------- | +| [@id](#document--@id) | string | Optional | - | +| [@type](#document--@type) | string | Optional | - | +| [accessURL](#document--accessURL) | More than one type | Optional | access URL | +| [downloadURL](#document--downloadURL) | More than one type | Optional | download URL | +| [creator](#document--creator) | null or array | Optional | author | +| [mediaType](#document--mediaType) | null or string | Optional | media type | +| [abstract](#document--abstract) | null or string | Optional | abstract | +| [bibliographicCitation](#document--bibliographicCitation) | null or string | Recommended | bibliographic citation | +| [conformsTo](#document--conformsTo) | null or array | Optional | conforms to | +| [corporateCreator](#document--corporateCreator) | null or array | Optional | corporate author | +| [description](#document--description) | null or string | Recommended | description | +| [identifier](#document--identifier) | More than one type | Recommended | identifier | +| [otherIdentifier](#document--otherIdentifier) | null or array | Optional | other identifier | +| [issued](#document--issued) | More than one type | Recommended | publication date | +| [publisher](#document--publisher) | null or array | Recommended | publisher | +| [title](#document--title) | string | Mandatory | title | +| [category](#document--category) | null or array | Optional | category | ## `Document > @id` @@ -696,7 +696,7 @@ Text abstract of the Document **Title:** bibliographic citation -**Requirement:** Optional +**Requirement:** Recommended Bibliographic citation as text @@ -747,7 +747,7 @@ The corporate organization(s) responsible for creating the Document **Title:** description -**Requirement:** Optional +**Requirement:** Recommended Plain-language summary of the document @@ -768,7 +768,7 @@ Plain-language summary of the document **Title:** identifier -**Requirement:** Optional +**Requirement:** Recommended The unique identifier for the Document (e.g. DOI, ISBN) @@ -818,7 +818,7 @@ A list of identifiers for the Document besides the main identifier, e.g. the URI **Title:** publication date -**Requirement:** Optional +**Requirement:** Recommended Publication date of the Document @@ -907,7 +907,7 @@ A year and month in YYYY-MM format **Title:** publisher -**Requirement:** Optional +**Requirement:** Recommended The organization(s) that published the Document @@ -922,7 +922,7 @@ The organization(s) that published the Document **Title:** title -**Requirement:** Optional +**Requirement:** Mandatory The title of the Document @@ -984,19 +984,19 @@ A record in a catalog, describing the registration of a single resource } ``` -| Property | Type | Title/Description | -| -------------------------------- | ----------------------- | ------------------------ | -| - [@id](#catalog-record--@id) | string | - | -| - [@type](#catalog-record--@type) | string | - | -| - [status](#catalog-record--status) | More than one type | change type | -| - [conformsTo](#catalog-record--conformsTo) | More than one type | application profile | -| - [description](#catalog-record--description) | null or array of string | Descriptions | -| - [issued](#catalog-record--issued) | null or array | listing date | -| - [language](#catalog-record--language) | More than one type | language | -| + [modified](#catalog-record--modified) | More than one type | update/modification date | -| - [source](#catalog-record--source) | null or string | source metadata | -| - [title](#catalog-record--title) | null or string | title | -| + [primaryTopic](#catalog-record--primaryTopic) | string | primary topic | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------ | ----------------------- | ----------------- | ------------------------ | +| [@id](#catalog-record--@id) | string | Optional | - | +| [@type](#catalog-record--@type) | string | Optional | - | +| [status](#catalog-record--status) | More than one type | Recommended | change type | +| [conformsTo](#catalog-record--conformsTo) | More than one type | Recommended | application profile | +| [description](#catalog-record--description) | null or array of string | Optional | Descriptions | +| [issued](#catalog-record--issued) | null or array | Optional | listing date | +| [language](#catalog-record--language) | More than one type | Optional | language | +| [modified](#catalog-record--modified) | More than one type | Mandatory | update/modification date | +| [source](#catalog-record--source) | null or string | Optional | source metadata | +| [title](#catalog-record--title) | null or string | Optional | title | +| [primaryTopic](#catalog-record--primaryTopic) | string | Mandatory | primary topic | ## `CatalogRecord > @id` @@ -1024,7 +1024,7 @@ A record in a catalog, describing the registration of a single resource **Title:** change type -**Requirement:** Optional +**Requirement:** Recommended The status of the catalog record in the context of editorial flow of the dataset and data service descriptions @@ -1059,7 +1059,7 @@ inline description of status **Title:** application profile -**Requirement:** Optional +**Requirement:** Recommended An Application Profile that the Catalog Record's metadata conforms to @@ -1286,7 +1286,7 @@ Language code used in catalog record metadata text, using ISO 639-1 values such **Title:** update/modification date -**Requirement:** Optional +**Requirement:** Mandatory The most recent date on which the catalog record was changed or modified @@ -1396,7 +1396,7 @@ A name given to the Catalog Record **Title:** primary topic -**Requirement:** Optional +**Requirement:** Mandatory A link to the Dataset, Data service or Catalog described in the Catalog Record @@ -1476,38 +1476,38 @@ A service that provides access to data or data processing functions } ``` -| Property | Type | Title/Description | -| ---------------------------------------------------------- | ----------------------- | ---------------------------- | -| - [@id](#data-service--@id) | string | - | -| - [@type](#data-service--@type) | string | - | -| + [contactPoint](#data-service--contactPoint) | array | contact point | -| - [endpointDescription](#data-service--endpointDescription) | null or array of string | endpoint description | -| + [endpointURL](#data-service--endpointURL) | array of string | endpoint URL | -| - [keyword](#data-service--keyword) | null or array of string | keyword/tag | -| - [servesDataset](#data-service--servesDataset) | null or array | serves dataset | -| - [spatialResolutionInMeters](#data-service--spatialResolutionInMeters) | null or string | spatial resolution in meters | -| - [temporalResolution](#data-service--temporalResolution) | null or string | temporal resolution | -| - [theme](#data-service--theme) | null or array | theme/category | -| - [accessRights](#data-service--accessRights) | More than one type | access rights | -| - [conformsTo](#data-service--conformsTo) | null or array | conforms to | -| - [created](#data-service--created) | More than one type | creation date | -| - [creator](#data-service--creator) | null or array | creator | -| - [description](#data-service--description) | null or string | description | -| - [identifier](#data-service--identifier) | More than one type | identifier | -| - [otherIdentifier](#data-service--otherIdentifier) | null or array | other identifier | -| - [language](#data-service--language) | More than one type | language | -| - [license](#data-service--license) | More than one type | license | -| - [modified](#data-service--modified) | More than one type | update/modification date | -| + [publisher](#data-service--publisher) | object | publisher | -| - [rights](#data-service--rights) | null or array of string | rights | -| - [rightsHolder](#data-service--rightsHolder) | null or array | rights holder | -| - [spatial](#data-service--spatial) | null or array | spatial/geographic coverage | -| - [temporal](#data-service--temporal) | null or array | temporal coverage | -| + [title](#data-service--title) | string | title | -| - [category](#data-service--category) | null or array | category | -| - [hasQualityMeasurement](#data-service--hasQualityMeasurement) | null or array | quality measurement | -| - [qualifiedAttribution](#data-service--qualifiedAttribution) | null or array | qualified attribution | -| - [wasUsedBy](#data-service--wasUsedBy) | null or array | was used by | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------------------- | ----------------------- | ----------------- | ---------------------------- | +| [@id](#data-service--@id) | string | Optional | - | +| [@type](#data-service--@type) | string | Optional | - | +| [contactPoint](#data-service--contactPoint) | array | Mandatory | contact point | +| [endpointDescription](#data-service--endpointDescription) | null or array of string | Recommended | endpoint description | +| [endpointURL](#data-service--endpointURL) | array of string | Mandatory | endpoint URL | +| [keyword](#data-service--keyword) | null or array of string | Optional | keyword/tag | +| [servesDataset](#data-service--servesDataset) | null or array | Recommended | serves dataset | +| [spatialResolutionInMeters](#data-service--spatialResolutionInMeters) | null or string | Optional | spatial resolution in meters | +| [temporalResolution](#data-service--temporalResolution) | null or string | Optional | temporal resolution | +| [theme](#data-service--theme) | null or array | Optional | theme/category | +| [accessRights](#data-service--accessRights) | More than one type | Optional | access rights | +| [conformsTo](#data-service--conformsTo) | null or array | Optional | conforms to | +| [created](#data-service--created) | More than one type | Optional | creation date | +| [creator](#data-service--creator) | null or array | Optional | creator | +| [description](#data-service--description) | null or string | Optional | description | +| [identifier](#data-service--identifier) | More than one type | Optional | identifier | +| [otherIdentifier](#data-service--otherIdentifier) | null or array | Optional | other identifier | +| [language](#data-service--language) | More than one type | Optional | language | +| [license](#data-service--license) | More than one type | Recommended | license | +| [modified](#data-service--modified) | More than one type | Optional | update/modification date | +| [publisher](#data-service--publisher) | object | Mandatory | publisher | +| [rights](#data-service--rights) | null or array of string | Optional | rights | +| [rightsHolder](#data-service--rightsHolder) | null or array | Optional | rights holder | +| [spatial](#data-service--spatial) | null or array | Optional | spatial/geographic coverage | +| [temporal](#data-service--temporal) | null or array | Optional | temporal coverage | +| [title](#data-service--title) | string | Mandatory | title | +| [category](#data-service--category) | null or array | Optional | category | +| [hasQualityMeasurement](#data-service--hasQualityMeasurement) | null or array | Optional | quality measurement | +| [qualifiedAttribution](#data-service--qualifiedAttribution) | null or array | Optional | qualified attribution | +| [wasUsedBy](#data-service--wasUsedBy) | null or array | Optional | was used by | ## `DataService > @id` @@ -1535,7 +1535,7 @@ A service that provides access to data or data processing functions **Title:** contact point -**Requirement:** Optional +**Requirement:** Mandatory Contact information for questions about the Data Service. Include an email address that is continuously monitored @@ -1551,7 +1551,7 @@ Contact information for questions about the Data Service. Include an email addre **Title:** endpoint description -**Requirement:** Optional +**Requirement:** Recommended List of endpoint descriptions with operations and parameters (for example, OpenAPI or similar service documentation) @@ -1585,7 +1585,7 @@ List of endpoint descriptions with operations and parameters (for example, OpenA **Title:** endpoint URL -**Requirement:** Optional +**Requirement:** Mandatory A list of root locations or primary endpoints of the service (a Web-resolvable IRI) @@ -1672,7 +1672,7 @@ List of keywords or tags describing the data service **Title:** serves dataset -**Requirement:** Optional +**Requirement:** Recommended List of datasets this service provides access to @@ -2026,7 +2026,7 @@ ISO 639-1 language code values supported by the data service, such as en or es, **Title:** license -**Requirement:** Optional +**Requirement:** Recommended License that governs how the data service can be used or reused @@ -2154,7 +2154,7 @@ A year and month in YYYY-MM format **Title:** publisher -**Requirement:** Optional +**Requirement:** Mandatory Person or organization responsible for publishing and making the data service available @@ -2241,7 +2241,7 @@ Time periods covered by the data service **Title:** title -**Requirement:** Optional +**Requirement:** Mandatory Human-readable title of the data service @@ -2341,12 +2341,12 @@ A responsibility that an agent has for a resource } ``` -| Property | Type | Title/Description | -| ---------------------- | ------ | ----------------- | -| - [@id](#attribution--@id) | string | - | -| - [@type](#attribution--@type) | string | - | -| + [hadRole](#attribution--hadRole) | string | role | -| + [agent](#attribution--agent) | object | agent | +| Property | Type | Requirement Level | Title/Description | +| -------------------- | ------ | ----------------- | ----------------- | +| [@id](#attribution--@id) | string | Optional | - | +| [@type](#attribution--@type) | string | Optional | - | +| [hadRole](#attribution--hadRole) | string | Mandatory | role | +| [agent](#attribution--agent) | object | Mandatory | agent | ## `Attribution > @id` @@ -2374,7 +2374,7 @@ A responsibility that an agent has for a resource **Title:** role -**Requirement:** Optional +**Requirement:** Mandatory The function of an entity or agent with respect to another entity or resource @@ -2392,7 +2392,7 @@ The function of an entity or agent with respect to another entity or resource **Title:** agent -**Requirement:** Optional +**Requirement:** Mandatory The agent that plays a role in the resource diff --git a/jsonschema/docs/temporal-spatial-metrics.md b/jsonschema/docs/temporal-spatial-metrics.md index 77630726..64035d19 100644 --- a/jsonschema/docs/temporal-spatial-metrics.md +++ b/jsonschema/docs/temporal-spatial-metrics.md @@ -24,12 +24,12 @@ Information about a specific time period with a start- and/or end-time } ``` -| Property | Type | Title/Description | -| -------------------------- | ------------------ | ----------------- | -| - [@id](#period-of-time--@id) | string | - | -| - [@type](#period-of-time--@type) | string | - | -| - [endDate](#period-of-time--endDate) | More than one type | end date | -| - [startDate](#period-of-time--startDate) | More than one type | start date | +| Property | Type | Requirement Level | Title/Description | +| ------------------------ | ------------------ | ----------------- | ----------------- | +| [@id](#period-of-time--@id) | string | Optional | - | +| [@type](#period-of-time--@type) | string | Optional | - | +| [endDate](#period-of-time--endDate) | More than one type | Recommended | end date | +| [startDate](#period-of-time--startDate) | More than one type | Recommended | start date | | Any of | | ------------------- | @@ -80,7 +80,7 @@ Information about a specific time period with a start- and/or end-time **Title:** end date -**Requirement:** Optional +**Requirement:** Recommended The end date of the period of time @@ -169,7 +169,7 @@ A year and month in YYYY-MM format **Title:** start date -**Requirement:** Optional +**Requirement:** Recommended The start date of the period of time @@ -378,18 +378,18 @@ A named place or geographic area } ``` -| Property | Type | Title/Description | -| -------------------------------------- | ------------------ | ----------------- | -| - [@id](#location--@id) | string | - | -| - [@type](#location--@type) | string | - | -| - [bbox](#location--bbox) | More than one type | bounding box | -| - [centroid](#location--centroid) | More than one type | centroid | -| - [identifier](#location--identifier) | More than one type | identifier | -| - [otherIdentifier](#location--otherIdentifier) | null or array | other identifier | -| - [geometry](#location--geometry) | More than one type | geometry | -| - [inScheme](#location--inScheme) | More than one type | gazetteer | -| - [altLabel](#location--altLabel) | null or string | alternative name | -| - [prefLabel](#location--prefLabel) | null or string | geographic name | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------ | ------------------ | ----------------- | ----------------- | +| [@id](#location--@id) | string | Optional | - | +| [@type](#location--@type) | string | Optional | - | +| [bbox](#location--bbox) | More than one type | Recommended | bounding box | +| [centroid](#location--centroid) | More than one type | Optional | centroid | +| [identifier](#location--identifier) | More than one type | Optional | identifier | +| [otherIdentifier](#location--otherIdentifier) | null or array | Optional | other identifier | +| [geometry](#location--geometry) | More than one type | Optional | geometry | +| [inScheme](#location--inScheme) | More than one type | Optional | gazetteer | +| [altLabel](#location--altLabel) | null or string | Optional | alternative name | +| [prefLabel](#location--prefLabel) | null or string | Recommended | geographic name | ## `Location > @id` @@ -417,7 +417,7 @@ A named place or geographic area **Title:** bounding box -**Requirement:** Optional +**Requirement:** Recommended Bounding box for the location, described in WKT, GeoJSON, or GML format @@ -487,10 +487,10 @@ Bounding box represented in GeoJSON format, either as a Polygon or in bbox array | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | -| Property | Type | Title/Description | -| -------------------------------------------- | ----- | ----------------- | -| + [coordinates](#location--bbox_anyOf_i2_coordinates) | array | - | -| + [type](#location--bbox_anyOf_i2_type) | const | - | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------------ | ----- | ----------------- | ----------------- | +| [coordinates](#location--bbox_anyOf_i2_coordinates) | array | Optional | - | +| [type](#location--bbox_anyOf_i2_type) | const | Optional | - | #### `Location > bbox > anyOf > item 2 > coordinates` @@ -560,10 +560,10 @@ Centroid represented in GeoJSON format; force point usage with coordinates of lo | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | -| Property | Type | Title/Description | -| ------------------------------------------------ | --------------- | ----------------- | -| + [coordinates](#location--centroid_anyOf_i2_coordinates) | array of number | - | -| + [type](#location--centroid_anyOf_i2_type) | const | - | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------------- | --------------- | ----------------- | ----------------- | +| [coordinates](#location--centroid_anyOf_i2_coordinates) | array of number | Optional | - | +| [type](#location--centroid_anyOf_i2_type) | const | Optional | - | #### `Location > centroid > anyOf > item 2 > coordinates` @@ -792,7 +792,7 @@ An alternative label or name for a location **Title:** geographic name -**Requirement:** Optional +**Requirement:** Recommended Preferred label or name of the Location @@ -834,13 +834,13 @@ A standard used to measure one aspect of data quality } ``` -| Property | Type | Title/Description | -| ---------------------------------------- | -------------- | ----------------- | -| - [@id](#metric--@id) | string | - | -| - [@type](#metric--@type) | string | - | -| + [expectedDataType](#metric--expectedDataType) | string | expected datatype | -| + [inDimension](#metric--inDimension) | string | in dimension | -| - [definition](#metric--definition) | null or string | definition | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------- | -------------- | ----------------- | ----------------- | +| [@id](#metric--@id) | string | Optional | - | +| [@type](#metric--@type) | string | Optional | - | +| [expectedDataType](#metric--expectedDataType) | string | Mandatory | expected datatype | +| [inDimension](#metric--inDimension) | string | Mandatory | in dimension | +| [definition](#metric--definition) | null or string | Recommended | definition | ## `Metric > @id` @@ -868,7 +868,7 @@ A standard used to measure one aspect of data quality **Title:** expected datatype -**Requirement:** Optional +**Requirement:** Mandatory Represents the expected data type for the metric's observed value (e.g., xsd:boolean, xsd:double etc...) @@ -890,7 +890,7 @@ Represents the expected data type for the metric's observed value (e.g., xsd:boo **Title:** in dimension -**Requirement:** Optional +**Requirement:** Mandatory Represents the dimensions a quality metric, certificate and annotation allow a measurement of. @@ -912,7 +912,7 @@ Represents the dimensions a quality metric, certificate and annotation allow a m **Title:** definition -**Requirement:** Optional +**Requirement:** Recommended Definition of the metric. @@ -957,13 +957,13 @@ A measurement of a resource against a specific quality metric } ``` -| Property | Type | Title/Description | -| -------------------------------------- | -------------- | ----------------- | -| - [@id](#quality-measurement--@id) | string | - | -| - [@type](#quality-measurement--@type) | string | - | -| + [isMeasurementOf](#quality-measurement--isMeasurementOf) | object | is measurement of | -| + [value](#quality-measurement--value) | string | value | -| - [unitMeasure](#quality-measurement--unitMeasure) | null or string | unit of measure | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------ | -------------- | ----------------- | ----------------- | +| [@id](#quality-measurement--@id) | string | Optional | - | +| [@type](#quality-measurement--@type) | string | Optional | - | +| [isMeasurementOf](#quality-measurement--isMeasurementOf) | object | Mandatory | is measurement of | +| [value](#quality-measurement--value) | string | Mandatory | value | +| [unitMeasure](#quality-measurement--unitMeasure) | null or string | Optional | unit of measure | ## `QualityMeasurement > @id` @@ -991,7 +991,7 @@ A measurement of a resource against a specific quality metric **Title:** is measurement of -**Requirement:** Optional +**Requirement:** Mandatory The metric being observed @@ -1005,7 +1005,7 @@ The metric being observed **Title:** value -**Requirement:** Optional +**Requirement:** Mandatory The value computed by metric @@ -1062,12 +1062,12 @@ An activity related to creating, changing, or using a resource } ``` -| Property | Type | Title/Description | -| ------------------------ | ------------- | ----------------- | -| - [@id](#activity--@id) | string | - | -| - [@type](#activity--@type) | string | - | -| - [category](#activity--category) | null or array | category | -| + [label](#activity--label) | string | label | +| Property | Type | Requirement Level | Title/Description | +| ---------------------- | ------------- | ----------------- | ----------------- | +| [@id](#activity--@id) | string | Optional | - | +| [@type](#activity--@type) | string | Optional | - | +| [category](#activity--category) | null or array | Optional | category | +| [label](#activity--label) | string | Mandatory | label | ## `Activity > @id` @@ -1110,7 +1110,7 @@ List of categories for the Activity **Title:** label -**Requirement:** Optional +**Requirement:** Mandatory A human-readable label for the activity @@ -1155,15 +1155,15 @@ A single physical address } ``` -| Property | Type | Title/Description | -| ------------------------------------ | -------------- | ------------------- | -| - [@id](#address--@id) | string | - | -| - [@type](#address--@type) | string | - | -| - [country-name](#address--country-name) | null or string | country | -| - [locality](#address--locality) | null or string | locality | -| - [postal-code](#address--postal-code) | null or string | postal code | -| - [region](#address--region) | null or string | administrative area | -| - [street-address](#address--street-address) | null or string | street address | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------- | -------------- | ----------------- | ------------------- | +| [@id](#address--@id) | string | Optional | - | +| [@type](#address--@type) | string | Optional | - | +| [country-name](#address--country-name) | null or string | Recommended | country | +| [locality](#address--locality) | null or string | Recommended | locality | +| [postal-code](#address--postal-code) | null or string | Recommended | postal code | +| [region](#address--region) | null or string | Recommended | administrative area | +| [street-address](#address--street-address) | null or string | Recommended | street address | ## `Address > @id` @@ -1191,7 +1191,7 @@ A single physical address **Title:** country -**Requirement:** Optional +**Requirement:** Recommended The country of the Address @@ -1208,7 +1208,7 @@ The country of the Address **Title:** locality -**Requirement:** Optional +**Requirement:** Recommended The city of the Address @@ -1229,7 +1229,7 @@ The city of the Address **Title:** postal code -**Requirement:** Optional +**Requirement:** Recommended The postal code of the Address @@ -1250,7 +1250,7 @@ The postal code of the Address **Title:** administrative area -**Requirement:** Optional +**Requirement:** Recommended The administrative area of the Address. Depending on the country, this corresponds to a province, a county, a region, or a state @@ -1271,7 +1271,7 @@ The administrative area of the Address. Depending on the country, this correspon **Title:** street address -**Requirement:** Optional +**Requirement:** Recommended The street name and civic number of an Address diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index 69984ed0..02f1676d 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -371,7 +371,10 @@ def schema_requirement_level(schema): if isinstance(keywords, dict): # New location for requirement metadata. if "requirementLevel" in keywords: - return _normalize_requirement_level(keywords.get("requirementLevel")) + requirement_level = keywords.get("requirementLevel") + if hasattr(requirement_level, "literal"): + requirement_level = requirement_level.literal + return _normalize_requirement_level(requirement_level) old_docs = {} if isinstance(keywords, dict): @@ -391,11 +394,30 @@ def properties_table_wrap(properties_list, schema): properties_list is a list of lists that will eventually be formatted into a table. """ - for line in properties_list: + property_nodes = list(schema.iterate_properties) + + for index, line in enumerate(properties_list): if "Combination" in line: # replace combining with something better line[line.index("Combination")] = "More than one type" + if not line: + continue + + if index == 0: + line = list(line) + properties_list[index] = line + property_column_index = line.index("Property") + line.insert(property_column_index + 2, "Requirement Level") + continue + + property_column_index = 0 + if line[property_column_index].startswith(("+ ", "- ")): + line[property_column_index] = line[property_column_index][2:] + + requirement = schema_requirement_level(property_nodes[index - 1]) + line.insert(property_column_index + 2, requirement) + # remove lines def _remove_me(line): return (line[0].strip("*") == "Required" and line[1] == "No") or ( From cb566c9d9e5a6c278136a840f5dfeccf5fe4937f Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 22:11:41 -0600 Subject: [PATCH 06/13] Only use title where additive; and use description where we can. Co-authored-by: Copilot --- jsonschema/doc_templates/md/content.md | 2 +- jsonschema/docs/agents.md | 80 ++--- jsonschema/docs/catalog.md | 140 ++------ .../docs/constraints-and-restrictions.md | 74 ++-- jsonschema/docs/dataset-series.md | 70 +--- jsonschema/docs/dataset.md | 276 ++++---------- jsonschema/docs/distribution.md | 186 ++-------- .../docs/identifiers-and-relationships.md | 142 +++----- jsonschema/docs/quality-governance.md | 340 +++++------------- jsonschema/docs/temporal-spatial-metrics.md | 154 +++----- jsonschema/generate_schema_docs.py | 49 ++- 11 files changed, 417 insertions(+), 1096 deletions(-) diff --git a/jsonschema/doc_templates/md/content.md b/jsonschema/doc_templates/md/content.md index a9dd78f0..bda421b2 100644 --- a/jsonschema/doc_templates/md/content.md +++ b/jsonschema/doc_templates/md/content.md @@ -14,7 +14,7 @@ {% set keys = schema.keywords %} {%- if not skip_headers %} -{% if schema.title and schema.title | length > 0 %} +{% if schema | should_render_title %} **Title:** {{ schema.title }} {% endif %} diff --git a/jsonschema/docs/agents.md b/jsonschema/docs/agents.md index b76db950..fb02f488 100644 --- a/jsonschema/docs/agents.md +++ b/jsonschema/docs/agents.md @@ -6,8 +6,6 @@ Data information classes including Agent, Organization, and Kind, which describe ## Class Agent -**Title:** Agent - A person, organization, software agent, or other entity involved with a resource | **Type** | `object` | @@ -26,12 +24,12 @@ A person, organization, software agent, or other entity involved with a resource } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------- | ------------- | ----------------- | ----------------- | -| [@id](#agent--@id) | string | Optional | - | -| [@type](#agent--@type) | string | Optional | - | -| [category](#agent--category) | null or array | Optional | category | -| [name](#agent--name) | string | Mandatory | name | +| Property | Type | Requirement Level | Title/Description | +| ---------------------- | ------------- | ----------------- | --------------------------------------------------- | +| [@id](#agent--@id) | string | Optional | | +| [@type](#agent--@type) | string | Optional | | +| [category](#agent--category) | null or array | Optional | The type of the agent that makes the item available | +| [name](#agent--name) | string | Mandatory | The name of the agent | ## `Agent > @id` @@ -57,8 +55,6 @@ A person, organization, software agent, or other entity involved with a resource ## `Agent > category` -**Title:** category - **Requirement:** Optional The type of the agent that makes the item available @@ -72,8 +68,6 @@ The type of the agent that makes the item available ## `Agent > name` -**Title:** name - **Requirement:** Mandatory The name of the agent @@ -98,8 +92,6 @@ The name of the agent ## Class Organization -**Title:** Organization - An organization involved with a resource, including parent or child organizations | **Type** | `object` | @@ -137,15 +129,15 @@ An organization involved with a resource, including parent or child organization } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------------------------- | ----------------------- | ----------------- | ------------------ | -| [@id](#organization--@id) | string | Optional | - | -| [@type](#organization--@type) | string | Optional | - | -| [name](#organization--name) | string | Mandatory | name | -| [subOrganizationOf](#organization--subOrganizationOf) | null or array | Optional | suborganization of | -| [altLabel](#organization--altLabel) | null or string | Optional | alternative label | -| [notation](#organization--notation) | null or array of string | Optional | notation | -| [prefLabel](#organization--prefLabel) | null or string | Optional | preferred label | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------- | ----------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#organization--@id) | string | Optional | | +| [@type](#organization--@type) | string | Optional | | +| [name](#organization--name) | string | Mandatory | The full name of the Organization | +| [subOrganizationOf](#organization--subOrganizationOf) | null or array | Optional | Represents hierarchical containment of Organizations or OrganizationalUnits; indicates an Organization which contains this Organization | +| [altLabel](#organization--altLabel) | null or string | Optional | alternative name (trading name, colloquial name) for an organization | +| [notation](#organization--notation) | null or array of string | Optional | List of abbreviations or codes from code lists for an organization (e.g. DOI, DOD) | +| [prefLabel](#organization--prefLabel) | null or string | Optional | Preferred or legal name of the organization | ## `Organization > @id` @@ -171,8 +163,6 @@ An organization involved with a resource, including parent or child organization ## `Organization > name` -**Title:** name - **Requirement:** Mandatory The full name of the Organization @@ -193,8 +183,6 @@ The full name of the Organization ## `Organization > subOrganizationOf` -**Title:** suborganization of - **Requirement:** Optional Represents hierarchical containment of Organizations or OrganizationalUnits; indicates an Organization which contains this Organization @@ -229,8 +217,6 @@ alternative name (trading name, colloquial name) for an organization ## `Organization > notation` -**Title:** notation - **Requirement:** Optional List of abbreviations or codes from code lists for an organization (e.g. DOI, DOD) @@ -253,8 +239,6 @@ List of abbreviations or codes from code lists for an organization (e.g. DOI, DO ### Abbreviation -**Title:** Abbreviation - | **Type** | `string` | | -------- | -------- | @@ -281,8 +265,6 @@ Preferred or legal name of the organization ## Class Kind -**Title:** Kind - Contact information for an individual or entity | **Type** | `object` | @@ -309,18 +291,18 @@ Contact information for an individual or entity } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------------------------- | -------------- | ----------------- | ----------------- | -| [@id](#kind--@id) | string | Optional | - | -| [@type](#kind--@type) | string | Optional | - | -| [address](#kind--address) | null or array | Optional | address | -| [hasEmail](#kind--hasEmail) | string | Mandatory | Email | -| [family-name](#kind--family-name) | null or string | Optional | family name | -| [fn](#kind--fn) | string | Mandatory | formatted name | -| [given-name](#kind--given-name) | null or string | Optional | given name | -| [organization-name](#kind--organization-name) | null or string | Optional | organization name | -| [tel](#kind--tel) | null or string | Optional | telephone | -| [title](#kind--title) | null or string | Optional | position title | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------- | -------------- | ----------------- | ----------------------------------------------------------------------------------------- | +| [@id](#kind--@id) | string | Optional | | +| [@type](#kind--@type) | string | Optional | | +| [address](#kind--address) | null or array | Optional | The address of the contact | +| [hasEmail](#kind--hasEmail) | string | Mandatory | Email address for the contact in mailto: format (for example, mailto:support@example.gov) | +| [family-name](#kind--family-name) | null or string | Optional | The family name of the contact | +| [fn](#kind--fn) | string | Mandatory | The formatted text of the name of the contact | +| [given-name](#kind--given-name) | null or string | Optional | The given name of the contact | +| [organization-name](#kind--organization-name) | null or string | Optional | The name of the organization to contact | +| [tel](#kind--tel) | null or string | Optional | The telephone number for the contact | +| [title](#kind--title) | null or string | Optional | The position role of the person to contact | ## `Kind > @id` @@ -346,8 +328,6 @@ Contact information for an individual or entity ## `Kind > address` -**Title:** address - **Requirement:** Optional The address of the contact @@ -387,8 +367,6 @@ Email address for the contact in mailto: format (for example, mailto:support@exa ## `Kind > family-name` -**Title:** family name - **Requirement:** Optional The family name of the contact @@ -426,8 +404,6 @@ The formatted text of the name of the contact ## `Kind > given-name` -**Title:** given name - **Requirement:** Optional The given name of the contact @@ -443,8 +419,6 @@ The given name of the contact ## `Kind > organization-name` -**Title:** organization name - **Requirement:** Optional The name of the organization to contact diff --git a/jsonschema/docs/catalog.md b/jsonschema/docs/catalog.md index d14a4327..6aa7e42d 100644 --- a/jsonschema/docs/catalog.md +++ b/jsonschema/docs/catalog.md @@ -2,8 +2,6 @@ The catalog of datasets, services, and other information describing data assets. -**Title:** DCAT-US 3 Catalog - A curated collection of metadata about datasets, data services, or other resources | **Type** | `object` | @@ -69,39 +67,39 @@ A curated collection of metadata about datasets, data services, or other resourc } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------------------------------- | ----------------------- | ----------------- | --------------------------- | -| [@id](#@id) | string | Optional | - | -| [@type](#@type) | string | Optional | - | -| [catalog](#catalog) | null or array | Optional | Related catalogs | -| [contactPoint](#contactPoint) | null or array | Optional | Contact points | -| [dataset](#dataset) | array | Mandatory | dataset | -| [keyword](#keyword) | null or array of string | Optional | keyword/tag | -| [record](#record) | null or array | Optional | catalog record | -| [service](#service) | null or array | Optional | service | -| [theme](#theme) | null or array | Optional | theme/category | -| [themeTaxonomy](#themeTaxonomy) | null or array | Recommended | themes | -| [accessRights](#accessRights) | More than one type | Optional | access rights | -| [conformsTo](#conformsTo) | More than one type | Recommended | schema version | -| [creator](#creator) | null or array | Optional | creator | -| [description](#description) | null or string | Optional | description | -| [hasPart](#hasPart) | null or array | Optional | has part | -| [identifier](#identifier) | More than one type | Optional | identifier | -| [otherIdentifier](#otherIdentifier) | null or array | Optional | other identifier | -| [issued](#issued) | More than one type | Recommended | release date | -| [language](#language) | More than one type | Recommended | language | -| [license](#license) | More than one type | Optional | license | -| [modified](#modified) | More than one type | Recommended | update/modification date | -| [publisher](#publisher) | More than one type | Optional | publisher | -| [rights](#rights) | null or array of string | Recommended | rights | -| [rightsHolder](#rightsHolder) | null or array | Optional | rights holder | -| [spatial](#spatial) | null or array | Recommended | spatial/geographic coverage | -| [subject](#subject) | null or array | Optional | subject | -| [temporal](#temporal) | null or array | Optional | temporal coverage | -| [title](#title) | null or string | Optional | title | -| [category](#category) | null or array | Optional | category | -| [homepage](#homepage) | More than one type | Recommended | homepage | -| [qualifiedAttribution](#qualifiedAttribution) | null or array | Optional | qualified attribution | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------------- | ----------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#@id) | string | Optional | | +| [@type](#@type) | string | Optional | | +| [catalog](#catalog) | null or array | Optional | List of related catalogs that are useful in the context of this catalog | +| [contactPoint](#contactPoint) | null or array | Optional | Contact information people can use to ask questions or send feedback about the catalog | +| [dataset](#dataset) | array | Mandatory | List of datasets included in the catalog. Use this together with service so the catalog is not empty. | +| [keyword](#keyword) | null or array of string | Optional | List of keywords or tags describing the catalog | +| [record](#record) | null or array | Optional | A catalog record describing how a single resource (such as a dataset or data service) is registered in the catalog | +| [service](#service) | null or array | Optional | List of data services included in the catalog. Use this together with dataset so the catalog is not empty. | +| [theme](#theme) | null or array | Optional | List of themes or categories for the catalog. A catalog can have more than one theme. | +| [themeTaxonomy](#themeTaxonomy) | null or array | Recommended | Controlled vocabulary or taxonomy used to classify catalog resources, such as datasets and services | +| [accessRights](#accessRights) | More than one type | Optional | Information about whether the catalog is publicly accessible, restricted, or not public | +| [conformsTo](#conformsTo) | More than one type | Recommended | Standard, schema, profile, or model that this catalog follows | +| [creator](#creator) | null or array | Optional | Person or organization responsible for creating the catalog metadata | +| [description](#description) | null or string | Optional | Plain-language summary of the catalog | +| [hasPart](#hasPart) | null or array | Optional | List of catalogs that are contained within this catalog | +| [identifier](#identifier) | More than one type | Optional | Main unique identifier for the catalog, such as a URI or another persistent identifier | +| [otherIdentifier](#otherIdentifier) | null or array | Optional | A list of identifiers for the Catalog besides the main identifier, e.g. the URI or other unique identifiers | +| [issued](#issued) | More than one type | Recommended | Date when the catalog was formally issued, such as its initial publication date | +| [language](#language) | More than one type | Recommended | Language codes used for catalog metadata text (such as titles and descriptions), using ISO 639-1 codes like en or es | +| [license](#license) | More than one type | Optional | License that governs how the catalog can be used or reused | +| [modified](#modified) | More than one type | Recommended | Most recent date when the catalog content changed, not just catalog-record metadata | +| [publisher](#publisher) | More than one type | Optional | Person or organization responsible for publishing and making the catalog available | +| [rights](#rights) | null or array of string | Recommended | Rights statements about the catalog that are not already covered by license or accessRights, such as copyright or policy restrictions | +| [rightsHolder](#rightsHolder) | null or array | Optional | Organizations that hold rights in the catalog | +| [spatial](#spatial) | null or array | Recommended | Geographic area covered by the catalog | +| [subject](#subject) | null or array | Optional | List of subjects of the catalog | +| [temporal](#temporal) | null or array | Optional | Time periods covered by the catalog | +| [title](#title) | null or string | Optional | Human-readable title of the catalog | +| [category](#category) | null or array | Optional | List of high-level categories for the catalog | +| [homepage](#homepage) | More than one type | Recommended | Main public web page for the catalog, usually an HTML page | +| [qualifiedAttribution](#qualifiedAttribution) | null or array | Optional | List of agents with specific responsibilities for the catalog | ## `DCAT-US 3 Catalog > @id` @@ -157,8 +155,6 @@ Contact information people can use to ask questions or send feedback about the c ## `DCAT-US 3 Catalog > dataset` -**Title:** dataset - **Requirement:** Mandatory List of datasets included in the catalog. Use this together with service so the catalog is not empty. @@ -223,8 +219,6 @@ A catalog record describing how a single resource (such as a dataset or data ser ## `DCAT-US 3 Catalog > service` -**Title:** service - **Requirement:** Optional List of data services included in the catalog. Use this together with dataset so the catalog is not empty. @@ -268,8 +262,6 @@ Controlled vocabulary or taxonomy used to classify catalog resources, such as da ## `DCAT-US 3 Catalog > accessRights` -**Title:** access rights - **Requirement:** Optional Information about whether the catalog is publicly accessible, restricted, or not public @@ -291,8 +283,6 @@ Information about whether the catalog is publicly accessible, restricted, or not ### `DCAT-US 3 Catalog > accessRights > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -322,15 +312,11 @@ Standard, schema, profile, or model that this catalog follows ### `DCAT-US 3 Catalog > conformsTo > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DCAT-US 3 Catalog > conformsTo > anyOf > Standard` -**Title:** Standard - A standard or specification that another resource conforms to | **Type** | `object` | @@ -340,8 +326,6 @@ A standard or specification that another resource conforms to ## `DCAT-US 3 Catalog > creator` -**Title:** creator - **Requirement:** Optional Person or organization responsible for creating the catalog metadata @@ -355,8 +339,6 @@ Person or organization responsible for creating the catalog metadata ## `DCAT-US 3 Catalog > description` -**Title:** description - **Requirement:** Optional Plain-language summary of the catalog @@ -376,8 +358,6 @@ Plain-language summary of the catalog ## `DCAT-US 3 Catalog > hasPart` -**Title:** has part - **Requirement:** Optional List of catalogs that are contained within this catalog @@ -391,8 +371,6 @@ List of catalogs that are contained within this catalog ## `DCAT-US 3 Catalog > identifier` -**Title:** identifier - **Requirement:** Optional Main unique identifier for the catalog, such as a URI or another persistent identifier @@ -408,15 +386,11 @@ Main unique identifier for the catalog, such as a URI or another persistent iden ### `DCAT-US 3 Catalog > identifier > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DCAT-US 3 Catalog > identifier > anyOf > Identifier` -**Title:** Identifier - inline description of Identifier | **Type** | More than one type | @@ -426,8 +400,6 @@ inline description of Identifier ## `DCAT-US 3 Catalog > otherIdentifier` -**Title:** other identifier - **Requirement:** Optional A list of identifiers for the Catalog besides the main identifier, e.g. the URI or other unique identifiers @@ -476,15 +448,11 @@ Date when the catalog was formally issued, such as its initial publication date ### `DCAT-US 3 Catalog > issued > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DCAT-US 3 Catalog > issued > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -532,8 +500,6 @@ A year and month in YYYY-MM format ## `DCAT-US 3 Catalog > language` -**Title:** language - **Requirement:** Recommended Language codes used for catalog metadata text (such as titles and descriptions), using ISO 639-1 codes like en or es @@ -565,15 +531,11 @@ Language codes used for catalog metadata text (such as titles and descriptions), ### `DCAT-US 3 Catalog > language > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DCAT-US 3 Catalog > language > anyOf > Language code` -**Title:** Language code - | **Type** | `string` | | -------- | -------- | @@ -583,8 +545,6 @@ Language codes used for catalog metadata text (such as titles and descriptions), ### `DCAT-US 3 Catalog > language > anyOf > List of language codes` -**Title:** List of language codes - | **Type** | `array of string` | | -------- | ----------------- | @@ -594,8 +554,6 @@ Language codes used for catalog metadata text (such as titles and descriptions), #### Language code -**Title:** Language code - | **Type** | `string` | | -------- | -------- | @@ -605,8 +563,6 @@ Language codes used for catalog metadata text (such as titles and descriptions), ## `DCAT-US 3 Catalog > license` -**Title:** license - **Requirement:** Optional License that governs how the catalog can be used or reused @@ -628,8 +584,6 @@ License that governs how the catalog can be used or reused ### `DCAT-US 3 Catalog > license > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -677,15 +631,11 @@ Most recent date when the catalog content changed, not just catalog-record metad ### `DCAT-US 3 Catalog > modified > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DCAT-US 3 Catalog > modified > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -733,8 +683,6 @@ A year and month in YYYY-MM format ## `DCAT-US 3 Catalog > publisher` -**Title:** publisher - **Requirement:** Optional Person or organization responsible for publishing and making the catalog available @@ -750,15 +698,11 @@ Person or organization responsible for publishing and making the catalog availab ### `DCAT-US 3 Catalog > publisher > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DCAT-US 3 Catalog > publisher > anyOf > Agent` -**Title:** Agent - inline description of the publisher | **Type** | `object` | @@ -768,8 +712,6 @@ inline description of the publisher ## `DCAT-US 3 Catalog > rights` -**Title:** rights - **Requirement:** Recommended Rights statements about the catalog that are not already covered by license or accessRights, such as copyright or policy restrictions @@ -805,8 +747,6 @@ Full text of a statement of rights ## `DCAT-US 3 Catalog > rightsHolder` -**Title:** rights holder - **Requirement:** Optional Organizations that hold rights in the catalog @@ -835,8 +775,6 @@ Geographic area covered by the catalog ## `DCAT-US 3 Catalog > subject` -**Title:** subject - **Requirement:** Optional List of subjects of the catalog @@ -865,8 +803,6 @@ Time periods covered by the catalog ## `DCAT-US 3 Catalog > title` -**Title:** title - **Requirement:** Optional Human-readable title of the catalog @@ -886,8 +822,6 @@ Human-readable title of the catalog ## `DCAT-US 3 Catalog > category` -**Title:** category - **Requirement:** Optional List of high-level categories for the catalog @@ -901,8 +835,6 @@ List of high-level categories for the catalog ## `DCAT-US 3 Catalog > homepage` -**Title:** homepage - **Requirement:** Recommended Main public web page for the catalog, usually an HTML page @@ -918,15 +850,11 @@ Main public web page for the catalog, usually an HTML page ### `DCAT-US 3 Catalog > homepage > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DCAT-US 3 Catalog > homepage > anyOf > Document` -**Title:** Document - inline description of the home page | **Type** | `object` | @@ -936,8 +864,6 @@ inline description of the home page ## `DCAT-US 3 Catalog > qualifiedAttribution` -**Title:** qualified attribution - **Requirement:** Optional List of agents with specific responsibilities for the catalog diff --git a/jsonschema/docs/constraints-and-restrictions.md b/jsonschema/docs/constraints-and-restrictions.md index ac9f6524..f1832871 100644 --- a/jsonschema/docs/constraints-and-restrictions.md +++ b/jsonschema/docs/constraints-and-restrictions.md @@ -6,8 +6,6 @@ Restriction classes describing access limits, controlled unclassified informatio ## Class AccessRestriction -**Title:** AccessRestriction - Rules or indicators that describe who can access a resource | **Type** | `object` | @@ -25,13 +23,13 @@ Rules or indicators that describe who can access a resource } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------------------------------- | ------------------ | ----------------- | -------------------- | -| [@id](#access-restriction--@id) | string | Optional | - | -| [@type](#access-restriction--@type) | string | Optional | - | -| [restrictionNote](#access-restriction--restrictionNote) | null or string | Optional | restriction note | -| [restrictionStatus](#access-restriction--restrictionStatus) | object | Mandatory | restriction status | -| [specificRestriction](#access-restriction--specificRestriction) | More than one type | Recommended | specific restriction | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#access-restriction--@id) | string | Optional | | +| [@type](#access-restriction--@type) | string | Optional | | +| [restrictionNote](#access-restriction--restrictionNote) | null or string | Optional | A note related to the access restriction | +| [restrictionStatus](#access-restriction--restrictionStatus) | object | Mandatory | The indication of whether or not there are access restrictions on the item, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/access-restriction-status | +| [specificRestriction](#access-restriction--specificRestriction) | More than one type | Recommended | Authority, code list entry, or policy reference that defines the specific access restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-access-restriction | ## `AccessRestriction > @id` @@ -51,8 +49,6 @@ Rules or indicators that describe who can access a resource ## `AccessRestriction > restrictionNote` -**Title:** restriction note - **Requirement:** Optional A note related to the access restriction @@ -68,8 +64,6 @@ A note related to the access restriction ## `AccessRestriction > restrictionStatus` -**Title:** restriction status - **Requirement:** Mandatory The indication of whether or not there are access restrictions on the item, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/access-restriction-status @@ -92,8 +86,6 @@ The indication of whether or not there are access restrictions on the item, cons ## `AccessRestriction > specificRestriction` -**Title:** specific restriction - **Requirement:** Recommended Authority, code list entry, or policy reference that defines the specific access restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-access-restriction @@ -119,15 +111,11 @@ Authority, code list entry, or policy reference that defines the specific access ### `AccessRestriction > specificRestriction > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `AccessRestriction > specificRestriction > anyOf > Concept` -**Title:** Concept - inline description of the specific restriction | **Type** | More than one type | @@ -141,8 +129,6 @@ inline description of the specific restriction ## Class CUIRestriction -**Title:** CUIRestriction - Information describing Controlled Unclassified Information (CUI) restrictions for a resource | **Type** | `object` | @@ -159,13 +145,13 @@ Information describing Controlled Unclassified Information (CUI) restrictions fo } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------------------------------------------------- | ----------------------- | ----------------- | -------------------------------- | -| [@id](#cui-restriction--@id) | string | Optional | - | -| [@type](#cui-restriction--@type) | string | Optional | - | -| [cuiBannerMarking](#cui-restriction--cuiBannerMarking) | string | Mandatory | CUI banner marking | -| [designationIndicator](#cui-restriction--designationIndicator) | string | Mandatory | CUI designation indicator | -| [requiredIndicatorPerAuthority](#cui-restriction--requiredIndicatorPerAuthority) | null or array of string | Optional | required indicator per authority | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------------------------------- | ----------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#cui-restriction--@id) | string | Optional | | +| [@type](#cui-restriction--@type) | string | Optional | | +| [cuiBannerMarking](#cui-restriction--cuiBannerMarking) | string | Mandatory | CUI (Controlled Unclassified Information) banner marking is required for any unclassified information that is deemed sensitive and requires protection; see information at https://www.archives.gov/cui/registry/category-marking-list | +| [designationIndicator](#cui-restriction--designationIndicator) | string | Mandatory | Agency that designated the information as CUI; include at least "Controlled by:" and, when possible, contact information | +| [requiredIndicatorPerAuthority](#cui-restriction--requiredIndicatorPerAuthority) | null or array of string | Optional | List of free-text required indicators from the applicable authority (for example, category descriptions or distribution statements) | ## `CUIRestriction > @id` @@ -191,8 +177,6 @@ Information describing Controlled Unclassified Information (CUI) restrictions fo ## `CUIRestriction > cuiBannerMarking` -**Title:** CUI banner marking - **Requirement:** Mandatory CUI (Controlled Unclassified Information) banner marking is required for any unclassified information that is deemed sensitive and requires protection; see information at https://www.archives.gov/cui/registry/category-marking-list @@ -235,8 +219,6 @@ Agency that designated the information as CUI; include at least "Controlled by:" ## `CUIRestriction > requiredIndicatorPerAuthority` -**Title:** required indicator per authority - **Requirement:** Optional List of free-text required indicators from the applicable authority (for example, category descriptions or distribution statements) @@ -259,8 +241,6 @@ List of free-text required indicators from the applicable authority (for example ### Indicator string -**Title:** Indicator string - | **Type** | `string` | | -------- | -------- | @@ -270,8 +250,6 @@ List of free-text required indicators from the applicable authority (for example ## Class UseRestriction -**Title:** UseRestriction - Rules or legal limits on how a resource may be used | **Type** | `object` | @@ -289,13 +267,13 @@ Rules or legal limits on how a resource may be used } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------------------------------- | ------------------ | ----------------- | -------------------- | -| [@id](#use-restriction--@id) | string | Optional | - | -| [@type](#use-restriction--@type) | string | Optional | - | -| [restrictionNote](#use-restriction--restrictionNote) | null or string | Optional | restriction note | -| [restrictionStatus](#use-restriction--restrictionStatus) | object | Mandatory | restriction status | -| [specificRestriction](#use-restriction--specificRestriction) | More than one type | Recommended | specific restriction | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#use-restriction--@id) | string | Optional | | +| [@type](#use-restriction--@type) | string | Optional | | +| [restrictionNote](#use-restriction--restrictionNote) | null or string | Optional | Significant information pertaining to the use or reproduction of the data | +| [restrictionStatus](#use-restriction--restrictionStatus) | object | Mandatory | Indication of whether or not there are use restrictions on the archival materials, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/use-restriction-status | +| [specificRestriction](#use-restriction--specificRestriction) | More than one type | Recommended | Authority, code list entry, or policy reference that defines the specific use restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-use-restriction | ## `UseRestriction > @id` @@ -321,8 +299,6 @@ Rules or legal limits on how a resource may be used ## `UseRestriction > restrictionNote` -**Title:** restriction note - **Requirement:** Optional Significant information pertaining to the use or reproduction of the data @@ -342,8 +318,6 @@ Significant information pertaining to the use or reproduction of the data ## `UseRestriction > restrictionStatus` -**Title:** restriction status - **Requirement:** Mandatory Indication of whether or not there are use restrictions on the archival materials, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/use-restriction-status @@ -366,8 +340,6 @@ Indication of whether or not there are use restrictions on the archival material ## `UseRestriction > specificRestriction` -**Title:** specific restriction - **Requirement:** Recommended Authority, code list entry, or policy reference that defines the specific use restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-use-restriction @@ -393,15 +365,11 @@ Authority, code list entry, or policy reference that defines the specific use re ### `UseRestriction > specificRestriction > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `UseRestriction > specificRestriction > anyOf > Concept` -**Title:** Concept - inline description of the specific restriction | **Type** | More than one type | diff --git a/jsonschema/docs/dataset-series.md b/jsonschema/docs/dataset-series.md index 0586e6f5..eb9f1de4 100644 --- a/jsonschema/docs/dataset-series.md +++ b/jsonschema/docs/dataset-series.md @@ -2,8 +2,6 @@ Information about a dataset series, including its members, ordering, coverage, and publishing details. -**Title:** DatasetSeries - A group of related datasets that are published separately | **Type** | `object` | @@ -143,22 +141,22 @@ A group of related datasets that are published separately } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------------------------ | ------------------ | ----------------- | --------------------------- | -| [@id](#@id) | string | Optional | - | -| [@type](#@type) | string | Optional | - | -| [contactPoint](#contactPoint) | null or array | Recommended | contact point | -| [first](#first) | More than one type | Recommended | first | -| [last](#last) | More than one type | Recommended | last | -| [seriesMember](#seriesMember) | null or array | Recommended | series member | -| [accrualPeriodicity](#accrualPeriodicity) | More than one type | Optional | frequency | -| [description](#description) | string | Mandatory | description | -| [issued](#issued) | More than one type | Optional | release date | -| [modified](#modified) | More than one type | Recommended | update/modification date | -| [publisher](#publisher) | More than one type | Recommended | publisher | -| [spatial](#spatial) | null or array | Recommended | spatial/geographic coverage | -| [temporal](#temporal) | null or array | Recommended | temporal coverage | -| [title](#title) | string | Mandatory | title | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------------ | ------------------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#@id) | string | Optional | | +| [@type](#@type) | string | Optional | | +| [contactPoint](#contactPoint) | null or array | Recommended | List of contacts people can use to ask questions or send feedback about the dataset series | +| [first](#first) | More than one type | Recommended | The first dataset in an ordered dataset series | +| [last](#last) | More than one type | Recommended | The last dataset in an ordered dataset series | +| [seriesMember](#seriesMember) | null or array | Recommended | List of members of the Dataset Series | +| [accrualPeriodicity](#accrualPeriodicity) | More than one type | Optional | The frequency at which the Dataset Series is updated. This is the series update frequency, not necessarily each dataset's frequency | +| [description](#description) | string | Mandatory | Plain-language summary of the dataset series | +| [issued](#issued) | More than one type | Optional | Date when the Dataset Series was formally established or published, not the release date of the oldest dataset in the series | +| [modified](#modified) | More than one type | Recommended | Most recent date when the Dataset Series changed, not the modified date of the newest dataset in the series | +| [publisher](#publisher) | More than one type | Recommended | Organization responsible for maintaining the Dataset Series as a coherent series; this may differ from publishers of individual datasets | +| [spatial](#spatial) | null or array | Recommended | A geographic region that is covered by the Dataset Series | +| [temporal](#temporal) | null or array | Recommended | Time periods covered by the dataset series | +| [title](#title) | string | Mandatory | Human-readable title of the dataset series | ## `DatasetSeries > @id` @@ -184,8 +182,6 @@ A group of related datasets that are published separately ## `DatasetSeries > contactPoint` -**Title:** contact point - **Requirement:** Recommended List of contacts people can use to ask questions or send feedback about the dataset series @@ -199,8 +195,6 @@ List of contacts people can use to ask questions or send feedback about the data ## `DatasetSeries > first` -**Title:** first - **Requirement:** Recommended The first dataset in an ordered dataset series @@ -216,15 +210,11 @@ The first dataset in an ordered dataset series ### `DatasetSeries > first > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DatasetSeries > first > anyOf > Dataset` -**Title:** Dataset - inline description of the first dataset | **Type** | `object` | @@ -237,8 +227,6 @@ inline description of the first dataset ## `DatasetSeries > last` -**Title:** last - **Requirement:** Recommended The last dataset in an ordered dataset series @@ -254,15 +242,11 @@ The last dataset in an ordered dataset series ### `DatasetSeries > last > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DatasetSeries > last > anyOf > Dataset` -**Title:** Dataset - inline description of the last dataset | **Type** | `object` | @@ -275,8 +259,6 @@ inline description of the last dataset ## `DatasetSeries > seriesMember` -**Title:** series member - **Requirement:** Recommended List of members of the Dataset Series @@ -315,8 +297,6 @@ The frequency at which the Dataset Series is updated. This is the series update ### `DatasetSeries > accrualPeriodicity > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -380,8 +360,6 @@ Must be one of: ## `DatasetSeries > description` -**Title:** description - **Requirement:** Mandatory Plain-language summary of the dataset series @@ -433,15 +411,11 @@ Date when the Dataset Series was formally established or published, not the rele ### `DatasetSeries > issued > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DatasetSeries > issued > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -528,15 +502,11 @@ Most recent date when the Dataset Series changed, not the modified date of the n ### `DatasetSeries > modified > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DatasetSeries > modified > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -584,8 +554,6 @@ A year and month in YYYY-MM format ## `DatasetSeries > publisher` -**Title:** publisher - **Requirement:** Recommended Organization responsible for maintaining the Dataset Series as a coherent series; this may differ from publishers of individual datasets @@ -601,15 +569,11 @@ Organization responsible for maintaining the Dataset Series as a coherent series ### `DatasetSeries > publisher > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DatasetSeries > publisher > anyOf > Agent` -**Title:** Agent - inline description of publisher | **Type** | `object` | @@ -649,8 +613,6 @@ Time periods covered by the dataset series ## `DatasetSeries > title` -**Title:** title - **Requirement:** Mandatory Human-readable title of the dataset series diff --git a/jsonschema/docs/dataset.md b/jsonschema/docs/dataset.md index 7c21e9bd..d6a5a455 100644 --- a/jsonschema/docs/dataset.md +++ b/jsonschema/docs/dataset.md @@ -2,8 +2,6 @@ Information about a dataset, including identifiers, contacts, coverage, distributions, and related resources. -**Title:** Dataset - A collection of data published or curated by one provider | **Type** | `object` | @@ -99,66 +97,66 @@ A collection of data published or curated by one provider } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------------------------------------------- | ----------------------- | ----------------- | --------------------------- | -| [@id](#@id) | string | Optional | - | -| [@type](#@type) | string | Optional | - | -| [otherIdentifier](#otherIdentifier) | null or array | Optional | other identifier | -| [sample](#sample) | null or array | Optional | sample | -| [status](#status) | More than one type | Optional | lifecycle status | -| [supportedSchema](#supportedSchema) | More than one type | Optional | supported schema | -| [versionNotes](#versionNotes) | null or string | Optional | version notes | -| [contactPoint](#contactPoint) | More than one type | Mandatory | contact point | -| [distribution](#distribution) | null or array | Recommended | dataset distribution | -| [first](#first) | More than one type | Optional | first | -| [hasCurrentVersion](#hasCurrentVersion) | More than one type | Optional | current version | -| [hasVersion](#hasVersion) | null or array | Optional | has version | -| [inSeries](#inSeries) | null or array | Optional | in series | -| [keyword](#keyword) | null or array of string | Recommended | keyword/tag | -| [landingPage](#landingPage) | More than one type | Recommended | landing page | -| [previousVersion](#previousVersion) | More than one type | Optional | previous version | -| [qualifiedRelation](#qualifiedRelation) | null or array | Optional | qualified relation | -| [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Optional | Spatial resolution (meters) | -| [temporalResolution](#temporalResolution) | null or string | Optional | temporal resolution | -| [theme](#theme) | null or array | Recommended | theme/category | -| [version](#version) | null or string | Optional | version | -| [describedBy](#describedBy) | More than one type | Recommended | data dictionary | -| [liabilityStatement](#liabilityStatement) | More than one type | Optional | liability statement | -| [metadataDistribution](#metadataDistribution) | null or array | Optional | metadata distribution | -| [purpose](#purpose) | null or string | Optional | purpose | -| [accessRights](#accessRights) | More than one type | Optional | access rights | -| [accrualPeriodicity](#accrualPeriodicity) | More than one type | Optional | frequency | -| [conformsTo](#conformsTo) | null or array | Optional | conforms to | -| [contributor](#contributor) | null or array | Optional | contributor | -| [created](#created) | More than one type | Optional | creation date | -| [creator](#creator) | More than one type | Optional | creator | -| [description](#description) | string | Mandatory | description | -| [hasPart](#hasPart) | null or array | Optional | has part | -| [identifier](#identifier) | More than one type | Mandatory | identifier | -| [isReferencedBy](#isReferencedBy) | null or array of string | Optional | is referenced by | -| [issued](#issued) | More than one type | Optional | release date | -| [language](#language) | More than one type | Optional | language | -| [modified](#modified) | More than one type | Recommended | last modified | -| [provenance](#provenance) | null or array of string | Optional | provenance | -| [publisher](#publisher) | object | Mandatory | publisher | -| [relation](#relation) | null or array of string | Optional | related resource | -| [replaces](#replaces) | null or array | Optional | replaces | -| [rights](#rights) | null or array of string | Recommended | rights | -| [rightsHolder](#rightsHolder) | null or array | Optional | rights holder | -| [source](#source) | null or array | Optional | data source | -| [spatial](#spatial) | More than one type | Recommended | spatial/geographic coverage | -| [subject](#subject) | null or array | Optional | subject | -| [temporal](#temporal) | null or array | Recommended | temporal coverage | -| [title](#title) | string | Mandatory | title | -| [category](#category) | null or array | Optional | category | -| [hasQualityMeasurement](#hasQualityMeasurement) | null or array | Optional | quality measurement | -| [page](#page) | null or array | Optional | documentation | -| [qualifiedAttribution](#qualifiedAttribution) | null or array | Optional | qualified attribution | -| [wasAttributedTo](#wasAttributedTo) | null or array | Optional | attribution | -| [wasGeneratedBy](#wasGeneratedBy) | null or array | Optional | was generated by | -| [wasUsedBy](#wasUsedBy) | null or array | Optional | used by | -| [image](#image) | More than one type | Optional | image | -| [scopeNote](#scopeNote) | null or string | Optional | usage note | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------------------- | ----------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#@id) | string | Optional | | +| [@type](#@type) | string | Optional | | +| [otherIdentifier](#otherIdentifier) | null or array | Optional | Additional identifiers for the dataset besides the main identifier, such as a DOI or other persistent ID | +| [sample](#sample) | null or array | Optional | List of sample distributions for the dataset | +| [status](#status) | More than one type | Optional | Lifecycle status of the dataset, such as completed, deprecated, under development, or withdrawn | +| [supportedSchema](#supportedSchema) | More than one type | Optional | supported schema for this dataset | +| [versionNotes](#versionNotes) | null or string | Optional | Notes describing how this version differs from earlier versions of the dataset | +| [contactPoint](#contactPoint) | More than one type | Mandatory | A contact point for questions about the Dataset (single contact or list). Include an email address that is continuously monitored | +| [distribution](#distribution) | null or array | Recommended | List of available distributions for the dataset. This can be omitted when no distribution is available yet. | +| [first](#first) | More than one type | Optional | the first item of the sequence the dataset belongs to | +| [hasCurrentVersion](#hasCurrentVersion) | More than one type | Optional | reference to the current (latest) version of a dataset | +| [hasVersion](#hasVersion) | null or array | Optional | List of related Datasets that are a version, edition, or adaptation of the described Dataset | +| [inSeries](#inSeries) | null or array | Optional | Dataset series this dataset belongs to | +| [keyword](#keyword) | null or array of string | Recommended | List of keywords or tags describing the dataset | +| [landingPage](#landingPage) | More than one type | Recommended | A web page from the original data provider that gives access to the Dataset, its Distributions, and related information | +| [previousVersion](#previousVersion) | More than one type | Optional | reference to the previous dataset version | +| [qualifiedRelation](#qualifiedRelation) | null or array | Optional | Detailed relationship between the dataset and another resource, including the role of that relationship | +| [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Optional | Smallest spatial distance between data points, in meters, represented as a single value | +| [temporalResolution](#temporalResolution) | null or string | Optional | Smallest time interval between data points, using xsd:duration format (for example, P1D) | +| [theme](#theme) | null or array | Recommended | List of themes or categories for the dataset | +| [version](#version) | null or string | Optional | The version indicator (name or identifier) of a resource | +| [describedBy](#describedBy) | More than one type | Recommended | A distribution describing the Data Dictionary for this dataset | +| [liabilityStatement](#liabilityStatement) | More than one type | Optional | A liability statement about the dataset that may clarify limitations of responsibility, qualifications on the accuracy, reliability, and completeness of the data, or absence of endorsement by the data publisher or provider, among other considerations | +| [metadataDistribution](#metadataDistribution) | null or array | Optional | Distribution of the original metadata document this dataset was derived from | +| [purpose](#purpose) | null or string | Optional | The purpose of the dataset | +| [accessRights](#accessRights) | More than one type | Optional | Information about whether the dataset is publicly accessible, restricted, or not public | +| [accrualPeriodicity](#accrualPeriodicity) | More than one type | Optional | The frequency at which the Dataset is updated | +| [conformsTo](#conformsTo) | null or array | Optional | List of standards, schemas, or profiles the dataset follows | +| [contributor](#contributor) | null or array | Optional | List of agents contributing to the Dataset | +| [created](#created) | More than one type | Optional | The date on which the Dataset was first created | +| [creator](#creator) | More than one type | Optional | Person or organization responsible for creating the dataset | +| [description](#description) | string | Mandatory | Plain-language summary of the dataset | +| [hasPart](#hasPart) | null or array | Optional | List of related datasets that are part of the described dataset | +| [identifier](#identifier) | More than one type | Mandatory | The unique identifier for the Dataset, e.g. the URI or other unique identifier in the context of the Catalog | +| [isReferencedBy](#isReferencedBy) | null or array of string | Optional | List of links to related resources, such as publications, that reference, cite, or otherwise point to the Dataset | +| [issued](#issued) | More than one type | Optional | Date when the dataset was first published. If the exact publication date is unknown, use the date it was first referenced in the catalog. | +| [language](#language) | More than one type | Optional | ISO 639-1 language code values used in the dataset text or metadata, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html | +| [modified](#modified) | More than one type | Recommended | Most recent date when the dataset's actual data changed, not just metadata | +| [provenance](#provenance) | null or array of string | Optional | List of statements about the lineage of a Dataset, including any changes in its ownership or custody since its creation that may be significant for its authenticity, integrity, or interpretation | +| [publisher](#publisher) | object | Mandatory | Organization responsible for publishing and making the dataset available | +| [relation](#relation) | null or array of string | Optional | List of links to related resources when the relationship is not otherwise specified | +| [replaces](#replaces) | null or array | Optional | List of Datasets replaced by this Dataset | +| [rights](#rights) | null or array of string | Recommended | Rights statements not already covered by license or accessRights, such as copyright or policy restrictions | +| [rightsHolder](#rightsHolder) | null or array | Optional | List of agents (organizations) holding rights on the Dataset | +| [source](#source) | null or array | Optional | List of related Datasets from which the described Dataset is derived | +| [spatial](#spatial) | More than one type | Recommended | A geographic region or regions that are covered by the Dataset | +| [subject](#subject) | null or array | Optional | List of primary subjects for the dataset, usually narrower than broad theme categories | +| [temporal](#temporal) | null or array | Recommended | Time periods covered by the dataset | +| [title](#title) | string | Mandatory | Human-readable title of the dataset | +| [category](#category) | null or array | Optional | List of high-level categories for the dataset | +| [hasQualityMeasurement](#hasQualityMeasurement) | null or array | Optional | List of quality measurements for the dataset (for example, completeness, accuracy, or timeliness) beyond spatial or temporal resolution | +| [page](#page) | null or array | Optional | List of pages or documents about this dataset | +| [qualifiedAttribution](#qualifiedAttribution) | null or array | Optional | List of agents with specific responsibilities for the dataset | +| [wasAttributedTo](#wasAttributedTo) | null or array | Optional | List of agents attributed to this dataset | +| [wasGeneratedBy](#wasGeneratedBy) | null or array | Optional | List of activities that generated, or provide the business context for the creation of the dataset | +| [wasUsedBy](#wasUsedBy) | null or array | Optional | List of activities that used the Dataset | +| [image](#image) | More than one type | Optional | Thumbnail image illustrating the dataset, especially useful for visual data such as maps, photos, or video | +| [scopeNote](#scopeNote) | null or string | Optional | usage note for the dataset | ## `Dataset > @id` @@ -184,8 +182,6 @@ A collection of data published or curated by one provider ## `Dataset > otherIdentifier` -**Title:** other identifier - **Requirement:** Optional Additional identifiers for the dataset besides the main identifier, such as a DOI or other persistent ID @@ -199,8 +195,6 @@ Additional identifiers for the dataset besides the main identifier, such as a DO ## `Dataset > sample` -**Title:** sample - **Requirement:** Optional List of sample distributions for the dataset @@ -231,15 +225,11 @@ Lifecycle status of the dataset, such as completed, deprecated, under developmen ### `Dataset > status > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > status > anyOf > Concept` -**Title:** Concept - inline description of Concept | **Type** | More than one type | @@ -249,8 +239,6 @@ inline description of Concept ## `Dataset > supportedSchema` -**Title:** supported schema - **Requirement:** Optional supported schema for this dataset @@ -266,15 +254,11 @@ supported schema for this dataset ### `Dataset > supportedSchema > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > supportedSchema > anyOf > Dataset` -**Title:** Dataset - inline description of the supported schema | **Type** | `object` | @@ -287,8 +271,6 @@ inline description of the supported schema ## `Dataset > versionNotes` -**Title:** version notes - **Requirement:** Optional Notes describing how this version differs from earlier versions of the dataset @@ -304,8 +286,6 @@ Notes describing how this version differs from earlier versions of the dataset ## `Dataset > contactPoint` -**Title:** contact point - **Requirement:** Mandatory A contact point for questions about the Dataset (single contact or list). Include an email address that is continuously monitored @@ -322,8 +302,6 @@ A contact point for questions about the Dataset (single contact or list). Includ ### `Dataset > contactPoint > anyOf > Kind` -**Title:** Kind - inline description of Kind | **Type** | `object` | @@ -333,8 +311,6 @@ inline description of Kind ### `Dataset > contactPoint > anyOf > List of contacts` -**Title:** List of contacts - | **Type** | `array` | | -------- | ------- | @@ -359,8 +335,6 @@ List of available distributions for the dataset. This can be omitted when no dis ## `Dataset > first` -**Title:** first - **Requirement:** Optional the first item of the sequence the dataset belongs to @@ -376,15 +350,11 @@ the first item of the sequence the dataset belongs to ### `Dataset > first > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > first > anyOf > Dataset` -**Title:** Dataset - inline description of Dataset | **Type** | `object` | @@ -414,15 +384,11 @@ reference to the current (latest) version of a dataset ### `Dataset > hasCurrentVersion > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > hasCurrentVersion > anyOf > Dataset` -**Title:** Dataset - inline description of Dataset | **Type** | `object` | @@ -435,8 +401,6 @@ inline description of Dataset ## `Dataset > hasVersion` -**Title:** has version - **Requirement:** Optional List of related Datasets that are a version, edition, or adaptation of the described Dataset @@ -450,8 +414,6 @@ List of related Datasets that are a version, edition, or adaptation of the descr ## `Dataset > inSeries` -**Title:** in series - **Requirement:** Optional Dataset series this dataset belongs to @@ -503,8 +465,6 @@ List of keywords or tags describing the dataset ### Non-empty string -**Title:** Non-empty string - | **Type** | `string` | | -------- | -------- | @@ -514,8 +474,6 @@ List of keywords or tags describing the dataset ## `Dataset > landingPage` -**Title:** landing page - **Requirement:** Recommended A web page from the original data provider that gives access to the Dataset, its Distributions, and related information @@ -531,15 +489,11 @@ A web page from the original data provider that gives access to the Dataset, its ### `Dataset > landingPage > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > landingPage > anyOf > Document` -**Title:** Document - inline description of Document | **Type** | `object` | @@ -549,8 +503,6 @@ inline description of Document ## `Dataset > previousVersion` -**Title:** previous version - **Requirement:** Optional reference to the previous dataset version @@ -566,15 +518,11 @@ reference to the previous dataset version ### `Dataset > previousVersion > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > previousVersion > anyOf > Dataset` -**Title:** Dataset - inline description of Dataset | **Type** | `object` | @@ -587,8 +535,6 @@ inline description of Dataset ## `Dataset > qualifiedRelation` -**Title:** qualified relation - **Requirement:** Optional Detailed relationship between the dataset and another resource, including the role of that relationship @@ -619,8 +565,6 @@ Smallest spatial distance between data points, in meters, represented as a singl ## `Dataset > temporalResolution` -**Title:** temporal resolution - **Requirement:** Optional Smallest time interval between data points, using xsd:duration format (for example, P1D) @@ -651,8 +595,6 @@ List of themes or categories for the dataset ## `Dataset > version` -**Title:** version - **Requirement:** Optional The version indicator (name or identifier) of a resource @@ -685,15 +627,11 @@ A distribution describing the Data Dictionary for this dataset ### `Dataset > describedBy > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > describedBy > anyOf > Distribution` -**Title:** Distribution - inline description of Distribution | **Type** | `object` | @@ -706,8 +644,6 @@ inline description of Distribution ## `Dataset > liabilityStatement` -**Title:** liability statement - **Requirement:** Optional A liability statement about the dataset that may clarify limitations of responsibility, qualifications on the accuracy, reliability, and completeness of the data, or absence of endorsement by the data publisher or provider, among other considerations @@ -729,8 +665,6 @@ A liability statement about the dataset that may clarify limitations of responsi ### `Dataset > liabilityStatement > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -743,8 +677,6 @@ Full text of the liability statement ## `Dataset > metadataDistribution` -**Title:** metadata distribution - **Requirement:** Optional Distribution of the original metadata document this dataset was derived from @@ -758,8 +690,6 @@ Distribution of the original metadata document this dataset was derived from ## `Dataset > purpose` -**Title:** purpose - **Requirement:** Optional The purpose of the dataset @@ -775,8 +705,6 @@ The purpose of the dataset ## `Dataset > accessRights` -**Title:** access rights - **Requirement:** Optional Information about whether the dataset is publicly accessible, restricted, or not public @@ -802,8 +730,6 @@ Information about whether the dataset is publicly accessible, restricted, or not ### `Dataset > accessRights > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -841,8 +767,6 @@ The frequency at which the Dataset is updated ### `Dataset > accrualPeriodicity > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -906,8 +830,6 @@ Must be one of: ## `Dataset > conformsTo` -**Title:** conforms to - **Requirement:** Optional List of standards, schemas, or profiles the dataset follows @@ -921,8 +843,6 @@ List of standards, schemas, or profiles the dataset follows ## `Dataset > contributor` -**Title:** contributor - **Requirement:** Optional List of agents contributing to the Dataset @@ -971,15 +891,11 @@ The date on which the Dataset was first created ### `Dataset > created > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > created > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -1027,8 +943,6 @@ A year and month in YYYY-MM format ## `Dataset > creator` -**Title:** creator - **Requirement:** Optional Person or organization responsible for creating the dataset @@ -1044,15 +958,11 @@ Person or organization responsible for creating the dataset ### `Dataset > creator > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > creator > anyOf > Agent` -**Title:** Agent - inline description of Agent | **Type** | `object` | @@ -1062,8 +972,6 @@ inline description of Agent ## `Dataset > description` -**Title:** description - **Requirement:** Mandatory Plain-language summary of the dataset @@ -1084,8 +992,6 @@ Plain-language summary of the dataset ## `Dataset > hasPart` -**Title:** has part - **Requirement:** Optional List of related datasets that are part of the described dataset @@ -1099,8 +1005,6 @@ List of related datasets that are part of the described dataset ## `Dataset > identifier` -**Title:** identifier - **Requirement:** Mandatory The unique identifier for the Dataset, e.g. the URI or other unique identifier in the context of the Catalog @@ -1117,15 +1021,11 @@ The unique identifier for the Dataset, e.g. the URI or other unique identifier i ### `Dataset > identifier > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > identifier > anyOf > Identifier` -**Title:** Identifier - inline description of Identifier | **Type** | More than one type | @@ -1135,8 +1035,6 @@ inline description of Identifier ## `Dataset > isReferencedBy` -**Title:** is referenced by - **Requirement:** Optional List of links to related resources, such as publications, that reference, cite, or otherwise point to the Dataset @@ -1158,8 +1056,6 @@ List of links to related resources, such as publications, that reference, cite, ### Link -**Title:** Link - reference iri of Resource | **Type** | `string` | @@ -1203,15 +1099,11 @@ Date when the dataset was first published. If the exact publication date is unkn ### `Dataset > issued > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > issued > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -1259,8 +1151,6 @@ A year and month in YYYY-MM format ## `Dataset > language` -**Title:** language - **Requirement:** Optional ISO 639-1 language code values used in the dataset text or metadata, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html @@ -1285,15 +1175,11 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en ### `Dataset > language > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > language > anyOf > Language code` -**Title:** Language code - | **Type** | `string` | | -------- | -------- | @@ -1303,8 +1189,6 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en ### `Dataset > language > anyOf > List of languages` -**Title:** List of languages - | **Type** | `array of string` | | -------- | ----------------- | @@ -1314,8 +1198,6 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en #### Language code -**Title:** Language code - | **Type** | `string` | | -------- | -------- | @@ -1360,15 +1242,11 @@ Most recent date when the dataset's actual data changed, not just metadata ### `Dataset > modified > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > modified > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -1416,8 +1294,6 @@ A year and month in YYYY-MM format ## `Dataset > provenance` -**Title:** provenance - **Requirement:** Optional List of statements about the lineage of a Dataset, including any changes in its ownership or custody since its creation that may be significant for its authenticity, integrity, or interpretation @@ -1447,8 +1323,6 @@ Full text of the provenance statement ## `Dataset > publisher` -**Title:** publisher - **Requirement:** Mandatory Organization responsible for publishing and making the dataset available @@ -1484,8 +1358,6 @@ List of links to related resources when the relationship is not otherwise specif ### Link -**Title:** Link - reference iri of Resource | **Type** | `string` | @@ -1494,8 +1366,6 @@ reference iri of Resource ## `Dataset > replaces` -**Title:** replaces - **Requirement:** Optional List of Datasets replaced by this Dataset @@ -1509,8 +1379,6 @@ List of Datasets replaced by this Dataset ## `Dataset > rights` -**Title:** rights - **Requirement:** Recommended Rights statements not already covered by license or accessRights, such as copyright or policy restrictions @@ -1545,8 +1413,6 @@ Full text of a statement of rights ## `Dataset > rightsHolder` -**Title:** rights holder - **Requirement:** Optional List of agents (organizations) holding rights on the Dataset @@ -1593,15 +1459,11 @@ A geographic region or regions that are covered by the Dataset ### `Dataset > spatial > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > spatial > anyOf > Location` -**Title:** Location - inline description of Location | **Type** | `object` | @@ -1611,8 +1473,6 @@ inline description of Location ### `Dataset > spatial > anyOf > List of geographic regions` -**Title:** List of geographic regions - | **Type** | `array` | | -------- | ------- | @@ -1622,8 +1482,6 @@ inline description of Location ## `Dataset > subject` -**Title:** subject - **Requirement:** Optional List of primary subjects for the dataset, usually narrower than broad theme categories @@ -1652,8 +1510,6 @@ Time periods covered by the dataset ## `Dataset > title` -**Title:** title - **Requirement:** Mandatory Human-readable title of the dataset @@ -1674,8 +1530,6 @@ Human-readable title of the dataset ## `Dataset > category` -**Title:** category - **Requirement:** Optional List of high-level categories for the dataset @@ -1719,8 +1573,6 @@ List of pages or documents about this dataset ## `Dataset > qualifiedAttribution` -**Title:** qualified attribution - **Requirement:** Optional List of agents with specific responsibilities for the dataset @@ -1749,8 +1601,6 @@ List of agents attributed to this dataset ## `Dataset > wasGeneratedBy` -**Title:** was generated by - **Requirement:** Optional List of activities that generated, or provide the business context for the creation of the dataset @@ -1779,8 +1629,6 @@ List of activities that used the Dataset ## `Dataset > image` -**Title:** image - **Requirement:** Optional Thumbnail image illustrating the dataset, especially useful for visual data such as maps, photos, or video @@ -1796,15 +1644,11 @@ Thumbnail image illustrating the dataset, especially useful for visual data such ### `Dataset > image > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Dataset > image > anyOf > Link` -**Title:** Link - The link to the image | **Type** | `string` | diff --git a/jsonschema/docs/distribution.md b/jsonschema/docs/distribution.md index 615de563..bb042df6 100644 --- a/jsonschema/docs/distribution.md +++ b/jsonschema/docs/distribution.md @@ -2,8 +2,6 @@ Information about a distribution, including access methods, formats, licenses, restrictions, and quality details. -**Title:** Distribution - A specific representation of a dataset, such as a file, feed, or API response | **Type** | `object` | @@ -38,43 +36,43 @@ A specific representation of a dataset, such as a file, feed, or API response } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------------------------------------------- | ----------------------- | ----------------- | --------------------------- | -| [@id](#@id) | string | Optional | - | -| [@type](#@type) | string | Optional | - | -| [representationTechnique](#representationTechnique) | More than one type | Optional | representation technique | -| [status](#status) | More than one type | Optional | lifecycle status | -| [characterEncoding](#characterEncoding) | More than one type | Optional | character encoding | -| [accessService](#accessService) | null or array | Optional | access service | -| [accessURL](#accessURL) | More than one type | Recommended | access URL | -| [byteSize](#byteSize) | null or string | Optional | byte size | -| [compressFormat](#compressFormat) | null or string | Optional | compression format | -| [downloadURL](#downloadURL) | More than one type | Optional | download URL | -| [mediaType](#mediaType) | null or string | Optional | media type | -| [packageFormat](#packageFormat) | null or string | Optional | packaging format | -| [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Optional | Spatial resolution (meters) | -| [temporalResolution](#temporalResolution) | null or string | Optional | termporal resolution | -| [availability](#availability) | More than one type | Optional | availability | -| [accessRestriction](#accessRestriction) | null or array | Recommended | access restriction | -| [cuiRestriction](#cuiRestriction) | More than one type | Recommended | CUI restriction | -| [describedBy](#describedBy) | More than one type | Recommended | data dictionary | -| [useRestriction](#useRestriction) | null or array | Recommended | use restriction | -| [accessRights](#accessRights) | More than one type | Optional | access rights | -| [conformsTo](#conformsTo) | null or array | Optional | linked schemas | -| [description](#description) | null or string | Recommended | description | -| [format](#format) | null or string | Recommended | format | -| [identifier](#identifier) | More than one type | Optional | identifier | -| [otherIdentifier](#otherIdentifier) | null or array | Optional | other identifier | -| [issued](#issued) | More than one type | Optional | release date | -| [language](#language) | More than one type | Optional | language | -| [license](#license) | More than one type | Recommended | license | -| [modified](#modified) | More than one type | Recommended | last modified | -| [rights](#rights) | null or array of string | Recommended | rights | -| [title](#title) | null or string | Recommended | title | -| [hasQualityMeasurement](#hasQualityMeasurement) | null or array | Optional | quality measurement | -| [page](#page) | null or array | Optional | documentation | -| [image](#image) | More than one type | Optional | image | -| [checksum](#checksum) | More than one type | Optional | checksum | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------------------- | ----------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#@id) | string | Optional | | +| [@type](#@type) | string | Optional | | +| [representationTechnique](#representationTechnique) | More than one type | Optional | Method or schema used to structure the distribution content (for example, CSV convention, XML schema, or spatial representation type) | +| [status](#status) | More than one type | Optional | The status of the distribution in the context of maturity lifecycle | +| [characterEncoding](#characterEncoding) | More than one type | Optional | List of character encodings used in the Distribution, using IANA character set names (for example, UTF-8) | +| [accessService](#accessService) | null or array | Optional | A data service that gives access to the distribution of the dataset | +| [accessURL](#accessURL) | More than one type | Recommended | URL for indirect access to the Distribution (for example, a landing page, API docs, or request form), not a direct file download | +| [byteSize](#byteSize) | null or string | Optional | The size of a Distribution in bytes | +| [compressFormat](#compressFormat) | null or string | Optional | The format of the file in which the data is contained in a compressed form, e.g. to reduce the size of the downloadable file | +| [downloadURL](#downloadURL) | More than one type | Optional | Direct URL to a downloadable file for the Distribution; use accessURL for indirect access | +| [mediaType](#mediaType) | null or string | Optional | MIME type of the Distribution (for example, text/csv or application/json), from the IANA media types registry: https://www.iana.org/assignments/media-types/media-types.xhtml | +| [packageFormat](#packageFormat) | null or string | Optional | The format of the file in which one or more data files are grouped together, e.g. to enable a set of related files to be downloaded together | +| [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Optional | The minimum spatial separation resolvable in a dataset distribution, measured in meters | +| [temporalResolution](#temporalResolution) | null or string | Optional | The minimum time period resolvable in the dataset distribution | +| [availability](#availability) | More than one type | Optional | An indication how long it is planned to keep the Distribution of the Dataset available | +| [accessRestriction](#accessRestriction) | null or array | Recommended | List of access restrictions related to the distribution | +| [cuiRestriction](#cuiRestriction) | More than one type | Recommended | Controlled Unclassified Information restriction related to the distribution | +| [describedBy](#describedBy) | More than one type | Recommended | A distribution containing the Data Dictionary for this distribution | +| [useRestriction](#useRestriction) | null or array | Recommended | Use restriction related to the distribution | +| [accessRights](#accessRights) | More than one type | Optional | Information about whether the distribution is publicly accessible, restricted, or not public | +| [conformsTo](#conformsTo) | null or array | Optional | List of standards, schemas, or reference systems the Distribution follows (prefer stable URIs when available) | +| [description](#description) | null or string | Recommended | Plain-language summary of the distribution | +| [format](#format) | null or string | Recommended | A human-readable description of the file format of the Distribution that provides useful information that might not be apparent from mediaType | +| [identifier](#identifier) | More than one type | Optional | The unique identifier for the Distribution (e.g. DOI, ISBN) | +| [otherIdentifier](#otherIdentifier) | null or array | Optional | A list of identifiers for the Distribution besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog | +| [issued](#issued) | More than one type | Optional | The date of formal issuance (e.g., publication) of the Distribution | +| [language](#language) | More than one type | Optional | ISO 639-1 language code values used in the distribution metadata text, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html | +| [license](#license) | More than one type | Recommended | License that governs how the distribution can be used or reused | +| [modified](#modified) | More than one type | Recommended | The most recent date on which the Distribution was changed or modified | +| [rights](#rights) | null or array of string | Recommended | Rights statements not already covered by license or accessRights, such as copyright or policy restrictions | +| [title](#title) | null or string | Recommended | Human-readable title of the distribution | +| [hasQualityMeasurement](#hasQualityMeasurement) | null or array | Optional | Quality measurements for the distribution (for example, completeness, accuracy, or timeliness) | +| [page](#page) | null or array | Optional | A page or document about this Distribution | +| [image](#image) | More than one type | Optional | A link to a thumbnail picture illustrating the content of the distribution | +| [checksum](#checksum) | More than one type | Optional | Checksum used to verify that the downloadable file content has not changed | ## `Distribution > @id` @@ -100,8 +98,6 @@ A specific representation of a dataset, such as a file, feed, or API response ## `Distribution > representationTechnique` -**Title:** representation technique - **Requirement:** Optional Method or schema used to structure the distribution content (for example, CSV convention, XML schema, or spatial representation type) @@ -117,15 +113,11 @@ Method or schema used to structure the distribution content (for example, CSV co ### `Distribution > representationTechnique > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > representationTechnique > anyOf > Concept` -**Title:** Concept - inline description of Concept | **Type** | More than one type | @@ -152,15 +144,11 @@ The status of the distribution in the context of maturity lifecycle ### `Distribution > status > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > status > anyOf > Concept` -**Title:** Concept - inline description of Concept | **Type** | More than one type | @@ -170,8 +158,6 @@ inline description of Concept ## `Distribution > characterEncoding` -**Title:** character encoding - **Requirement:** Optional List of character encodings used in the Distribution, using IANA character set names (for example, UTF-8) @@ -195,15 +181,11 @@ List of character encodings used in the Distribution, using IANA character set n ### `Distribution > characterEncoding > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > characterEncoding > anyOf > List of encodings` -**Title:** List of encodings - | **Type** | `array of string` | | -------- | ----------------- | @@ -213,15 +195,11 @@ List of character encodings used in the Distribution, using IANA character set n #### Character encoding -**Title:** Character encoding - | **Type** | `string` | | -------- | -------- | ## `Distribution > accessService` -**Title:** access service - **Requirement:** Optional A data service that gives access to the distribution of the dataset @@ -235,8 +213,6 @@ A data service that gives access to the distribution of the dataset ## `Distribution > accessURL` -**Title:** access URL - **Requirement:** Recommended URL for indirect access to the Distribution (for example, a landing page, API docs, or request form), not a direct file download @@ -262,15 +238,11 @@ URL for indirect access to the Distribution (for example, a landing page, API do ### `Distribution > accessURL > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > accessURL > anyOf > URL` -**Title:** URL - reference iri of Resource | **Type** | `string` | @@ -279,8 +251,6 @@ reference iri of Resource ## `Distribution > byteSize` -**Title:** byte size - **Requirement:** Optional The size of a Distribution in bytes @@ -313,8 +283,6 @@ The format of the file in which the data is contained in a compressed form, e.g. ## `Distribution > downloadURL` -**Title:** download URL - **Requirement:** Optional Direct URL to a downloadable file for the Distribution; use accessURL for indirect access @@ -336,15 +304,11 @@ Direct URL to a downloadable file for the Distribution; use accessURL for indire ### `Distribution > downloadURL > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > downloadURL > anyOf > URL` -**Title:** URL - reference iri of Resource | **Type** | `string` | @@ -353,8 +317,6 @@ reference iri of Resource ## `Distribution > mediaType` -**Title:** media type - **Requirement:** Optional MIME type of the Distribution (for example, text/csv or application/json), from the IANA media types registry: https://www.iana.org/assignments/media-types/media-types.xhtml @@ -421,8 +383,6 @@ The minimum time period resolvable in the dataset distribution ## `Distribution > availability` -**Title:** availability - **Requirement:** Optional An indication how long it is planned to keep the Distribution of the Dataset available @@ -438,15 +398,11 @@ An indication how long it is planned to keep the Distribution of the Dataset ava ### `Distribution > availability > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > availability > anyOf > Concept` -**Title:** Concept - inline description of Concept | **Type** | More than one type | @@ -456,8 +412,6 @@ inline description of Concept ## `Distribution > accessRestriction` -**Title:** access restriction - **Requirement:** Recommended List of access restrictions related to the distribution @@ -471,8 +425,6 @@ List of access restrictions related to the distribution ## `Distribution > cuiRestriction` -**Title:** CUI restriction - **Requirement:** Recommended Controlled Unclassified Information restriction related to the distribution @@ -488,15 +440,11 @@ Controlled Unclassified Information restriction related to the distribution ### `Distribution > cuiRestriction > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > cuiRestriction > anyOf > CUIRestriction` -**Title:** CUIRestriction - inline description of CUIRestriction | **Type** | `object` | @@ -523,15 +471,11 @@ A distribution containing the Data Dictionary for this distribution ### `Distribution > describedBy > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > describedBy > anyOf > Distribution` -**Title:** Distribution - inline description of the data dictionary | **Type** | `object` | @@ -544,8 +488,6 @@ inline description of the data dictionary ## `Distribution > useRestriction` -**Title:** use restriction - **Requirement:** Recommended Use restriction related to the distribution @@ -559,8 +501,6 @@ Use restriction related to the distribution ## `Distribution > accessRights` -**Title:** access rights - **Requirement:** Optional Information about whether the distribution is publicly accessible, restricted, or not public @@ -582,8 +522,6 @@ Information about whether the distribution is publicly accessible, restricted, o ### `Distribution > accessRights > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -611,8 +549,6 @@ List of standards, schemas, or reference systems the Distribution follows (prefe ## `Distribution > description` -**Title:** description - **Requirement:** Recommended Plain-language summary of the distribution @@ -632,8 +568,6 @@ Plain-language summary of the distribution ## `Distribution > format` -**Title:** format - **Requirement:** Recommended A human-readable description of the file format of the Distribution that provides useful information that might not be apparent from mediaType @@ -649,8 +583,6 @@ A human-readable description of the file format of the Distribution that provide ## `Distribution > identifier` -**Title:** identifier - **Requirement:** Optional The unique identifier for the Distribution (e.g. DOI, ISBN) @@ -666,15 +598,11 @@ The unique identifier for the Distribution (e.g. DOI, ISBN) ### `Distribution > identifier > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > identifier > anyOf > Identifier` -**Title:** Identifier - inline description of Identifier | **Type** | More than one type | @@ -684,8 +612,6 @@ inline description of Identifier ## `Distribution > otherIdentifier` -**Title:** other identifier - **Requirement:** Optional A list of identifiers for the Distribution besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog @@ -734,15 +660,11 @@ The date of formal issuance (e.g., publication) of the Distribution ### `Distribution > issued > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > issued > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -790,8 +712,6 @@ A year and month in YYYY-MM format ## `Distribution > language` -**Title:** language - **Requirement:** Optional ISO 639-1 language code values used in the distribution metadata text, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html @@ -821,15 +741,11 @@ ISO 639-1 language code values used in the distribution metadata text, such as e ### `Distribution > language > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > language > anyOf > Language code` -**Title:** Language code - | **Type** | `string` | | -------- | -------- | @@ -839,8 +755,6 @@ ISO 639-1 language code values used in the distribution metadata text, such as e ### `Distribution > language > anyOf > List of languages` -**Title:** List of languages - | **Type** | `array of string` | | -------- | ----------------- | @@ -850,8 +764,6 @@ ISO 639-1 language code values used in the distribution metadata text, such as e #### Language code -**Title:** Language code - | **Type** | `string` | | -------- | -------- | @@ -861,8 +773,6 @@ ISO 639-1 language code values used in the distribution metadata text, such as e ## `Distribution > license` -**Title:** license - **Requirement:** Recommended License that governs how the distribution can be used or reused @@ -884,8 +794,6 @@ License that governs how the distribution can be used or reused ### `Distribution > license > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -937,15 +845,11 @@ The most recent date on which the Distribution was changed or modified ### `Distribution > modified > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > modified > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -993,8 +897,6 @@ A year and month in YYYY-MM format ## `Distribution > rights` -**Title:** rights - **Requirement:** Recommended Rights statements not already covered by license or accessRights, such as copyright or policy restrictions @@ -1029,8 +931,6 @@ Full text of a statement of rights ## `Distribution > title` -**Title:** title - **Requirement:** Recommended Human-readable title of the distribution @@ -1076,8 +976,6 @@ A page or document about this Distribution ## `Distribution > image` -**Title:** image - **Requirement:** Optional A link to a thumbnail picture illustrating the content of the distribution @@ -1093,15 +991,11 @@ A link to a thumbnail picture illustrating the content of the distribution ### `Distribution > image > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > image > anyOf > Link` -**Title:** Link - The link to the image | **Type** | `string` | @@ -1110,8 +1004,6 @@ The link to the image ## `Distribution > checksum` -**Title:** checksum - **Requirement:** Optional Checksum used to verify that the downloadable file content has not changed @@ -1127,15 +1019,11 @@ Checksum used to verify that the downloadable file content has not changed ### `Distribution > checksum > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Distribution > checksum > anyOf > Checksum` -**Title:** Checksum - inline description of Checksum | **Type** | `object` | diff --git a/jsonschema/docs/identifiers-and-relationships.md b/jsonschema/docs/identifiers-and-relationships.md index 6fb2ff24..9d6c7848 100644 --- a/jsonschema/docs/identifiers-and-relationships.md +++ b/jsonschema/docs/identifiers-and-relationships.md @@ -6,8 +6,6 @@ Supporting classes for identifiers, relationships, checksums, and controlled con ## Class Identifier -**Title:** Identifier - A unique identifier and optionally it's scheme and other relevant information | **Type** | More than one type | @@ -21,28 +19,24 @@ A unique identifier and optionally it's scheme and other relevant information ## `Identifier > anyOf > Simple string identifier` -**Title:** Simple string identifier - | **Type** | `string` | | -------- | -------- | ## `Identifier > anyOf > Identifier as a complex object` -**Title:** Identifier as a complex object - | **Type** | `object` | | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | -| Property | Type | Requirement Level | Title/Description | -| --------------------------------------- | ------------------ | ----------------- | ----------------- | -| [@id](#identifier--anyOf_i1_@id) | string | Optional | - | -| [@type](#identifier--anyOf_i1_@type) | string | Optional | - | -| [schemaAgency](#identifier--anyOf_i1_schemaAgency) | null or string | Optional | schema agency | -| [creator](#identifier--anyOf_i1_creator) | More than one type | Optional | creator | -| [issued](#identifier--anyOf_i1_issued) | More than one type | Optional | issued | -| [version](#identifier--anyOf_i1_version) | null or string | Optional | version | -| [notation](#identifier--anyOf_i1_notation) | null or string | Optional | notation | +| Property | Type | Requirement Level | Title/Description | +| --------------------------------------- | ------------------ | ----------------- | ----------------------------------------------------------------- | +| [@id](#identifier--anyOf_i1_@id) | string | Optional | | +| [@type](#identifier--anyOf_i1_@type) | string | Optional | | +| [schemaAgency](#identifier--anyOf_i1_schemaAgency) | null or string | Optional | The name of the agency that issued the identifier | +| [creator](#identifier--anyOf_i1_creator) | More than one type | Optional | the agency that manages the identifier scheme | +| [issued](#identifier--anyOf_i1_issued) | More than one type | Optional | The date of formal issuance (e.g., publication) of the Identifier | +| [version](#identifier--anyOf_i1_version) | null or string | Optional | version of the identifier scheme | +| [notation](#identifier--anyOf_i1_notation) | null or string | Optional | abbreviation or code from code lists for an identifier | ### `Identifier > anyOf > Identifier as a complex object > @id` @@ -62,8 +56,6 @@ A unique identifier and optionally it's scheme and other relevant information ### `Identifier > anyOf > Identifier as a complex object > schemaAgency` -**Title:** schema agency - **Requirement:** Optional The name of the agency that issued the identifier @@ -73,8 +65,6 @@ The name of the agency that issued the identifier ### `Identifier > anyOf > Identifier as a complex object > creator` -**Title:** creator - **Requirement:** Optional the agency that manages the identifier scheme @@ -90,15 +80,11 @@ the agency that manages the identifier scheme #### `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | #### `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Organization` -**Title:** Organization - inline description of the creator | **Type** | `object` | @@ -108,8 +94,6 @@ inline description of the creator ### `Identifier > anyOf > Identifier as a complex object > issued` -**Title:** issued - **Requirement:** Optional The date of formal issuance (e.g., publication) of the Identifier @@ -125,15 +109,11 @@ The date of formal issuance (e.g., publication) of the Identifier #### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | #### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -181,8 +161,6 @@ A year and month in YYYY-MM format ### `Identifier > anyOf > Identifier as a complex object > version` -**Title:** version - **Requirement:** Optional version of the identifier scheme @@ -192,8 +170,6 @@ version of the identifier scheme ### `Identifier > anyOf > Identifier as a complex object > notation` -**Title:** notation - **Requirement:** Optional abbreviation or code from code lists for an identifier @@ -207,8 +183,6 @@ abbreviation or code from code lists for an identifier ## Class Relationship -**Title:** Relationship - Additional information about how one resource is related to another | **Type** | `object` | @@ -225,12 +199,12 @@ Additional information about how one resource is related to another } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------- | ------ | ----------------- | ----------------- | -| [@id](#relationship--@id) | string | Optional | - | -| [@type](#relationship--@type) | string | Optional | - | -| [hadRole](#relationship--hadRole) | string | Mandatory | role | -| [relation](#relationship--relation) | string | Mandatory | relation | +| Property | Type | Requirement Level | Title/Description | +| ---------------------- | ------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#relationship--@id) | string | Optional | | +| [@type](#relationship--@type) | string | Optional | | +| [hadRole](#relationship--hadRole) | string | Mandatory | The function of an entity or agent with respect to a dataset | +| [relation](#relationship--relation) | string | Mandatory | The entity related to the dataset. This string should unambiguously identify the related resource using an appropriate identifier. | ## `Relationship > @id` @@ -278,8 +252,6 @@ The function of an entity or agent with respect to a dataset ## `Relationship > relation` -**Title:** relation - **Requirement:** Mandatory The entity related to the dataset. This string should unambiguously identify the related resource using an appropriate identifier. @@ -304,8 +276,6 @@ The entity related to the dataset. This string should unambiguously identify the ## Class Checksum -**Title:** Checksum - A mechanism that can be used to verify that the contents of a distribution have not changed | **Type** | `object` | @@ -322,12 +292,12 @@ A mechanism that can be used to verify that the contents of a distribution have } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------------------- | ------ | ----------------- | ----------------- | -| [@id](#checksum--@id) | string | Optional | - | -| [@type](#checksum--@type) | string | Optional | - | -| [algorithm](#checksum--algorithm) | string | Mandatory | algorithm | -| [checksumValue](#checksum--checksumValue) | string | Mandatory | checksum value | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------- | ------ | ----------------- | --------------------------------------------------------------------------------- | +| [@id](#checksum--@id) | string | Optional | | +| [@type](#checksum--@type) | string | Optional | | +| [algorithm](#checksum--algorithm) | string | Mandatory | The algorithm used to produce the checksum | +| [checksumValue](#checksum--checksumValue) | string | Mandatory | A lower case hexadecimal encoded digest value produced using a specific algorithm | ## `Checksum > @id` @@ -353,8 +323,6 @@ A mechanism that can be used to verify that the contents of a distribution have ## `Checksum > algorithm` -**Title:** algorithm - **Requirement:** Mandatory The algorithm used to produce the checksum @@ -371,8 +339,6 @@ The algorithm used to produce the checksum ## `Checksum > checksumValue` -**Title:** checksum value - **Requirement:** Mandatory A lower case hexadecimal encoded digest value produced using a specific algorithm @@ -397,8 +363,6 @@ A lower case hexadecimal encoded digest value produced using a specific algorith ## Class Concept -**Title:** Concept - A controlled term or label, optionally drawn from a concept scheme | **Type** | More than one type | @@ -412,8 +376,6 @@ A controlled term or label, optionally drawn from a concept scheme ## `Concept > anyOf > Concept` -**Title:** Concept - The value of the concept, expressed as a string. This is only used when the concept is not further described by the properties of the Concept object and is not linked to a concept scheme. | **Type** | `string` | @@ -425,15 +387,15 @@ The value of the concept, expressed as a string. This is only used when the conc | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | -| Property | Type | Requirement Level | Title/Description | -| ----------------------------------- | ------------------ | ----------------- | ----------------- | -| [@id](#concept--anyOf_i1_@id) | string | Optional | - | -| [@type](#concept--anyOf_i1_@type) | string | Optional | - | -| [altLabel](#concept--anyOf_i1_altLabel) | null or string | Optional | alternate label | -| [definition](#concept--anyOf_i1_definition) | null or string | Optional | definition | -| [inScheme](#concept--anyOf_i1_inScheme) | object | Optional | in scheme | -| [notation](#concept--anyOf_i1_notation) | More than one type | Optional | notation | -| [prefLabel](#concept--anyOf_i1_prefLabel) | string | Optional | preferred label | +| Property | Type | Requirement Level | Title/Description | +| ----------------------------------- | ------------------ | ----------------- | -------------------------------------------------------------- | +| [@id](#concept--anyOf_i1_@id) | string | Optional | | +| [@type](#concept--anyOf_i1_@type) | string | Optional | | +| [altLabel](#concept--anyOf_i1_altLabel) | null or string | Optional | Alternative label for a concept | +| [definition](#concept--anyOf_i1_definition) | null or string | Optional | Definition of the controlled vocabulary term | +| [inScheme](#concept--anyOf_i1_inScheme) | object | Optional | Concept scheme defining this concept | +| [notation](#concept--anyOf_i1_notation) | More than one type | Optional | List of abbreviations or codes from code lists for the Concept | +| [prefLabel](#concept--anyOf_i1_prefLabel) | string | Optional | Preferred label for the term | ### `Concept > anyOf > item 1 > @id` @@ -464,8 +426,6 @@ Alternative label for a concept ### `Concept > anyOf > item 1 > definition` -**Title:** definition - **Requirement:** Optional Definition of the controlled vocabulary term @@ -475,8 +435,6 @@ Definition of the controlled vocabulary term ### `Concept > anyOf > item 1 > inScheme` -**Title:** in scheme - **Requirement:** Optional Concept scheme defining this concept @@ -488,8 +446,6 @@ Concept scheme defining this concept ### `Concept > anyOf > item 1 > notation` -**Title:** notation - **Requirement:** Optional List of abbreviations or codes from code lists for the Concept @@ -540,8 +496,6 @@ Preferred label for the term ## Class ConceptScheme -**Title:** ConceptScheme - A controlled vocabulary or other list of approved terms for a concept | **Type** | `object` | @@ -559,16 +513,16 @@ A controlled vocabulary or other list of approved terms for a concept } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------------- | ------------------ | ----------------- | ------------------------ | -| [@id](#concept-scheme--@id) | string | Optional | - | -| [@type](#concept-scheme--@type) | string | Optional | - | -| [version](#concept-scheme--version) | null or string | Optional | version info | -| [created](#concept-scheme--created) | More than one type | Optional | creation date | -| [description](#concept-scheme--description) | null or string | Recommended | description | -| [issued](#concept-scheme--issued) | More than one type | Optional | publication date | -| [modified](#concept-scheme--modified) | More than one type | Optional | update/modification date | -| [title](#concept-scheme--title) | string | Mandatory | title | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------- | ------------------ | ----------------- | ------------------------------------------------------------------------ | +| [@id](#concept-scheme--@id) | string | Optional | | +| [@type](#concept-scheme--@type) | string | Optional | | +| [version](#concept-scheme--version) | null or string | Optional | A version number or other version designation of the concept scheme | +| [created](#concept-scheme--created) | More than one type | Optional | The date on which the Concept Scheme was first created | +| [description](#concept-scheme--description) | null or string | Recommended | A description of the concept scheme | +| [issued](#concept-scheme--issued) | More than one type | Optional | The date of formal issuance (e.g., publication) of the concept scheme | +| [modified](#concept-scheme--modified) | More than one type | Optional | The most recent date at which the concept scheme was changed or modified | +| [title](#concept-scheme--title) | string | Mandatory | The title of the concept scheme | ## `ConceptScheme > @id` @@ -646,15 +600,11 @@ The date on which the Concept Scheme was first created ### `ConceptScheme > created > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `ConceptScheme > created > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -702,8 +652,6 @@ A year and month in YYYY-MM format ## `ConceptScheme > description` -**Title:** description - **Requirement:** Recommended A description of the concept scheme @@ -758,15 +706,11 @@ The date of formal issuance (e.g., publication) of the concept scheme ### `ConceptScheme > issued > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `ConceptScheme > issued > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -849,15 +793,11 @@ The most recent date at which the concept scheme was changed or modified ### `ConceptScheme > modified > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `ConceptScheme > modified > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -905,8 +845,6 @@ A year and month in YYYY-MM format ## `ConceptScheme > title` -**Title:** title - **Requirement:** Mandatory The title of the concept scheme diff --git a/jsonschema/docs/quality-governance.md b/jsonschema/docs/quality-governance.md index 28aad2fb..ff54a5b2 100644 --- a/jsonschema/docs/quality-governance.md +++ b/jsonschema/docs/quality-governance.md @@ -6,8 +6,6 @@ Supporting classes for standards, documents, catalog records, data services, and ## Class Standard -**Title:** Standard - A standard or specification that another resource conforms to | **Type** | `object` | @@ -35,19 +33,19 @@ A standard or specification that another resource conforms to } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------------------ | ------------------ | ----------------- | ----------------- | -| [@id](#standard--@id) | string | Optional | - | -| [@type](#standard--@type) | string | Optional | - | -| [created](#standard--created) | More than one type | Optional | creation date | -| [description](#standard--description) | null or string | Recommended | description | -| [identifier](#standard--identifier) | More than one type | Recommended | identifier | -| [otherIdentifier](#standard--otherIdentifier) | null or array | Optional | other identifier | -| [issued](#standard--issued) | More than one type | Recommended | issued | -| [modified](#standard--modified) | More than one type | Optional | last modified | -| [title](#standard--title) | null or string | Recommended | title | -| [category](#standard--category) | null or array | Optional | category | -| [inScheme](#standard--inScheme) | More than one type | Recommended | in scheme | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------ | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| [@id](#standard--@id) | string | Optional | | +| [@type](#standard--@type) | string | Optional | | +| [created](#standard--created) | More than one type | Optional | The date on which the Standard has been first created | +| [description](#standard--description) | null or string | Recommended | Plain-language summary of the standard | +| [identifier](#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](#standard--otherIdentifier) | null or array | 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](#standard--issued) | More than one type | Recommended | The date of formal issuance (e.g., publication) of the Standard | +| [modified](#standard--modified) | More than one type | Optional | The most recent date on which the Standard was changed or modified | +| [title](#standard--title) | null or string | Recommended | Human-readable title of the standard | +| [category](#standard--category) | null or array | Optional | List of categories for the Standard | +| [inScheme](#standard--inScheme) | More than one type | Recommended | The reference register to which the Standard belongs | ## `Standard > @id` @@ -108,15 +106,11 @@ The date on which the Standard has been first created ### `Standard > created > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Standard > created > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -164,8 +158,6 @@ A year and month in YYYY-MM format ## `Standard > description` -**Title:** description - **Requirement:** Recommended Plain-language summary of the standard @@ -185,8 +177,6 @@ Plain-language summary of the standard ## `Standard > identifier` -**Title:** identifier - **Requirement:** Recommended The unique identifier for the Standard, e.g. the URI or other unique identifier in the context of the Catalog @@ -202,15 +192,11 @@ The unique identifier for the Standard, e.g. the URI or other unique identifier ### `Standard > identifier > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Standard > identifier > anyOf > Identifier` -**Title:** Identifier - inline description of Identifier | **Type** | More than one type | @@ -220,8 +206,6 @@ inline description of Identifier ## `Standard > otherIdentifier` -**Title:** other identifier - **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 @@ -235,8 +219,6 @@ A list of identifiers for the Standard besides the main identifier, e.g. the URI ## `Standard > issued` -**Title:** issued - **Requirement:** Recommended The date of formal issuance (e.g., publication) of the Standard @@ -270,15 +252,11 @@ The date of formal issuance (e.g., publication) of the Standard ### `Standard > issued > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Standard > issued > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -361,15 +339,11 @@ The most recent date on which the Standard was changed or modified ### `Standard > modified > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Standard > modified > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -417,8 +391,6 @@ A year and month in YYYY-MM format ## `Standard > title` -**Title:** title - **Requirement:** Recommended Human-readable title of the standard @@ -438,8 +410,6 @@ Human-readable title of the standard ## `Standard > category` -**Title:** category - **Requirement:** Optional List of categories for the Standard @@ -453,8 +423,6 @@ List of categories for the Standard ## `Standard > inScheme` -**Title:** in scheme - **Requirement:** Recommended The reference register to which the Standard belongs @@ -470,15 +438,11 @@ The reference register to which the Standard belongs ### `Standard > inScheme > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Standard > inScheme > anyOf > ConceptScheme` -**Title:** ConceptScheme - inline description of ConceptScheme | **Type** | `object` | @@ -492,8 +456,6 @@ inline description of ConceptScheme ## Class Document -**Title:** Document - A publication or other document related to a resource | **Type** | `object` | @@ -521,25 +483,25 @@ A publication or other document related to a resource } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------------------------------ | ------------------ | ----------------- | ---------------------- | -| [@id](#document--@id) | string | Optional | - | -| [@type](#document--@type) | string | Optional | - | -| [accessURL](#document--accessURL) | More than one type | Optional | access URL | -| [downloadURL](#document--downloadURL) | More than one type | Optional | download URL | -| [creator](#document--creator) | null or array | Optional | author | -| [mediaType](#document--mediaType) | null or string | Optional | media type | -| [abstract](#document--abstract) | null or string | Optional | abstract | -| [bibliographicCitation](#document--bibliographicCitation) | null or string | Recommended | bibliographic citation | -| [conformsTo](#document--conformsTo) | null or array | Optional | conforms to | -| [corporateCreator](#document--corporateCreator) | null or array | Optional | corporate author | -| [description](#document--description) | null or string | Recommended | description | -| [identifier](#document--identifier) | More than one type | Recommended | identifier | -| [otherIdentifier](#document--otherIdentifier) | null or array | Optional | other identifier | -| [issued](#document--issued) | More than one type | Recommended | publication date | -| [publisher](#document--publisher) | null or array | Recommended | publisher | -| [title](#document--title) | string | Mandatory | title | -| [category](#document--category) | null or array | Optional | category | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------------------ | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [@id](#document--@id) | string | Optional | | +| [@type](#document--@type) | string | Optional | | +| [accessURL](#document--accessURL) | More than one type | Optional | A URL that gives access to the Document | +| [downloadURL](#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](#document--creator) | null or array | Optional | The individual(s) responsible for creating the Document | +| [mediaType](#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](#document--abstract) | null or string | Optional | Text abstract of the Document | +| [bibliographicCitation](#document--bibliographicCitation) | null or string | Recommended | Bibliographic citation as text | +| [conformsTo](#document--conformsTo) | null or array | Optional | List of standards or specifications the document follows | +| [corporateCreator](#document--corporateCreator) | null or array | Optional | The corporate organization(s) responsible for creating the Document | +| [description](#document--description) | null or string | Recommended | Plain-language summary of the document | +| [identifier](#document--identifier) | More than one type | Recommended | The unique identifier for the Document (e.g. DOI, ISBN) | +| [otherIdentifier](#document--otherIdentifier) | null or array | 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](#document--issued) | More than one type | Recommended | Publication date of the Document | +| [publisher](#document--publisher) | null or array | Recommended | The organization(s) that published the Document | +| [title](#document--title) | string | Mandatory | The title of the Document | +| [category](#document--category) | null or array | Optional | List of categories/genres for the Document | ## `Document > @id` @@ -565,8 +527,6 @@ A publication or other document related to a resource ## `Document > accessURL` -**Title:** access URL - **Requirement:** Optional A URL that gives access to the Document @@ -588,15 +548,11 @@ A URL that gives access to the Document ### `Document > accessURL > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Document > accessURL > anyOf > URL` -**Title:** URL - reference iri of Document | **Type** | `string` | @@ -605,8 +561,6 @@ reference iri of Document ## `Document > downloadURL` -**Title:** download URL - **Requirement:** Optional A URL that is a direct link to a downloadable file of the Document in a given format @@ -628,15 +582,11 @@ A URL that is a direct link to a downloadable file of the Document in a given fo ### `Document > downloadURL > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Document > downloadURL > anyOf > URL` -**Title:** URL - reference iri of Document | **Type** | `string` | @@ -660,8 +610,6 @@ The individual(s) responsible for creating the Document ## `Document > mediaType` -**Title:** media type - **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 @@ -677,8 +625,6 @@ The file format of the Document as defined in the official register of media typ ## `Document > abstract` -**Title:** abstract - **Requirement:** Optional Text abstract of the Document @@ -694,8 +640,6 @@ Text abstract of the Document ## `Document > bibliographicCitation` -**Title:** bibliographic citation - **Requirement:** Recommended Bibliographic citation as text @@ -715,8 +659,6 @@ Bibliographic citation as text ## `Document > conformsTo` -**Title:** conforms to - **Requirement:** Optional List of standards or specifications the document follows @@ -745,8 +687,6 @@ The corporate organization(s) responsible for creating the Document ## `Document > description` -**Title:** description - **Requirement:** Recommended Plain-language summary of the document @@ -766,8 +706,6 @@ Plain-language summary of the document ## `Document > identifier` -**Title:** identifier - **Requirement:** Recommended The unique identifier for the Document (e.g. DOI, ISBN) @@ -783,15 +721,11 @@ The unique identifier for the Document (e.g. DOI, ISBN) ### `Document > identifier > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `Document > identifier > anyOf > Identifier` -**Title:** Identifier - inline description of Identifier | **Type** | More than one type | @@ -801,8 +735,6 @@ inline description of Identifier ## `Document > otherIdentifier` -**Title:** other identifier - **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 @@ -851,8 +783,6 @@ Publication date of the Document ### `Document > issued > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -905,8 +835,6 @@ A year and month in YYYY-MM format ## `Document > publisher` -**Title:** publisher - **Requirement:** Recommended The organization(s) that published the Document @@ -920,8 +848,6 @@ The organization(s) that published the Document ## `Document > title` -**Title:** title - **Requirement:** Mandatory The title of the Document @@ -938,8 +864,6 @@ The title of the Document ## `Document > category` -**Title:** category - **Requirement:** Optional List of categories/genres for the Document @@ -957,8 +881,6 @@ List of categories/genres for the Document ## Class CatalogRecord -**Title:** CatalogRecord - A record in a catalog, describing the registration of a single resource | **Type** | `object` | @@ -984,19 +906,19 @@ A record in a catalog, describing the registration of a single resource } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------------ | ----------------------- | ----------------- | ------------------------ | -| [@id](#catalog-record--@id) | string | Optional | - | -| [@type](#catalog-record--@type) | string | Optional | - | -| [status](#catalog-record--status) | More than one type | Recommended | change type | -| [conformsTo](#catalog-record--conformsTo) | More than one type | Recommended | application profile | -| [description](#catalog-record--description) | null or array of string | Optional | Descriptions | -| [issued](#catalog-record--issued) | null or array | Optional | listing date | -| [language](#catalog-record--language) | More than one type | Optional | language | -| [modified](#catalog-record--modified) | More than one type | Mandatory | update/modification date | -| [source](#catalog-record--source) | null or string | Optional | source metadata | -| [title](#catalog-record--title) | null or string | Optional | title | -| [primaryTopic](#catalog-record--primaryTopic) | string | Mandatory | primary topic | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------ | ----------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [@id](#catalog-record--@id) | string | Optional | | +| [@type](#catalog-record--@type) | string | Optional | | +| [status](#catalog-record--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](#catalog-record--conformsTo) | More than one type | Recommended | An Application Profile that the Catalog Record's metadata conforms to | +| [description](#catalog-record--description) | null or array of string | Optional | A list of free-text accounts of the catalog record | +| [issued](#catalog-record--issued) | null or array | Optional | List of dates on which the catalog record was included in the catalog | +| [language](#catalog-record--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](#catalog-record--modified) | More than one type | Mandatory | The most recent date on which the catalog record was changed or modified | +| [source](#catalog-record--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](#catalog-record--title) | null or string | Optional | A name given to the Catalog Record | +| [primaryTopic](#catalog-record--primaryTopic) | string | Mandatory | A link to the Dataset, Data service or Catalog described in the Catalog Record | ## `CatalogRecord > @id` @@ -1039,15 +961,11 @@ The status of the catalog record in the context of editorial flow of the dataset ### `CatalogRecord > status > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `CatalogRecord > status > anyOf > Concept` -**Title:** Concept - inline description of status | **Type** | More than one type | @@ -1074,15 +992,11 @@ An Application Profile that the Catalog Record's metadata conforms to ### `CatalogRecord > conformsTo > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `CatalogRecord > conformsTo > anyOf > Standard` -**Title:** Standard - inline description of application profile | **Type** | `object` | @@ -1116,8 +1030,6 @@ A list of free-text accounts of the catalog record ### Description string -**Title:** Description string - | **Type** | `string` | | -------- | -------- | @@ -1164,8 +1076,6 @@ List of dates on which the catalog record was included in the catalog ### Date string -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -1213,8 +1123,6 @@ A year and month in YYYY-MM format ## `CatalogRecord > language` -**Title:** 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 @@ -1244,15 +1152,11 @@ Language code used in catalog record metadata text, using ISO 639-1 values such ### `CatalogRecord > language > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `CatalogRecord > language > anyOf > Language code` -**Title:** Language code - | **Type** | `string` | | -------- | -------- | @@ -1262,8 +1166,6 @@ Language code used in catalog record metadata text, using ISO 639-1 values such ### `CatalogRecord > language > anyOf > Array of language codes` -**Title:** Array of language codes - | **Type** | `array of string` | | -------- | ----------------- | @@ -1273,8 +1175,6 @@ Language code used in catalog record metadata text, using ISO 639-1 values such #### Language code -**Title:** Language code - | **Type** | `string` | | -------- | -------- | @@ -1373,8 +1273,6 @@ The original metadata that was used in creating metadata for the items in the ca ## `CatalogRecord > title` -**Title:** title - **Requirement:** Optional A name given to the Catalog Record @@ -1394,8 +1292,6 @@ A name given to the Catalog Record ## `CatalogRecord > primaryTopic` -**Title:** primary topic - **Requirement:** Mandatory A link to the Dataset, Data service or Catalog described in the Catalog Record @@ -1420,8 +1316,6 @@ A link to the Dataset, Data service or Catalog described in the Catalog Record ## Class DataService -**Title:** DataService - A service that provides access to data or data processing functions | **Type** | `object` | @@ -1476,38 +1370,38 @@ A service that provides access to data or data processing functions } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------------------------------------------- | ----------------------- | ----------------- | ---------------------------- | -| [@id](#data-service--@id) | string | Optional | - | -| [@type](#data-service--@type) | string | Optional | - | -| [contactPoint](#data-service--contactPoint) | array | Mandatory | contact point | -| [endpointDescription](#data-service--endpointDescription) | null or array of string | Recommended | endpoint description | -| [endpointURL](#data-service--endpointURL) | array of string | Mandatory | endpoint URL | -| [keyword](#data-service--keyword) | null or array of string | Optional | keyword/tag | -| [servesDataset](#data-service--servesDataset) | null or array | Recommended | serves dataset | -| [spatialResolutionInMeters](#data-service--spatialResolutionInMeters) | null or string | Optional | spatial resolution in meters | -| [temporalResolution](#data-service--temporalResolution) | null or string | Optional | temporal resolution | -| [theme](#data-service--theme) | null or array | Optional | theme/category | -| [accessRights](#data-service--accessRights) | More than one type | Optional | access rights | -| [conformsTo](#data-service--conformsTo) | null or array | Optional | conforms to | -| [created](#data-service--created) | More than one type | Optional | creation date | -| [creator](#data-service--creator) | null or array | Optional | creator | -| [description](#data-service--description) | null or string | Optional | description | -| [identifier](#data-service--identifier) | More than one type | Optional | identifier | -| [otherIdentifier](#data-service--otherIdentifier) | null or array | Optional | other identifier | -| [language](#data-service--language) | More than one type | Optional | language | -| [license](#data-service--license) | More than one type | Recommended | license | -| [modified](#data-service--modified) | More than one type | Optional | update/modification date | -| [publisher](#data-service--publisher) | object | Mandatory | publisher | -| [rights](#data-service--rights) | null or array of string | Optional | rights | -| [rightsHolder](#data-service--rightsHolder) | null or array | Optional | rights holder | -| [spatial](#data-service--spatial) | null or array | Optional | spatial/geographic coverage | -| [temporal](#data-service--temporal) | null or array | Optional | temporal coverage | -| [title](#data-service--title) | string | Mandatory | title | -| [category](#data-service--category) | null or array | Optional | category | -| [hasQualityMeasurement](#data-service--hasQualityMeasurement) | null or array | Optional | quality measurement | -| [qualifiedAttribution](#data-service--qualifiedAttribution) | null or array | Optional | qualified attribution | -| [wasUsedBy](#data-service--wasUsedBy) | null or array | Optional | was used by | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------------------- | ----------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#data-service--@id) | string | Optional | | +| [@type](#data-service--@type) | string | Optional | | +| [contactPoint](#data-service--contactPoint) | array | Mandatory | Contact information for questions about the Data Service. Include an email address that is continuously monitored | +| [endpointDescription](#data-service--endpointDescription) | null or array of string | Recommended | List of endpoint descriptions with operations and parameters (for example, OpenAPI or similar service documentation) | +| [endpointURL](#data-service--endpointURL) | array of string | Mandatory | A list of root locations or primary endpoints of the service (a Web-resolvable IRI) | +| [keyword](#data-service--keyword) | null or array of string | Optional | List of keywords or tags describing the data service | +| [servesDataset](#data-service--servesDataset) | null or array | Recommended | List of datasets this service provides access to | +| [spatialResolutionInMeters](#data-service--spatialResolutionInMeters) | null or string | Optional | The minimum spatial separation resolvable in a Data Service, measured in meters | +| [temporalResolution](#data-service--temporalResolution) | null or string | Optional | The minimum time period resolvable by the Data Service | +| [theme](#data-service--theme) | null or array | Optional | List of themes or categories for the data service | +| [accessRights](#data-service--accessRights) | More than one type | Optional | Information about whether the data service is publicly accessible, restricted, or not public | +| [conformsTo](#data-service--conformsTo) | null or array | Optional | List of general standards or specifications that the Data Service endpoints implement | +| [created](#data-service--created) | More than one type | Optional | The date on which the Data Service was first created | +| [creator](#data-service--creator) | null or array | Optional | List of agents primarily responsible for producing the Data Service | +| [description](#data-service--description) | null or string | Optional | Plain-language summary of the data service | +| [identifier](#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](#data-service--otherIdentifier) | null or array | 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](#data-service--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](#data-service--license) | More than one type | Recommended | License that governs how the data service can be used or reused | +| [modified](#data-service--modified) | More than one type | Optional | The most recent date on which the Data Service was changed or modified | +| [publisher](#data-service--publisher) | object | Mandatory | Person or organization responsible for publishing and making the data service available | +| [rights](#data-service--rights) | null or array of string | Optional | Rights statements not already covered by license or accessRights, such as copyright or policy restrictions | +| [rightsHolder](#data-service--rightsHolder) | null or array | Optional | A list of Agents (organizations) holding rights on the Data Service | +| [spatial](#data-service--spatial) | null or array | Optional | A geographic region that is covered by the Data Service | +| [temporal](#data-service--temporal) | null or array | Optional | Time periods covered by the data service | +| [title](#data-service--title) | string | Mandatory | Human-readable title of the data service | +| [category](#data-service--category) | null or array | Optional | List of high-level categories for the data service | +| [hasQualityMeasurement](#data-service--hasQualityMeasurement) | null or array | Optional | Quality measurements for the data service (for example, availability, response time, or reliability) | +| [qualifiedAttribution](#data-service--qualifiedAttribution) | null or array | Optional | List of agents with specific responsibilities for the data service | +| [wasUsedBy](#data-service--wasUsedBy) | null or array | Optional | List of activities that used or tested the data service | ## `DataService > @id` @@ -1533,8 +1427,6 @@ A service that provides access to data or data processing functions ## `DataService > contactPoint` -**Title:** contact point - **Requirement:** Mandatory Contact information for questions about the Data Service. Include an email address that is continuously monitored @@ -1549,8 +1441,6 @@ Contact information for questions about the Data Service. Include an email addre ## `DataService > endpointDescription` -**Title:** endpoint description - **Requirement:** Recommended List of endpoint descriptions with operations and parameters (for example, OpenAPI or similar service documentation) @@ -1583,8 +1473,6 @@ List of endpoint descriptions with operations and parameters (for example, OpenA ## `DataService > endpointURL` -**Title:** endpoint URL - **Requirement:** Mandatory A list of root locations or primary endpoints of the service (a Web-resolvable IRI) @@ -1614,8 +1502,6 @@ A list of root locations or primary endpoints of the service (a Web-resolvable I ### URLs -**Title:** URLs - The root location or primary endpoint of the service (a Web-resolvable IRI) | **Type** | `string` | @@ -1659,8 +1545,6 @@ List of keywords or tags describing the data service ### Non-empty strings -**Title:** Non-empty strings - | **Type** | `string` | | -------- | -------- | @@ -1670,8 +1554,6 @@ List of keywords or tags describing the data service ## `DataService > servesDataset` -**Title:** serves dataset - **Requirement:** Recommended List of datasets this service provides access to @@ -1685,8 +1567,6 @@ List of datasets this service provides access to ## `DataService > spatialResolutionInMeters` -**Title:** spatial resolution in meters - **Requirement:** Optional The minimum spatial separation resolvable in a Data Service, measured in meters @@ -1702,8 +1582,6 @@ The minimum spatial separation resolvable in a Data Service, measured in meters ## `DataService > temporalResolution` -**Title:** temporal resolution - **Requirement:** Optional The minimum time period resolvable by the Data Service @@ -1734,8 +1612,6 @@ List of themes or categories for the data service ## `DataService > accessRights` -**Title:** access rights - **Requirement:** Optional Information about whether the data service is publicly accessible, restricted, or not public @@ -1769,8 +1645,6 @@ Text description of the access rights ## `DataService > conformsTo` -**Title:** conforms to - **Requirement:** Optional List of general standards or specifications that the Data Service endpoints implement @@ -1824,8 +1698,6 @@ The date on which the Data Service was first created ### `DataService > created > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -1873,8 +1745,6 @@ A year and month in YYYY-MM format ## `DataService > creator` -**Title:** creator - **Requirement:** Optional List of agents primarily responsible for producing the Data Service @@ -1888,8 +1758,6 @@ List of agents primarily responsible for producing the Data Service ## `DataService > description` -**Title:** description - **Requirement:** Optional Plain-language summary of the data service @@ -1905,8 +1773,6 @@ Plain-language summary of the data service ## `DataService > identifier` -**Title:** identifier - **Requirement:** Optional The unique identifier for the Data Service, e.g. the URI or other unique identifier in the context of the Catalog @@ -1927,8 +1793,6 @@ The unique identifier for the Data Service, e.g. the URI or other unique identif ### `DataService > identifier > anyOf > Identifier` -**Title:** Identifier - inline description of Identifier | **Type** | More than one type | @@ -1938,8 +1802,6 @@ inline description of Identifier ## `DataService > otherIdentifier` -**Title:** other identifier - **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 @@ -1953,8 +1815,6 @@ A list of identifiers for the Data Service besides the main identifier, e.g. the ## `DataService > language` -**Title:** 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 @@ -1984,15 +1844,11 @@ ISO 639-1 language code values supported by the data service, such as en or es, ### `DataService > language > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DataService > language > anyOf > Language code` -**Title:** Language code - | **Type** | `string` | | -------- | -------- | @@ -2002,8 +1858,6 @@ ISO 639-1 language code values supported by the data service, such as en or es, ### `DataService > language > anyOf > List of lanuages` -**Title:** List of lanuages - | **Type** | `array of string` | | -------- | ----------------- | @@ -2013,8 +1867,6 @@ ISO 639-1 language code values supported by the data service, such as en or es, #### Language code -**Title:** Language code - | **Type** | `string` | | -------- | -------- | @@ -2024,8 +1876,6 @@ ISO 639-1 language code values supported by the data service, such as en or es, ## `DataService > license` -**Title:** license - **Requirement:** Recommended License that governs how the data service can be used or reused @@ -2047,8 +1897,6 @@ License that governs how the data service can be used or reused ### `DataService > license > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -2096,15 +1944,11 @@ The most recent date on which the Data Service was changed or modified ### `DataService > modified > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | ### `DataService > modified > anyOf > Date string` -**Title:** Date string - | **Type** | More than one type | | ------------------------- | ------------------ | | **Additional properties** | Any type allowed | @@ -2152,8 +1996,6 @@ A year and month in YYYY-MM format ## `DataService > publisher` -**Title:** publisher - **Requirement:** Mandatory Person or organization responsible for publishing and making the data service available @@ -2166,8 +2008,6 @@ Person or organization responsible for publishing and making the data service av ## `DataService > rights` -**Title:** rights - **Requirement:** Optional Rights statements not already covered by license or accessRights, such as copyright or policy restrictions @@ -2194,8 +2034,6 @@ Rights statements not already covered by license or accessRights, such as copyri ## `DataService > rightsHolder` -**Title:** rights holder - **Requirement:** Optional A list of Agents (organizations) holding rights on the Data Service @@ -2239,8 +2077,6 @@ Time periods covered by the data service ## `DataService > title` -**Title:** title - **Requirement:** Mandatory Human-readable title of the data service @@ -2257,8 +2093,6 @@ Human-readable title of the data service ## `DataService > category` -**Title:** category - **Requirement:** Optional List of high-level categories for the data service @@ -2287,8 +2121,6 @@ Quality measurements for the data service (for example, availability, response t ## `DataService > qualifiedAttribution` -**Title:** qualified attribution - **Requirement:** Optional List of agents with specific responsibilities for the data service @@ -2302,8 +2134,6 @@ List of agents with specific responsibilities for the data service ## `DataService > wasUsedBy` -**Title:** was used by - **Requirement:** Optional List of activities that used or tested the data service @@ -2321,8 +2151,6 @@ List of activities that used or tested the data service ## Class Attribution -**Title:** Attribution - A responsibility that an agent has for a resource | **Type** | `object` | @@ -2341,12 +2169,12 @@ A responsibility that an agent has for a resource } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------- | ------ | ----------------- | ----------------- | -| [@id](#attribution--@id) | string | Optional | - | -| [@type](#attribution--@type) | string | Optional | - | -| [hadRole](#attribution--hadRole) | string | Mandatory | role | -| [agent](#attribution--agent) | object | Mandatory | agent | +| Property | Type | Requirement Level | Title/Description | +| -------------------- | ------ | ----------------- | ----------------------------------------------------------------------------- | +| [@id](#attribution--@id) | string | Optional | | +| [@type](#attribution--@type) | string | Optional | | +| [hadRole](#attribution--hadRole) | string | Mandatory | The function of an entity or agent with respect to another entity or resource | +| [agent](#attribution--agent) | object | Mandatory | The agent that plays a role in the resource | ## `Attribution > @id` @@ -2390,8 +2218,6 @@ The function of an entity or agent with respect to another entity or resource ## `Attribution > agent` -**Title:** agent - **Requirement:** Mandatory The agent that plays a role in the resource diff --git a/jsonschema/docs/temporal-spatial-metrics.md b/jsonschema/docs/temporal-spatial-metrics.md index 64035d19..3fd7f3f7 100644 --- a/jsonschema/docs/temporal-spatial-metrics.md +++ b/jsonschema/docs/temporal-spatial-metrics.md @@ -6,8 +6,6 @@ Supporting classes for time periods, locations, quality metrics, measurements, a ## Class PeriodOfTime -**Title:** PeriodOfTime - Information about a specific time period with a start- and/or end-time | **Type** | More than one type | @@ -24,12 +22,12 @@ Information about a specific time period with a start- and/or end-time } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------ | ------------------ | ----------------- | ----------------- | -| [@id](#period-of-time--@id) | string | Optional | - | -| [@type](#period-of-time--@type) | string | Optional | - | -| [endDate](#period-of-time--endDate) | More than one type | Recommended | end date | -| [startDate](#period-of-time--startDate) | More than one type | Recommended | start date | +| Property | Type | Requirement Level | Title/Description | +| ------------------------ | ------------------ | ----------------- | ------------------------------------ | +| [@id](#period-of-time--@id) | string | Optional | | +| [@type](#period-of-time--@type) | string | Optional | | +| [endDate](#period-of-time--endDate) | More than one type | Recommended | The end date of the period of time | +| [startDate](#period-of-time--startDate) | More than one type | Recommended | The start date of the period of time | | Any of | | ------------------- | @@ -78,8 +76,6 @@ Information about a specific time period with a start- and/or end-time ## `PeriodOfTime > endDate` -**Title:** end date - **Requirement:** Recommended The end date of the period of time @@ -113,8 +109,6 @@ The end date of the period of time ### `PeriodOfTime > endDate > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -167,8 +161,6 @@ A year and month in YYYY-MM format ## `PeriodOfTime > startDate` -**Title:** start date - **Requirement:** Recommended The start date of the period of time @@ -202,8 +194,6 @@ The start date of the period of time ### `PeriodOfTime > startDate > anyOf > Null allowed when not required` -**Title:** Null allowed when not required - | **Type** | `null` | | -------- | ------ | @@ -260,8 +250,6 @@ A year and month in YYYY-MM format ## Class Location -**Title:** Location - A named place or geographic area | **Type** | `object` | @@ -378,18 +366,18 @@ A named place or geographic area } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------------------ | ------------------ | ----------------- | ----------------- | -| [@id](#location--@id) | string | Optional | - | -| [@type](#location--@type) | string | Optional | - | -| [bbox](#location--bbox) | More than one type | Recommended | bounding box | -| [centroid](#location--centroid) | More than one type | Optional | centroid | -| [identifier](#location--identifier) | More than one type | Optional | identifier | -| [otherIdentifier](#location--otherIdentifier) | null or array | Optional | other identifier | -| [geometry](#location--geometry) | More than one type | Optional | geometry | -| [inScheme](#location--inScheme) | More than one type | Optional | gazetteer | -| [altLabel](#location--altLabel) | null or string | Optional | alternative name | -| [prefLabel](#location--prefLabel) | null or string | Recommended | geographic name | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------ | ------------------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#location--@id) | string | Optional | | +| [@type](#location--@type) | string | Optional | | +| [bbox](#location--bbox) | More than one type | Recommended | Bounding box for the location, described in WKT, GeoJSON, or GML format | +| [centroid](#location--centroid) | More than one type | Optional | The geographic center (centroid) of a location described in WKT, GeoJSON, or GML format | +| [identifier](#location--identifier) | More than one type | Optional | The unique geographic identifier for the Location, e.g., the URI or other unique identifier in the context of the relevant gazetteer | +| [otherIdentifier](#location--otherIdentifier) | null or array | Optional | A list of geographic identifiers for the Location besides the main identifier, e.g. the URI or other unique identifiers in the context of the relevant gazetteer | +| [geometry](#location--geometry) | More than one type | Optional | Associates a location with a corresponding geometry described in WKT, GeoJSON, or GML format | +| [inScheme](#location--inScheme) | More than one type | Optional | The gazetteer to which the location belongs | +| [altLabel](#location--altLabel) | null or string | Optional | An alternative label or name for a location | +| [prefLabel](#location--prefLabel) | null or string | Recommended | Preferred label or name of the Location | ## `Location > @id` @@ -489,8 +477,8 @@ Bounding box represented in GeoJSON format, either as a Polygon or in bbox array | Property | Type | Requirement Level | Title/Description | | ------------------------------------------ | ----- | ----------------- | ----------------- | -| [coordinates](#location--bbox_anyOf_i2_coordinates) | array | Optional | - | -| [type](#location--bbox_anyOf_i2_type) | const | Optional | - | +| [coordinates](#location--bbox_anyOf_i2_coordinates) | array | Optional | | +| [type](#location--bbox_anyOf_i2_type) | const | Optional | | #### `Location > bbox > anyOf > item 2 > coordinates` @@ -512,8 +500,6 @@ Specific value: `"Polygon"` ## `Location > centroid` -**Title:** centroid - **Requirement:** Optional The geographic center (centroid) of a location described in WKT, GeoJSON, or GML format @@ -562,8 +548,8 @@ Centroid represented in GeoJSON format; force point usage with coordinates of lo | Property | Type | Requirement Level | Title/Description | | ---------------------------------------------- | --------------- | ----------------- | ----------------- | -| [coordinates](#location--centroid_anyOf_i2_coordinates) | array of number | Optional | - | -| [type](#location--centroid_anyOf_i2_type) | const | Optional | - | +| [coordinates](#location--centroid_anyOf_i2_coordinates) | array of number | Optional | | +| [type](#location--centroid_anyOf_i2_type) | const | Optional | | #### `Location > centroid > anyOf > item 2 > coordinates` @@ -594,8 +580,6 @@ Specific value: `"Point"` ## `Location > identifier` -**Title:** identifier - **Requirement:** Optional The unique geographic identifier for the Location, e.g., the URI or other unique identifier in the context of the relevant gazetteer @@ -616,8 +600,6 @@ The unique geographic identifier for the Location, e.g., the URI or other unique ### `Location > identifier > anyOf > Identifier` -**Title:** Identifier - inline description of Identifier | **Type** | More than one type | @@ -627,8 +609,6 @@ inline description of Identifier ## `Location > otherIdentifier` -**Title:** other identifier - **Requirement:** Optional A list of geographic identifiers for the Location besides the main identifier, e.g. the URI or other unique identifiers in the context of the relevant gazetteer @@ -642,8 +622,6 @@ A list of geographic identifiers for the Location besides the main identifier, e ## `Location > geometry` -**Title:** geometry - **Requirement:** Optional Associates a location with a corresponding geometry described in WKT, GeoJSON, or GML format @@ -762,8 +740,6 @@ The gazetteer to which the location belongs ### `Location > inScheme > anyOf > ConceptScheme` -**Title:** ConceptScheme - inline description of the gazetteer | **Type** | `object` | @@ -815,8 +791,6 @@ Preferred label or name of the Location ## Class Metric -**Title:** Metric - A standard used to measure one aspect of data quality | **Type** | `object` | @@ -834,13 +808,13 @@ A standard used to measure one aspect of data quality } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------------------------- | -------------- | ----------------- | ----------------- | -| [@id](#metric--@id) | string | Optional | - | -| [@type](#metric--@type) | string | Optional | - | -| [expectedDataType](#metric--expectedDataType) | string | Mandatory | expected datatype | -| [inDimension](#metric--inDimension) | string | Mandatory | in dimension | -| [definition](#metric--definition) | null or string | Recommended | definition | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------- | -------------- | ----------------- | -------------------------------------------------------------------------------------------------------- | +| [@id](#metric--@id) | string | Optional | | +| [@type](#metric--@type) | string | Optional | | +| [expectedDataType](#metric--expectedDataType) | string | Mandatory | Represents the expected data type for the metric's observed value (e.g., xsd:boolean, xsd:double etc...) | +| [inDimension](#metric--inDimension) | string | Mandatory | Represents the dimensions a quality metric, certificate and annotation allow a measurement of. | +| [definition](#metric--definition) | null or string | Recommended | Definition of the metric. | ## `Metric > @id` @@ -866,8 +840,6 @@ A standard used to measure one aspect of data quality ## `Metric > expectedDataType` -**Title:** expected datatype - **Requirement:** Mandatory Represents the expected data type for the metric's observed value (e.g., xsd:boolean, xsd:double etc...) @@ -888,8 +860,6 @@ Represents the expected data type for the metric's observed value (e.g., xsd:boo ## `Metric > inDimension` -**Title:** in dimension - **Requirement:** Mandatory Represents the dimensions a quality metric, certificate and annotation allow a measurement of. @@ -910,8 +880,6 @@ Represents the dimensions a quality metric, certificate and annotation allow a m ## `Metric > definition` -**Title:** definition - **Requirement:** Recommended Definition of the metric. @@ -935,8 +903,6 @@ Definition of the metric. ## Class QualityMeasurement -**Title:** QualityMeasurement - A measurement of a resource against a specific quality metric | **Type** | `object` | @@ -957,13 +923,13 @@ A measurement of a resource against a specific quality metric } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------------------ | -------------- | ----------------- | ----------------- | -| [@id](#quality-measurement--@id) | string | Optional | - | -| [@type](#quality-measurement--@type) | string | Optional | - | -| [isMeasurementOf](#quality-measurement--isMeasurementOf) | object | Mandatory | is measurement of | -| [value](#quality-measurement--value) | string | Mandatory | value | -| [unitMeasure](#quality-measurement--unitMeasure) | null or string | Optional | unit of measure | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------ | -------------- | ----------------- | ----------------------------------------- | +| [@id](#quality-measurement--@id) | string | Optional | | +| [@type](#quality-measurement--@type) | string | Optional | | +| [isMeasurementOf](#quality-measurement--isMeasurementOf) | object | Mandatory | The metric being observed | +| [value](#quality-measurement--value) | string | Mandatory | The value computed by metric | +| [unitMeasure](#quality-measurement--unitMeasure) | null or string | Optional | Unit of measure associated with the value | ## `QualityMeasurement > @id` @@ -989,8 +955,6 @@ A measurement of a resource against a specific quality metric ## `QualityMeasurement > isMeasurementOf` -**Title:** is measurement of - **Requirement:** Mandatory The metric being observed @@ -1003,8 +967,6 @@ The metric being observed ## `QualityMeasurement > value` -**Title:** value - **Requirement:** Mandatory The value computed by metric @@ -1042,8 +1004,6 @@ Unit of measure associated with the value ## Class Activity -**Title:** Activity - An activity related to creating, changing, or using a resource | **Type** | `object` | @@ -1062,12 +1022,12 @@ An activity related to creating, changing, or using a resource } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------- | ------------- | ----------------- | ----------------- | -| [@id](#activity--@id) | string | Optional | - | -| [@type](#activity--@type) | string | Optional | - | -| [category](#activity--category) | null or array | Optional | category | -| [label](#activity--label) | string | Mandatory | label | +| Property | Type | Requirement Level | Title/Description | +| ---------------------- | ------------- | ----------------- | --------------------------------------- | +| [@id](#activity--@id) | string | Optional | | +| [@type](#activity--@type) | string | Optional | | +| [category](#activity--category) | null or array | Optional | List of categories for the Activity | +| [label](#activity--label) | string | Mandatory | A human-readable label for the activity | ## `Activity > @id` @@ -1093,8 +1053,6 @@ An activity related to creating, changing, or using a resource ## `Activity > category` -**Title:** category - **Requirement:** Optional List of categories for the Activity @@ -1108,8 +1066,6 @@ List of categories for the Activity ## `Activity > label` -**Title:** label - **Requirement:** Mandatory A human-readable label for the activity @@ -1134,8 +1090,6 @@ A human-readable label for the activity ## Class Address -**Title:** Address - A single physical address | **Type** | `object` | @@ -1155,15 +1109,15 @@ A single physical address } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------------------- | -------------- | ----------------- | ------------------- | -| [@id](#address--@id) | string | Optional | - | -| [@type](#address--@type) | string | Optional | - | -| [country-name](#address--country-name) | null or string | Recommended | country | -| [locality](#address--locality) | null or string | Recommended | locality | -| [postal-code](#address--postal-code) | null or string | Recommended | postal code | -| [region](#address--region) | null or string | Recommended | administrative area | -| [street-address](#address--street-address) | null or string | Recommended | street address | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------- | -------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#address--@id) | string | Optional | | +| [@type](#address--@type) | string | Optional | | +| [country-name](#address--country-name) | null or string | Recommended | The country of the Address | +| [locality](#address--locality) | null or string | Recommended | The city of the Address | +| [postal-code](#address--postal-code) | null or string | Recommended | The postal code of the Address | +| [region](#address--region) | null or string | Recommended | The administrative area of the Address. Depending on the country, this corresponds to a province, a county, a region, or a state | +| [street-address](#address--street-address) | null or string | Recommended | The street name and civic number of an Address | ## `Address > @id` @@ -1206,8 +1160,6 @@ The country of the Address ## `Address > locality` -**Title:** locality - **Requirement:** Recommended The city of the Address @@ -1227,8 +1179,6 @@ The city of the Address ## `Address > postal-code` -**Title:** postal code - **Requirement:** Recommended The postal code of the Address @@ -1269,8 +1219,6 @@ The administrative area of the Address. Depending on the country, this correspon ## `Address > street-address` -**Title:** street address - **Requirement:** Recommended The street name and civic number of an Address diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index 02f1676d..22849225 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -360,6 +360,46 @@ def _normalize_requirement_level(value): return "Optional" +def _normalize_label(value): + if value is None: + return "" + return re.sub(r"[^a-z0-9]+", "", str(value).strip().lower()) + + +def _escape_for_table(value): + if value is None: + return "" + return str(value).translate(str.maketrans({"|": "\\|", "`": "\\`", "\n": "
"})) + + +def should_render_title(schema): + """Return False when the title just repeats the current node label.""" + title = getattr(schema, "title", None) + normalized_title = _normalize_label(title) + if not normalized_title: + return False + + candidate_labels = { + _normalize_label(getattr(schema, "property_name", None)), + _normalize_label(getattr(schema, "name_for_breadcrumbs", None)), + } + candidate_labels.discard("") + return normalized_title not in candidate_labels + + +def property_summary_text(schema): + """Return the preferred summary text for property tables.""" + description = getattr(schema, "description", None) + if description: + return description + + title = getattr(schema, "title", None) + if should_render_title(schema): + return title + + return "" + + def schema_requirement_level(schema): """Template helper for property requirement level. @@ -415,8 +455,12 @@ def properties_table_wrap(properties_list, schema): if line[property_column_index].startswith(("+ ", "- ")): line[property_column_index] = line[property_column_index][2:] - requirement = schema_requirement_level(property_nodes[index - 1]) + property_node = property_nodes[index - 1] + requirement = schema_requirement_level(property_node) line.insert(property_column_index + 2, requirement) + line[property_column_index + 3] = _escape_for_table( + property_summary_text(property_node) + ) # remove lines def _remove_me(line): @@ -510,6 +554,9 @@ def _render_raw_docs(output_dir): original_md_properties_table = template_renderer.template.environment.filters[ "md_properties_table" ] + template_renderer.template.environment.filters["should_render_title"] = ( + should_render_title + ) template_renderer.template.environment.filters["schema_requirement_level"] = ( schema_requirement_level ) From adfa6e30635aec7962d405254e9873cf6277e856 Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 22:21:37 -0600 Subject: [PATCH 07/13] Simplify array listings and reference other classes. Co-authored-by: Copilot --- jsonschema/docs/agents.md | 70 +-- jsonschema/docs/catalog.md | 212 ++++----- .../docs/constraints-and-restrictions.md | 24 +- jsonschema/docs/dataset-series.md | 96 ++-- jsonschema/docs/dataset.md | 384 ++++++++-------- jsonschema/docs/distribution.md | 230 +++++----- .../docs/identifiers-and-relationships.md | 76 ++-- jsonschema/docs/quality-governance.md | 416 +++++++++--------- jsonschema/docs/temporal-spatial-metrics.md | 112 ++--- jsonschema/generate_schema_docs.py | 36 +- 10 files changed, 844 insertions(+), 812 deletions(-) diff --git a/jsonschema/docs/agents.md b/jsonschema/docs/agents.md index fb02f488..9903cc6e 100644 --- a/jsonschema/docs/agents.md +++ b/jsonschema/docs/agents.md @@ -24,12 +24,12 @@ A person, organization, software agent, or other entity involved with a resource } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------- | ------------- | ----------------- | --------------------------------------------------- | -| [@id](#agent--@id) | string | Optional | | -| [@type](#agent--@type) | string | Optional | | -| [category](#agent--category) | null or array | Optional | The type of the agent that makes the item available | -| [name](#agent--name) | string | Mandatory | The name of the agent | +| Property | Type | Requirement Level | Title/Description | +| ---------------------- | ------------------------------------------------------------------------------ | ----------------- | --------------------------------------------------- | +| [@id](#agent--@id) | string | Optional | | +| [@type](#agent--@type) | string | Optional | | +| [category](#agent--category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | The type of the agent that makes the item available | +| [name](#agent--name) | string | Mandatory | The name of the agent | ## `Agent > @id` @@ -59,8 +59,8 @@ A person, organization, software agent, or other entity involved with a resource The type of the agent that makes the item available -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -129,15 +129,15 @@ An organization involved with a resource, including parent or child organization } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------------------------- | ----------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| [@id](#organization--@id) | string | Optional | | -| [@type](#organization--@type) | string | Optional | | -| [name](#organization--name) | string | Mandatory | The full name of the Organization | -| [subOrganizationOf](#organization--subOrganizationOf) | null or array | Optional | Represents hierarchical containment of Organizations or OrganizationalUnits; indicates an Organization which contains this Organization | -| [altLabel](#organization--altLabel) | null or string | Optional | alternative name (trading name, colloquial name) for an organization | -| [notation](#organization--notation) | null or array of string | Optional | List of abbreviations or codes from code lists for an organization (e.g. DOI, DOD) | -| [prefLabel](#organization--prefLabel) | null or string | Optional | Preferred or legal name of the organization | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------- | ----------------------------------------------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#organization--@id) | string | Optional | | +| [@type](#organization--@type) | string | Optional | | +| [name](#organization--name) | string | Mandatory | The full name of the Organization | +| [subOrganizationOf](#organization--subOrganizationOf) | null or array of [Organization](./agents.md#organization) classes | Optional | Represents hierarchical containment of Organizations or OrganizationalUnits; indicates an Organization which contains this Organization | +| [altLabel](#organization--altLabel) | null or string | Optional | alternative name (trading name, colloquial name) for an organization | +| [notation](#organization--notation) | null or array of string | Optional | List of abbreviations or codes from code lists for an organization (e.g. DOI, DOD) | +| [prefLabel](#organization--prefLabel) | null or string | Optional | Preferred or legal name of the organization | ## `Organization > @id` @@ -187,8 +187,8 @@ The full name of the Organization Represents hierarchical containment of Organizations or OrganizationalUnits; indicates an Organization which contains this Organization -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Organization](./agents.md#organization) classes | +| -------- | ----------------------------------------------------------------- | | Each item of this array must be | Description | | ---------------------------------------- | --------------------------------------------------------------------------------- | @@ -221,8 +221,8 @@ alternative name (trading name, colloquial name) for an organization List of abbreviations or codes from code lists for an organization (e.g. DOI, DOD) -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Example:** @@ -291,18 +291,18 @@ Contact information for an individual or entity } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------------------------- | -------------- | ----------------- | ----------------------------------------------------------------------------------------- | -| [@id](#kind--@id) | string | Optional | | -| [@type](#kind--@type) | string | Optional | | -| [address](#kind--address) | null or array | Optional | The address of the contact | -| [hasEmail](#kind--hasEmail) | string | Mandatory | Email address for the contact in mailto: format (for example, mailto:support@example.gov) | -| [family-name](#kind--family-name) | null or string | Optional | The family name of the contact | -| [fn](#kind--fn) | string | Mandatory | The formatted text of the name of the contact | -| [given-name](#kind--given-name) | null or string | Optional | The given name of the contact | -| [organization-name](#kind--organization-name) | null or string | Optional | The name of the organization to contact | -| [tel](#kind--tel) | null or string | Optional | The telephone number for the contact | -| [title](#kind--title) | null or string | Optional | The position role of the person to contact | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------- | ------------------------------------------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------- | +| [@id](#kind--@id) | string | Optional | | +| [@type](#kind--@type) | string | Optional | | +| [address](#kind--address) | null or array of [Address](./temporal-spatial-metrics.md#address) classes | Optional | The address of the contact | +| [hasEmail](#kind--hasEmail) | string | Mandatory | Email address for the contact in mailto: format (for example, mailto:support@example.gov) | +| [family-name](#kind--family-name) | null or string | Optional | The family name of the contact | +| [fn](#kind--fn) | string | Mandatory | The formatted text of the name of the contact | +| [given-name](#kind--given-name) | null or string | Optional | The given name of the contact | +| [organization-name](#kind--organization-name) | null or string | Optional | The name of the organization to contact | +| [tel](#kind--tel) | null or string | Optional | The telephone number for the contact | +| [title](#kind--title) | null or string | Optional | The position role of the person to contact | ## `Kind > @id` @@ -332,8 +332,8 @@ Contact information for an individual or entity The address of the contact -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Address](./temporal-spatial-metrics.md#address) classes | +| -------- | ------------------------------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------------------------ | ------------------------- | diff --git a/jsonschema/docs/catalog.md b/jsonschema/docs/catalog.md index 6aa7e42d..f3ed3254 100644 --- a/jsonschema/docs/catalog.md +++ b/jsonschema/docs/catalog.md @@ -67,39 +67,39 @@ A curated collection of metadata about datasets, data services, or other resourc } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------------------------------- | ----------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| [@id](#@id) | string | Optional | | -| [@type](#@type) | string | Optional | | -| [catalog](#catalog) | null or array | Optional | List of related catalogs that are useful in the context of this catalog | -| [contactPoint](#contactPoint) | null or array | Optional | Contact information people can use to ask questions or send feedback about the catalog | -| [dataset](#dataset) | array | Mandatory | List of datasets included in the catalog. Use this together with service so the catalog is not empty. | -| [keyword](#keyword) | null or array of string | Optional | List of keywords or tags describing the catalog | -| [record](#record) | null or array | Optional | A catalog record describing how a single resource (such as a dataset or data service) is registered in the catalog | -| [service](#service) | null or array | Optional | List of data services included in the catalog. Use this together with dataset so the catalog is not empty. | -| [theme](#theme) | null or array | Optional | List of themes or categories for the catalog. A catalog can have more than one theme. | -| [themeTaxonomy](#themeTaxonomy) | null or array | Recommended | Controlled vocabulary or taxonomy used to classify catalog resources, such as datasets and services | -| [accessRights](#accessRights) | More than one type | Optional | Information about whether the catalog is publicly accessible, restricted, or not public | -| [conformsTo](#conformsTo) | More than one type | Recommended | Standard, schema, profile, or model that this catalog follows | -| [creator](#creator) | null or array | Optional | Person or organization responsible for creating the catalog metadata | -| [description](#description) | null or string | Optional | Plain-language summary of the catalog | -| [hasPart](#hasPart) | null or array | Optional | List of catalogs that are contained within this catalog | -| [identifier](#identifier) | More than one type | Optional | Main unique identifier for the catalog, such as a URI or another persistent identifier | -| [otherIdentifier](#otherIdentifier) | null or array | Optional | A list of identifiers for the Catalog besides the main identifier, e.g. the URI or other unique identifiers | -| [issued](#issued) | More than one type | Recommended | Date when the catalog was formally issued, such as its initial publication date | -| [language](#language) | More than one type | Recommended | Language codes used for catalog metadata text (such as titles and descriptions), using ISO 639-1 codes like en or es | -| [license](#license) | More than one type | Optional | License that governs how the catalog can be used or reused | -| [modified](#modified) | More than one type | Recommended | Most recent date when the catalog content changed, not just catalog-record metadata | -| [publisher](#publisher) | More than one type | Optional | Person or organization responsible for publishing and making the catalog available | -| [rights](#rights) | null or array of string | Recommended | Rights statements about the catalog that are not already covered by license or accessRights, such as copyright or policy restrictions | -| [rightsHolder](#rightsHolder) | null or array | Optional | Organizations that hold rights in the catalog | -| [spatial](#spatial) | null or array | Recommended | Geographic area covered by the catalog | -| [subject](#subject) | null or array | Optional | List of subjects of the catalog | -| [temporal](#temporal) | null or array | Optional | Time periods covered by the catalog | -| [title](#title) | null or string | Optional | Human-readable title of the catalog | -| [category](#category) | null or array | Optional | List of high-level categories for the catalog | -| [homepage](#homepage) | More than one type | Recommended | Main public web page for the catalog, usually an HTML page | -| [qualifiedAttribution](#qualifiedAttribution) | null or array | Optional | List of agents with specific responsibilities for the catalog | +| Property | Type | Requirement Level | Title/Description | +| ---------------------------------------------- | ------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#@id) | string | Optional | | +| [@type](#@type) | string | Optional | | +| [catalog](#catalog) | null or array of object | Optional | List of related catalogs that are useful in the context of this catalog | +| [contactPoint](#contactPoint) | null or array of [Kind](./agents.md#kind) classes | Optional | Contact information people can use to ask questions or send feedback about the catalog | +| [dataset](#dataset) | array of [Dataset](./dataset.md#root) classes | Mandatory | List of datasets included in the catalog. Use this together with service so the catalog is not empty. | +| [keyword](#keyword) | null or array of string | Optional | List of keywords or tags describing the catalog | +| [record](#record) | null or array of [CatalogRecord](./quality-governance.md#catalog-record) classes | Optional | A catalog record describing how a single resource (such as a dataset or data service) is registered in the catalog | +| [service](#service) | null or array of [DataService](./quality-governance.md#data-service) classes | Optional | List of data services included in the catalog. Use this together with dataset so the catalog is not empty. | +| [theme](#theme) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of themes or categories for the catalog. A catalog can have more than one theme. | +| [themeTaxonomy](#themeTaxonomy) | null or array of [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) classes | Recommended | Controlled vocabulary or taxonomy used to classify catalog resources, such as datasets and services | +| [accessRights](#accessRights) | More than one type | Optional | Information about whether the catalog is publicly accessible, restricted, or not public | +| [conformsTo](#conformsTo) | More than one type | Recommended | Standard, schema, profile, or model that this catalog follows | +| [creator](#creator) | null or array of [Agent](./agents.md#agent) classes | Optional | Person or organization responsible for creating the catalog metadata | +| [description](#description) | null or string | Optional | Plain-language summary of the catalog | +| [hasPart](#hasPart) | null or array of object | Optional | List of catalogs that are contained within this catalog | +| [identifier](#identifier) | More than one type | Optional | Main unique identifier for the catalog, such as a URI or another persistent identifier | +| [otherIdentifier](#otherIdentifier) | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | Optional | A list of identifiers for the Catalog besides the main identifier, e.g. the URI or other unique identifiers | +| [issued](#issued) | More than one type | Recommended | Date when the catalog was formally issued, such as its initial publication date | +| [language](#language) | More than one type | Recommended | Language codes used for catalog metadata text (such as titles and descriptions), using ISO 639-1 codes like en or es | +| [license](#license) | More than one type | Optional | License that governs how the catalog can be used or reused | +| [modified](#modified) | More than one type | Recommended | Most recent date when the catalog content changed, not just catalog-record metadata | +| [publisher](#publisher) | More than one type | Optional | Person or organization responsible for publishing and making the catalog available | +| [rights](#rights) | null or array of string | Recommended | Rights statements about the catalog that are not already covered by license or accessRights, such as copyright or policy restrictions | +| [rightsHolder](#rightsHolder) | null or array of [Organization](./agents.md#organization) classes | Optional | Organizations that hold rights in the catalog | +| [spatial](#spatial) | null or array of [Location](./temporal-spatial-metrics.md#location) classes | Recommended | Geographic area covered by the catalog | +| [subject](#subject) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of subjects of the catalog | +| [temporal](#temporal) | null or array of [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) classes | Optional | Time periods covered by the catalog | +| [title](#title) | null or string | Optional | Human-readable title of the catalog | +| [category](#category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of high-level categories for the catalog | +| [homepage](#homepage) | More than one type | Recommended | Main public web page for the catalog, usually an HTML page | +| [qualifiedAttribution](#qualifiedAttribution) | null or array of [Attribution](./quality-governance.md#attribution) classes | Optional | List of agents with specific responsibilities for the catalog | ## `DCAT-US 3 Catalog > @id` @@ -131,8 +131,8 @@ A curated collection of metadata about datasets, data services, or other resourc List of related catalogs that are useful in the context of this catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of object | +| -------- | ----------------------- | | Each item of this array must be | Description | | ----------------------------------- | ---------------------------------------------------------------------------------- | @@ -146,8 +146,8 @@ List of related catalogs that are useful in the context of this catalog Contact information people can use to ask questions or send feedback about the catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Kind](./agents.md#kind) classes | +| -------- | ------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | ----------------------------------------------- | @@ -159,9 +159,9 @@ Contact information people can use to ask questions or send feedback about the c List of datasets included in the catalog. Use this together with service so the catalog is not empty. -| **Type** | `array` | -| ------------ | ------- | -| **Required** | Yes | +| **Type** | array of [Dataset](./dataset.md#root) classes | +| ------------ | --------------------------------------------- | +| **Required** | Yes | | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | @@ -175,8 +175,8 @@ List of datasets included in the catalog. Use this together with service so the List of keywords or tags describing the catalog -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Example:** @@ -210,8 +210,8 @@ List of keywords or tags describing the catalog A catalog record describing how a single resource (such as a dataset or data service) is registered in the catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [CatalogRecord](./quality-governance.md#catalog-record) classes | +| -------- | -------------------------------------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------------------------------- | ----------------------------------------------------------------------- | @@ -223,8 +223,8 @@ A catalog record describing how a single resource (such as a dataset or data ser List of data services included in the catalog. Use this together with dataset so the catalog is not empty. -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [DataService](./quality-governance.md#data-service) classes | +| -------- | ---------------------------------------------------------------------------- | | Each item of this array must be | Description | | --------------------------------------------------- | ------------------------------------------------------------------- | @@ -238,8 +238,8 @@ List of data services included in the catalog. Use this together with dataset so List of themes or categories for the catalog. A catalog can have more than one theme. -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -253,8 +253,8 @@ List of themes or categories for the catalog. A catalog can have more than one t Controlled vocabulary or taxonomy used to classify catalog resources, such as datasets and services -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) classes | +| -------- | ------------------------------------------------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------------------------------------------ | --------------------------------------------------------------------- | @@ -266,9 +266,9 @@ Controlled vocabulary or taxonomy used to classify catalog resources, such as da Information about whether the catalog is publicly accessible, restricted, or not public -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -301,9 +301,9 @@ Text description of the access rights Standard, schema, profile, or model that this catalog follows -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------ | @@ -330,8 +330,8 @@ A standard or specification that another resource conforms to Person or organization responsible for creating the catalog metadata -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Agent](./agents.md#agent) classes | +| -------- | --------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | -------------------------------------------------------------------------------- | @@ -362,8 +362,8 @@ Plain-language summary of the catalog List of catalogs that are contained within this catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of object | +| -------- | ----------------------- | | Each item of this array must be | Description | | ----------------------------------- | ---------------------------------------------------------------------------------- | @@ -375,9 +375,9 @@ List of catalogs that are contained within this catalog Main unique identifier for the catalog, such as a URI or another persistent identifier -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------ | @@ -393,7 +393,7 @@ Main unique identifier for the catalog, such as a URI or another persistent iden inline description of Identifier -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | @@ -404,8 +404,8 @@ inline description of Identifier A list of identifiers for the Catalog besides the main identifier, e.g. the URI or other unique identifiers -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | +| -------- | ------------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | @@ -419,9 +419,9 @@ A list of identifiers for the Catalog besides the main identifier, e.g. the URI Date when the catalog was formally issued, such as its initial publication date -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -453,9 +453,9 @@ Date when the catalog was formally issued, such as its initial publication date ### `DCAT-US 3 Catalog > issued > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------- | @@ -504,9 +504,9 @@ A year and month in YYYY-MM format Language codes used for catalog metadata text (such as titles and descriptions), using ISO 639-1 codes like en or es -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -545,8 +545,8 @@ Language codes used for catalog metadata text (such as titles and descriptions), ### `DCAT-US 3 Catalog > language > anyOf > List of language codes` -| **Type** | `array of string` | -| -------- | ----------------- | +| **Type** | array of string | +| -------- | --------------- | | Each item of this array must be | Description | | ----------------------------------------- | ----------- | @@ -567,9 +567,9 @@ Language codes used for catalog metadata text (such as titles and descriptions), License that governs how the catalog can be used or reused -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -602,9 +602,9 @@ Full text of the license Most recent date when the catalog content changed, not just catalog-record metadata -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -636,9 +636,9 @@ Most recent date when the catalog content changed, not just catalog-record metad ### `DCAT-US 3 Catalog > modified > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------- | @@ -687,9 +687,9 @@ A year and month in YYYY-MM format Person or organization responsible for publishing and making the catalog available -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------------------------- | @@ -716,8 +716,8 @@ inline description of the publisher Rights statements about the catalog that are not already covered by license or accessRights, such as copyright or policy restrictions -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Examples:** @@ -751,8 +751,8 @@ Full text of a statement of rights Organizations that hold rights in the catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Organization](./agents.md#organization) classes | +| -------- | ----------------------------------------------------------------- | | Each item of this array must be | Description | | ---------------------------------------- | --------------------------------------------------------------------------------- | @@ -766,8 +766,8 @@ Organizations that hold rights in the catalog Geographic area covered by the catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Location](./temporal-spatial-metrics.md#location) classes | +| -------- | --------------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------------- | -------------------------------- | @@ -779,8 +779,8 @@ Geographic area covered by the catalog List of subjects of the catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -794,8 +794,8 @@ List of subjects of the catalog Time periods covered by the catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) classes | +| -------- | ------------------------------------------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------------------------------------ | ---------------------------------------------------------------------- | @@ -826,8 +826,8 @@ Human-readable title of the catalog List of high-level categories for the catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -839,9 +839,9 @@ List of high-level categories for the catalog Main public web page for the catalog, usually an HTML page -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ---------------------------------------------------- | @@ -868,8 +868,8 @@ inline description of the home page List of agents with specific responsibilities for the catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Attribution](./quality-governance.md#attribution) classes | +| -------- | --------------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------------- | ------------------------------------------------- | diff --git a/jsonschema/docs/constraints-and-restrictions.md b/jsonschema/docs/constraints-and-restrictions.md index f1832871..65871a09 100644 --- a/jsonschema/docs/constraints-and-restrictions.md +++ b/jsonschema/docs/constraints-and-restrictions.md @@ -68,7 +68,7 @@ A note related to the access restriction The indication of whether or not there are access restrictions on the item, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/access-restriction-status -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------- | | **Required** | Yes | | **Additional properties** | Any type allowed | @@ -90,9 +90,9 @@ The indication of whether or not there are access restrictions on the item, cons Authority, code list entry, or policy reference that defines the specific access restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-access-restriction -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -118,7 +118,7 @@ Authority, code list entry, or policy reference that defines the specific access inline description of the specific restriction -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | @@ -223,8 +223,8 @@ Agency that designated the information as CUI; include at least "Controlled by:" List of free-text required indicators from the applicable authority (for example, category descriptions or distribution statements) -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Example:** @@ -322,7 +322,7 @@ Significant information pertaining to the use or reproduction of the data Indication of whether or not there are use restrictions on the archival materials, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/use-restriction-status -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------- | | **Required** | Yes | | **Additional properties** | Any type allowed | @@ -344,9 +344,9 @@ Indication of whether or not there are use restrictions on the archival material Authority, code list entry, or policy reference that defines the specific use restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-use-restriction -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -372,7 +372,7 @@ Authority, code list entry, or policy reference that defines the specific use re inline description of the specific restriction -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | diff --git a/jsonschema/docs/dataset-series.md b/jsonschema/docs/dataset-series.md index eb9f1de4..ae90bfa7 100644 --- a/jsonschema/docs/dataset-series.md +++ b/jsonschema/docs/dataset-series.md @@ -141,22 +141,22 @@ A group of related datasets that are published separately } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------------------------ | ------------------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| [@id](#@id) | string | Optional | | -| [@type](#@type) | string | Optional | | -| [contactPoint](#contactPoint) | null or array | Recommended | List of contacts people can use to ask questions or send feedback about the dataset series | -| [first](#first) | More than one type | Recommended | The first dataset in an ordered dataset series | -| [last](#last) | More than one type | Recommended | The last dataset in an ordered dataset series | -| [seriesMember](#seriesMember) | null or array | Recommended | List of members of the Dataset Series | -| [accrualPeriodicity](#accrualPeriodicity) | More than one type | Optional | The frequency at which the Dataset Series is updated. This is the series update frequency, not necessarily each dataset's frequency | -| [description](#description) | string | Mandatory | Plain-language summary of the dataset series | -| [issued](#issued) | More than one type | Optional | Date when the Dataset Series was formally established or published, not the release date of the oldest dataset in the series | -| [modified](#modified) | More than one type | Recommended | Most recent date when the Dataset Series changed, not the modified date of the newest dataset in the series | -| [publisher](#publisher) | More than one type | Recommended | Organization responsible for maintaining the Dataset Series as a coherent series; this may differ from publishers of individual datasets | -| [spatial](#spatial) | null or array | Recommended | A geographic region that is covered by the Dataset Series | -| [temporal](#temporal) | null or array | Recommended | Time periods covered by the dataset series | -| [title](#title) | string | Mandatory | Human-readable title of the dataset series | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------------ | ------------------------------------------------------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#@id) | string | Optional | | +| [@type](#@type) | string | Optional | | +| [contactPoint](#contactPoint) | null or array of [Kind](./agents.md#kind) classes | Recommended | List of contacts people can use to ask questions or send feedback about the dataset series | +| [first](#first) | More than one type | Recommended | The first dataset in an ordered dataset series | +| [last](#last) | More than one type | Recommended | The last dataset in an ordered dataset series | +| [seriesMember](#seriesMember) | null or array of [Dataset](./dataset.md#root) classes | Recommended | List of members of the Dataset Series | +| [accrualPeriodicity](#accrualPeriodicity) | More than one type | Optional | The frequency at which the Dataset Series is updated. This is the series update frequency, not necessarily each dataset's frequency | +| [description](#description) | string | Mandatory | Plain-language summary of the dataset series | +| [issued](#issued) | More than one type | Optional | Date when the Dataset Series was formally established or published, not the release date of the oldest dataset in the series | +| [modified](#modified) | More than one type | Recommended | Most recent date when the Dataset Series changed, not the modified date of the newest dataset in the series | +| [publisher](#publisher) | More than one type | Recommended | Organization responsible for maintaining the Dataset Series as a coherent series; this may differ from publishers of individual datasets | +| [spatial](#spatial) | null or array of [Location](./temporal-spatial-metrics.md#location) classes | Recommended | A geographic region that is covered by the Dataset Series | +| [temporal](#temporal) | null or array of [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) classes | Recommended | Time periods covered by the dataset series | +| [title](#title) | string | Mandatory | Human-readable title of the dataset series | ## `DatasetSeries > @id` @@ -186,8 +186,8 @@ A group of related datasets that are published separately List of contacts people can use to ask questions or send feedback about the dataset series -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Kind](./agents.md#kind) classes | +| -------- | ------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | ----------------------------------------------- | @@ -199,9 +199,9 @@ List of contacts people can use to ask questions or send feedback about the data The first dataset in an ordered dataset series -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------- | @@ -231,9 +231,9 @@ inline description of the first dataset The last dataset in an ordered dataset series -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------ | @@ -263,8 +263,8 @@ inline description of the last dataset List of members of the Dataset Series -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Dataset](./dataset.md#root) classes | +| -------- | ----------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | @@ -278,9 +278,9 @@ List of members of the Dataset Series The frequency at which the Dataset Series is updated. This is the series update frequency, not necessarily each dataset's frequency -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -382,9 +382,9 @@ Plain-language summary of the dataset series Date when the Dataset Series was formally established or published, not the release date of the oldest dataset in the series -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -416,9 +416,9 @@ Date when the Dataset Series was formally established or published, not the rele ### `DatasetSeries > issued > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------- | @@ -469,9 +469,9 @@ A year and month in YYYY-MM format Most recent date when the Dataset Series changed, not the modified date of the newest dataset in the series -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -507,9 +507,9 @@ Most recent date when the Dataset Series changed, not the modified date of the n ### `DatasetSeries > modified > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------- | @@ -558,9 +558,9 @@ A year and month in YYYY-MM format Organization responsible for maintaining the Dataset Series as a coherent series; this may differ from publishers of individual datasets -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------------------------- | @@ -589,8 +589,8 @@ inline description of publisher A geographic region that is covered by the Dataset Series -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Location](./temporal-spatial-metrics.md#location) classes | +| -------- | --------------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------------- | -------------------------------- | @@ -604,8 +604,8 @@ A geographic region that is covered by the Dataset Series Time periods covered by the dataset series -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) classes | +| -------- | ------------------------------------------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------------------------------------ | ---------------------------------------------------------------------- | diff --git a/jsonschema/docs/dataset.md b/jsonschema/docs/dataset.md index d6a5a455..d4a6e8fe 100644 --- a/jsonschema/docs/dataset.md +++ b/jsonschema/docs/dataset.md @@ -97,66 +97,66 @@ A collection of data published or curated by one provider } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------------------------------------------- | ----------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [@id](#@id) | string | Optional | | -| [@type](#@type) | string | Optional | | -| [otherIdentifier](#otherIdentifier) | null or array | Optional | Additional identifiers for the dataset besides the main identifier, such as a DOI or other persistent ID | -| [sample](#sample) | null or array | Optional | List of sample distributions for the dataset | -| [status](#status) | More than one type | Optional | Lifecycle status of the dataset, such as completed, deprecated, under development, or withdrawn | -| [supportedSchema](#supportedSchema) | More than one type | Optional | supported schema for this dataset | -| [versionNotes](#versionNotes) | null or string | Optional | Notes describing how this version differs from earlier versions of the dataset | -| [contactPoint](#contactPoint) | More than one type | Mandatory | A contact point for questions about the Dataset (single contact or list). Include an email address that is continuously monitored | -| [distribution](#distribution) | null or array | Recommended | List of available distributions for the dataset. This can be omitted when no distribution is available yet. | -| [first](#first) | More than one type | Optional | the first item of the sequence the dataset belongs to | -| [hasCurrentVersion](#hasCurrentVersion) | More than one type | Optional | reference to the current (latest) version of a dataset | -| [hasVersion](#hasVersion) | null or array | Optional | List of related Datasets that are a version, edition, or adaptation of the described Dataset | -| [inSeries](#inSeries) | null or array | Optional | Dataset series this dataset belongs to | -| [keyword](#keyword) | null or array of string | Recommended | List of keywords or tags describing the dataset | -| [landingPage](#landingPage) | More than one type | Recommended | A web page from the original data provider that gives access to the Dataset, its Distributions, and related information | -| [previousVersion](#previousVersion) | More than one type | Optional | reference to the previous dataset version | -| [qualifiedRelation](#qualifiedRelation) | null or array | Optional | Detailed relationship between the dataset and another resource, including the role of that relationship | -| [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Optional | Smallest spatial distance between data points, in meters, represented as a single value | -| [temporalResolution](#temporalResolution) | null or string | Optional | Smallest time interval between data points, using xsd:duration format (for example, P1D) | -| [theme](#theme) | null or array | Recommended | List of themes or categories for the dataset | -| [version](#version) | null or string | Optional | The version indicator (name or identifier) of a resource | -| [describedBy](#describedBy) | More than one type | Recommended | A distribution describing the Data Dictionary for this dataset | -| [liabilityStatement](#liabilityStatement) | More than one type | Optional | A liability statement about the dataset that may clarify limitations of responsibility, qualifications on the accuracy, reliability, and completeness of the data, or absence of endorsement by the data publisher or provider, among other considerations | -| [metadataDistribution](#metadataDistribution) | null or array | Optional | Distribution of the original metadata document this dataset was derived from | -| [purpose](#purpose) | null or string | Optional | The purpose of the dataset | -| [accessRights](#accessRights) | More than one type | Optional | Information about whether the dataset is publicly accessible, restricted, or not public | -| [accrualPeriodicity](#accrualPeriodicity) | More than one type | Optional | The frequency at which the Dataset is updated | -| [conformsTo](#conformsTo) | null or array | Optional | List of standards, schemas, or profiles the dataset follows | -| [contributor](#contributor) | null or array | Optional | List of agents contributing to the Dataset | -| [created](#created) | More than one type | Optional | The date on which the Dataset was first created | -| [creator](#creator) | More than one type | Optional | Person or organization responsible for creating the dataset | -| [description](#description) | string | Mandatory | Plain-language summary of the dataset | -| [hasPart](#hasPart) | null or array | Optional | List of related datasets that are part of the described dataset | -| [identifier](#identifier) | More than one type | Mandatory | The unique identifier for the Dataset, e.g. the URI or other unique identifier in the context of the Catalog | -| [isReferencedBy](#isReferencedBy) | null or array of string | Optional | List of links to related resources, such as publications, that reference, cite, or otherwise point to the Dataset | -| [issued](#issued) | More than one type | Optional | Date when the dataset was first published. If the exact publication date is unknown, use the date it was first referenced in the catalog. | -| [language](#language) | More than one type | Optional | ISO 639-1 language code values used in the dataset text or metadata, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html | -| [modified](#modified) | More than one type | Recommended | Most recent date when the dataset's actual data changed, not just metadata | -| [provenance](#provenance) | null or array of string | Optional | List of statements about the lineage of a Dataset, including any changes in its ownership or custody since its creation that may be significant for its authenticity, integrity, or interpretation | -| [publisher](#publisher) | object | Mandatory | Organization responsible for publishing and making the dataset available | -| [relation](#relation) | null or array of string | Optional | List of links to related resources when the relationship is not otherwise specified | -| [replaces](#replaces) | null or array | Optional | List of Datasets replaced by this Dataset | -| [rights](#rights) | null or array of string | Recommended | Rights statements not already covered by license or accessRights, such as copyright or policy restrictions | -| [rightsHolder](#rightsHolder) | null or array | Optional | List of agents (organizations) holding rights on the Dataset | -| [source](#source) | null or array | Optional | List of related Datasets from which the described Dataset is derived | -| [spatial](#spatial) | More than one type | Recommended | A geographic region or regions that are covered by the Dataset | -| [subject](#subject) | null or array | Optional | List of primary subjects for the dataset, usually narrower than broad theme categories | -| [temporal](#temporal) | null or array | Recommended | Time periods covered by the dataset | -| [title](#title) | string | Mandatory | Human-readable title of the dataset | -| [category](#category) | null or array | Optional | List of high-level categories for the dataset | -| [hasQualityMeasurement](#hasQualityMeasurement) | null or array | Optional | List of quality measurements for the dataset (for example, completeness, accuracy, or timeliness) beyond spatial or temporal resolution | -| [page](#page) | null or array | Optional | List of pages or documents about this dataset | -| [qualifiedAttribution](#qualifiedAttribution) | null or array | Optional | List of agents with specific responsibilities for the dataset | -| [wasAttributedTo](#wasAttributedTo) | null or array | Optional | List of agents attributed to this dataset | -| [wasGeneratedBy](#wasGeneratedBy) | null or array | Optional | List of activities that generated, or provide the business context for the creation of the dataset | -| [wasUsedBy](#wasUsedBy) | null or array | Optional | List of activities that used the Dataset | -| [image](#image) | More than one type | Optional | Thumbnail image illustrating the dataset, especially useful for visual data such as maps, photos, or video | -| [scopeNote](#scopeNote) | null or string | Optional | usage note for the dataset | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#@id) | string | Optional | | +| [@type](#@type) | string | Optional | | +| [otherIdentifier](#otherIdentifier) | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | Optional | Additional identifiers for the dataset besides the main identifier, such as a DOI or other persistent ID | +| [sample](#sample) | null or array of [Distribution](./distribution.md#root) classes | Optional | List of sample distributions for the dataset | +| [status](#status) | More than one type | Optional | Lifecycle status of the dataset, such as completed, deprecated, under development, or withdrawn | +| [supportedSchema](#supportedSchema) | More than one type | Optional | supported schema for this dataset | +| [versionNotes](#versionNotes) | null or string | Optional | Notes describing how this version differs from earlier versions of the dataset | +| [contactPoint](#contactPoint) | More than one type | Mandatory | A contact point for questions about the Dataset (single contact or list). Include an email address that is continuously monitored | +| [distribution](#distribution) | null or array of [Distribution](./distribution.md#root) classes | Recommended | List of available distributions for the dataset. This can be omitted when no distribution is available yet. | +| [first](#first) | More than one type | Optional | the first item of the sequence the dataset belongs to | +| [hasCurrentVersion](#hasCurrentVersion) | More than one type | Optional | reference to the current (latest) version of a dataset | +| [hasVersion](#hasVersion) | null or array of [Dataset](./dataset.md#root) classes | Optional | List of related Datasets that are a version, edition, or adaptation of the described Dataset | +| [inSeries](#inSeries) | null or array of [DatasetSeries](./dataset-series.md#root) classes | Optional | Dataset series this dataset belongs to | +| [keyword](#keyword) | null or array of string | Recommended | List of keywords or tags describing the dataset | +| [landingPage](#landingPage) | More than one type | Recommended | A web page from the original data provider that gives access to the Dataset, its Distributions, and related information | +| [previousVersion](#previousVersion) | More than one type | Optional | reference to the previous dataset version | +| [qualifiedRelation](#qualifiedRelation) | null or array of [Relationship](./identifiers-and-relationships.md#relationship) classes | Optional | Detailed relationship between the dataset and another resource, including the role of that relationship | +| [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Optional | Smallest spatial distance between data points, in meters, represented as a single value | +| [temporalResolution](#temporalResolution) | null or string | Optional | Smallest time interval between data points, using xsd:duration format (for example, P1D) | +| [theme](#theme) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Recommended | List of themes or categories for the dataset | +| [version](#version) | null or string | Optional | The version indicator (name or identifier) of a resource | +| [describedBy](#describedBy) | More than one type | Recommended | A distribution describing the Data Dictionary for this dataset | +| [liabilityStatement](#liabilityStatement) | More than one type | Optional | A liability statement about the dataset that may clarify limitations of responsibility, qualifications on the accuracy, reliability, and completeness of the data, or absence of endorsement by the data publisher or provider, among other considerations | +| [metadataDistribution](#metadataDistribution) | null or array of [Distribution](./distribution.md#root) classes | Optional | Distribution of the original metadata document this dataset was derived from | +| [purpose](#purpose) | null or string | Optional | The purpose of the dataset | +| [accessRights](#accessRights) | More than one type | Optional | Information about whether the dataset is publicly accessible, restricted, or not public | +| [accrualPeriodicity](#accrualPeriodicity) | More than one type | Optional | The frequency at which the Dataset is updated | +| [conformsTo](#conformsTo) | null or array of [Standard](./quality-governance.md#standard) classes | Optional | List of standards, schemas, or profiles the dataset follows | +| [contributor](#contributor) | null or array of [Agent](./agents.md#agent) classes | Optional | List of agents contributing to the Dataset | +| [created](#created) | More than one type | Optional | The date on which the Dataset was first created | +| [creator](#creator) | More than one type | Optional | Person or organization responsible for creating the dataset | +| [description](#description) | string | Mandatory | Plain-language summary of the dataset | +| [hasPart](#hasPart) | null or array of [Dataset](./dataset.md#root) classes | Optional | List of related datasets that are part of the described dataset | +| [identifier](#identifier) | More than one type | Mandatory | The unique identifier for the Dataset, e.g. the URI or other unique identifier in the context of the Catalog | +| [isReferencedBy](#isReferencedBy) | null or array of string | Optional | List of links to related resources, such as publications, that reference, cite, or otherwise point to the Dataset | +| [issued](#issued) | More than one type | Optional | Date when the dataset was first published. If the exact publication date is unknown, use the date it was first referenced in the catalog. | +| [language](#language) | More than one type | Optional | ISO 639-1 language code values used in the dataset text or metadata, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html | +| [modified](#modified) | More than one type | Recommended | Most recent date when the dataset's actual data changed, not just metadata | +| [provenance](#provenance) | null or array of string | Optional | List of statements about the lineage of a Dataset, including any changes in its ownership or custody since its creation that may be significant for its authenticity, integrity, or interpretation | +| [publisher](#publisher) | object | Mandatory | Organization responsible for publishing and making the dataset available | +| [relation](#relation) | null or array of string | Optional | List of links to related resources when the relationship is not otherwise specified | +| [replaces](#replaces) | null or array of [Dataset](./dataset.md#root) classes | Optional | List of Datasets replaced by this Dataset | +| [rights](#rights) | null or array of string | Recommended | Rights statements not already covered by license or accessRights, such as copyright or policy restrictions | +| [rightsHolder](#rightsHolder) | null or array of [Organization](./agents.md#organization) classes | Optional | List of agents (organizations) holding rights on the Dataset | +| [source](#source) | null or array of [Dataset](./dataset.md#root) classes | Optional | List of related Datasets from which the described Dataset is derived | +| [spatial](#spatial) | More than one type | Recommended | A geographic region or regions that are covered by the Dataset | +| [subject](#subject) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of primary subjects for the dataset, usually narrower than broad theme categories | +| [temporal](#temporal) | null or array of [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) classes | Recommended | Time periods covered by the dataset | +| [title](#title) | string | Mandatory | Human-readable title of the dataset | +| [category](#category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of high-level categories for the dataset | +| [hasQualityMeasurement](#hasQualityMeasurement) | null or array of [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) classes | Optional | List of quality measurements for the dataset (for example, completeness, accuracy, or timeliness) beyond spatial or temporal resolution | +| [page](#page) | null or array of [Document](./quality-governance.md#document) classes | Optional | List of pages or documents about this dataset | +| [qualifiedAttribution](#qualifiedAttribution) | null or array of [Attribution](./quality-governance.md#attribution) classes | Optional | List of agents with specific responsibilities for the dataset | +| [wasAttributedTo](#wasAttributedTo) | null or array of [Agent](./agents.md#agent) classes | Optional | List of agents attributed to this dataset | +| [wasGeneratedBy](#wasGeneratedBy) | null or array of [Activity](./temporal-spatial-metrics.md#activity) classes | Optional | List of activities that generated, or provide the business context for the creation of the dataset | +| [wasUsedBy](#wasUsedBy) | null or array of [Activity](./temporal-spatial-metrics.md#activity) classes | Optional | List of activities that used the Dataset | +| [image](#image) | More than one type | Optional | Thumbnail image illustrating the dataset, especially useful for visual data such as maps, photos, or video | +| [scopeNote](#scopeNote) | null or string | Optional | usage note for the dataset | ## `Dataset > @id` @@ -186,8 +186,8 @@ A collection of data published or curated by one provider Additional identifiers for the dataset besides the main identifier, such as a DOI or other persistent ID -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | +| -------- | ------------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | @@ -199,8 +199,8 @@ Additional identifiers for the dataset besides the main identifier, such as a DO List of sample distributions for the dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Distribution](./distribution.md#root) classes | +| -------- | --------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------- | ----------------------------------------------------------------------------- | @@ -214,9 +214,9 @@ List of sample distributions for the dataset Lifecycle status of the dataset, such as completed, deprecated, under development, or withdrawn -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | -------------------------------------------------- | @@ -232,7 +232,7 @@ Lifecycle status of the dataset, such as completed, deprecated, under developmen inline description of Concept -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | @@ -243,9 +243,9 @@ inline description of Concept supported schema for this dataset -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------------------------------- | @@ -290,10 +290,10 @@ Notes describing how this version differs from earlier versions of the dataset A contact point for questions about the Dataset (single contact or list). Include an email address that is continuously monitored -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Required** | Yes | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------ | @@ -311,8 +311,8 @@ inline description of Kind ### `Dataset > contactPoint > anyOf > List of contacts` -| **Type** | `array` | -| -------- | ------- | +| **Type** | array of [Kind](./agents.md#kind) classes | +| -------- | ----------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | ----------------------------------------------- | @@ -326,8 +326,8 @@ inline description of Kind List of available distributions for the dataset. This can be omitted when no distribution is available yet. -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Distribution](./distribution.md#root) classes | +| -------- | --------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------- | ----------------------------------------------------------------------------- | @@ -339,9 +339,9 @@ List of available distributions for the dataset. This can be omitted when no dis the first item of the sequence the dataset belongs to -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------- | @@ -373,9 +373,9 @@ inline description of Dataset reference to the current (latest) version of a dataset -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------------- | @@ -405,8 +405,8 @@ inline description of Dataset List of related Datasets that are a version, edition, or adaptation of the described Dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Dataset](./dataset.md#root) classes | +| -------- | ----------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | @@ -418,8 +418,8 @@ List of related Datasets that are a version, edition, or adaptation of the descr Dataset series this dataset belongs to -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [DatasetSeries](./dataset-series.md#root) classes | +| -------- | ------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------- | --------------------------------------------------------- | @@ -433,8 +433,8 @@ Dataset series this dataset belongs to List of keywords or tags describing the dataset -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Examples:** @@ -478,9 +478,9 @@ List of keywords or tags describing the dataset A web page from the original data provider that gives access to the Dataset, its Distributions, and related information -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------- | @@ -507,9 +507,9 @@ inline description of Document reference to the previous dataset version -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------------------------------- | @@ -539,8 +539,8 @@ inline description of Dataset Detailed relationship between the dataset and another resource, including the role of that relationship -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Relationship](./identifiers-and-relationships.md#relationship) classes | +| -------- | ---------------------------------------------------------------------------------------- | | Each item of this array must be | Description | | --------------------------------------------------------------- | ------------------------------------------------------------------- | @@ -586,8 +586,8 @@ Smallest time interval between data points, using xsd:duration format (for examp List of themes or categories for the dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -616,9 +616,9 @@ The version indicator (name or identifier) of a resource A distribution describing the Data Dictionary for this dataset -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------- | @@ -648,9 +648,9 @@ inline description of Distribution A liability statement about the dataset that may clarify limitations of responsibility, qualifications on the accuracy, reliability, and completeness of the data, or absence of endorsement by the data publisher or provider, among other considerations -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -681,8 +681,8 @@ Full text of the liability statement Distribution of the original metadata document this dataset was derived from -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Distribution](./distribution.md#root) classes | +| -------- | --------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------- | ----------------------------------------------------------------------------- | @@ -709,9 +709,9 @@ The purpose of the dataset Information about whether the dataset is publicly accessible, restricted, or not public -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -748,9 +748,9 @@ Text description of the access rights The frequency at which the Dataset is updated -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -834,8 +834,8 @@ Must be one of: List of standards, schemas, or profiles the dataset follows -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Standard](./quality-governance.md#standard) classes | +| -------- | --------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------- | ------------------------------------------------------------- | @@ -847,8 +847,8 @@ List of standards, schemas, or profiles the dataset follows List of agents contributing to the Dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Agent](./agents.md#agent) classes | +| -------- | --------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | -------------------------------------------------------------------------------- | @@ -862,9 +862,9 @@ List of agents contributing to the Dataset The date on which the Dataset was first created -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -896,9 +896,9 @@ The date on which the Dataset was first created ### `Dataset > created > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------ | @@ -947,9 +947,9 @@ A year and month in YYYY-MM format Person or organization responsible for creating the dataset -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | --------------------------------------------------- | @@ -996,8 +996,8 @@ Plain-language summary of the dataset List of related datasets that are part of the described dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Dataset](./dataset.md#root) classes | +| -------- | ----------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | @@ -1009,10 +1009,10 @@ List of related datasets that are part of the described dataset The unique identifier for the Dataset, e.g. the URI or other unique identifier in the context of the Catalog -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Required** | Yes | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------ | @@ -1028,7 +1028,7 @@ The unique identifier for the Dataset, e.g. the URI or other unique identifier i inline description of Identifier -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | @@ -1039,8 +1039,8 @@ inline description of Identifier List of links to related resources, such as publications, that reference, cite, or otherwise point to the Dataset -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Example:** @@ -1070,9 +1070,9 @@ reference iri of Resource Date when the dataset was first published. If the exact publication date is unknown, use the date it was first referenced in the catalog. -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -1104,9 +1104,9 @@ Date when the dataset was first published. If the exact publication date is unkn ### `Dataset > issued > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------- | @@ -1155,9 +1155,9 @@ A year and month in YYYY-MM format ISO 639-1 language code values used in the dataset text or metadata, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -1189,8 +1189,8 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en ### `Dataset > language > anyOf > List of languages` -| **Type** | `array of string` | -| -------- | ----------------- | +| **Type** | array of string | +| -------- | --------------- | | Each item of this array must be | Description | | ----------------------------------------- | ----------- | @@ -1213,9 +1213,9 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en Most recent date when the dataset's actual data changed, not just metadata -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -1247,9 +1247,9 @@ Most recent date when the dataset's actual data changed, not just metadata ### `Dataset > modified > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------- | @@ -1298,8 +1298,8 @@ A year and month in YYYY-MM format List of statements about the lineage of a Dataset, including any changes in its ownership or custody since its creation that may be significant for its authenticity, integrity, or interpretation -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Example:** @@ -1341,8 +1341,8 @@ Organization responsible for publishing and making the dataset available List of links to related resources when the relationship is not otherwise specified -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Example:** @@ -1370,8 +1370,8 @@ reference iri of Resource List of Datasets replaced by this Dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Dataset](./dataset.md#root) classes | +| -------- | ----------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | @@ -1383,8 +1383,8 @@ List of Datasets replaced by this Dataset Rights statements not already covered by license or accessRights, such as copyright or policy restrictions -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Examples:** @@ -1417,8 +1417,8 @@ Full text of a statement of rights List of agents (organizations) holding rights on the Dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Organization](./agents.md#organization) classes | +| -------- | ----------------------------------------------------------------- | | Each item of this array must be | Description | | ---------------------------------------- | --------------------------------------------------------------------------------- | @@ -1432,8 +1432,8 @@ List of agents (organizations) holding rights on the Dataset List of related Datasets from which the described Dataset is derived -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Dataset](./dataset.md#root) classes | +| -------- | ----------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | @@ -1447,9 +1447,9 @@ List of related Datasets from which the described Dataset is derived A geographic region or regions that are covered by the Dataset -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | --------------------------------------------------- | @@ -1473,8 +1473,8 @@ inline description of Location ### `Dataset > spatial > anyOf > List of geographic regions` -| **Type** | `array` | -| -------- | ------- | +| **Type** | array of [Location](./temporal-spatial-metrics.md#location) classes | +| -------- | ------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------------- | -------------------------------- | @@ -1486,8 +1486,8 @@ inline description of Location List of primary subjects for the dataset, usually narrower than broad theme categories -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -1501,8 +1501,8 @@ List of primary subjects for the dataset, usually narrower than broad theme cate Time periods covered by the dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) classes | +| -------- | ------------------------------------------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------------------------------------ | ---------------------------------------------------------------------- | @@ -1534,8 +1534,8 @@ Human-readable title of the dataset List of high-level categories for the dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -1549,8 +1549,8 @@ List of high-level categories for the dataset List of quality measurements for the dataset (for example, completeness, accuracy, or timeliness) beyond spatial or temporal resolution -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) classes | +| -------- | ------------------------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------------------------- | ------------------------------------------------------------- | @@ -1564,8 +1564,8 @@ List of quality measurements for the dataset (for example, completeness, accurac List of pages or documents about this dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Document](./quality-governance.md#document) classes | +| -------- | --------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------- | ----------------------------------------------------- | @@ -1577,8 +1577,8 @@ List of pages or documents about this dataset List of agents with specific responsibilities for the dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Attribution](./quality-governance.md#attribution) classes | +| -------- | --------------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------------- | ------------------------------------------------- | @@ -1592,8 +1592,8 @@ List of agents with specific responsibilities for the dataset List of agents attributed to this dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Agent](./agents.md#agent) classes | +| -------- | --------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | -------------------------------------------------------------------------------- | @@ -1605,8 +1605,8 @@ List of agents attributed to this dataset List of activities that generated, or provide the business context for the creation of the dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Activity](./temporal-spatial-metrics.md#activity) classes | +| -------- | --------------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------------- | -------------------------------------------------------------- | @@ -1620,8 +1620,8 @@ List of activities that generated, or provide the business context for the creat List of activities that used the Dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Activity](./temporal-spatial-metrics.md#activity) classes | +| -------- | --------------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------------- | -------------------------------------------------------------- | @@ -1633,9 +1633,9 @@ List of activities that used the Dataset Thumbnail image illustrating the dataset, especially useful for visual data such as maps, photos, or video -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------- | diff --git a/jsonschema/docs/distribution.md b/jsonschema/docs/distribution.md index bb042df6..500da883 100644 --- a/jsonschema/docs/distribution.md +++ b/jsonschema/docs/distribution.md @@ -36,43 +36,43 @@ A specific representation of a dataset, such as a file, feed, or API response } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------------------------------------------- | ----------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [@id](#@id) | string | Optional | | -| [@type](#@type) | string | Optional | | -| [representationTechnique](#representationTechnique) | More than one type | Optional | Method or schema used to structure the distribution content (for example, CSV convention, XML schema, or spatial representation type) | -| [status](#status) | More than one type | Optional | The status of the distribution in the context of maturity lifecycle | -| [characterEncoding](#characterEncoding) | More than one type | Optional | List of character encodings used in the Distribution, using IANA character set names (for example, UTF-8) | -| [accessService](#accessService) | null or array | Optional | A data service that gives access to the distribution of the dataset | -| [accessURL](#accessURL) | More than one type | Recommended | URL for indirect access to the Distribution (for example, a landing page, API docs, or request form), not a direct file download | -| [byteSize](#byteSize) | null or string | Optional | The size of a Distribution in bytes | -| [compressFormat](#compressFormat) | null or string | Optional | The format of the file in which the data is contained in a compressed form, e.g. to reduce the size of the downloadable file | -| [downloadURL](#downloadURL) | More than one type | Optional | Direct URL to a downloadable file for the Distribution; use accessURL for indirect access | -| [mediaType](#mediaType) | null or string | Optional | MIME type of the Distribution (for example, text/csv or application/json), from the IANA media types registry: https://www.iana.org/assignments/media-types/media-types.xhtml | -| [packageFormat](#packageFormat) | null or string | Optional | The format of the file in which one or more data files are grouped together, e.g. to enable a set of related files to be downloaded together | -| [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Optional | The minimum spatial separation resolvable in a dataset distribution, measured in meters | -| [temporalResolution](#temporalResolution) | null or string | Optional | The minimum time period resolvable in the dataset distribution | -| [availability](#availability) | More than one type | Optional | An indication how long it is planned to keep the Distribution of the Dataset available | -| [accessRestriction](#accessRestriction) | null or array | Recommended | List of access restrictions related to the distribution | -| [cuiRestriction](#cuiRestriction) | More than one type | Recommended | Controlled Unclassified Information restriction related to the distribution | -| [describedBy](#describedBy) | More than one type | Recommended | A distribution containing the Data Dictionary for this distribution | -| [useRestriction](#useRestriction) | null or array | Recommended | Use restriction related to the distribution | -| [accessRights](#accessRights) | More than one type | Optional | Information about whether the distribution is publicly accessible, restricted, or not public | -| [conformsTo](#conformsTo) | null or array | Optional | List of standards, schemas, or reference systems the Distribution follows (prefer stable URIs when available) | -| [description](#description) | null or string | Recommended | Plain-language summary of the distribution | -| [format](#format) | null or string | Recommended | A human-readable description of the file format of the Distribution that provides useful information that might not be apparent from mediaType | -| [identifier](#identifier) | More than one type | Optional | The unique identifier for the Distribution (e.g. DOI, ISBN) | -| [otherIdentifier](#otherIdentifier) | null or array | Optional | A list of identifiers for the Distribution besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog | -| [issued](#issued) | More than one type | Optional | The date of formal issuance (e.g., publication) of the Distribution | -| [language](#language) | More than one type | Optional | ISO 639-1 language code values used in the distribution metadata text, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html | -| [license](#license) | More than one type | Recommended | License that governs how the distribution can be used or reused | -| [modified](#modified) | More than one type | Recommended | The most recent date on which the Distribution was changed or modified | -| [rights](#rights) | null or array of string | Recommended | Rights statements not already covered by license or accessRights, such as copyright or policy restrictions | -| [title](#title) | null or string | Recommended | Human-readable title of the distribution | -| [hasQualityMeasurement](#hasQualityMeasurement) | null or array | Optional | Quality measurements for the distribution (for example, completeness, accuracy, or timeliness) | -| [page](#page) | null or array | Optional | A page or document about this Distribution | -| [image](#image) | More than one type | Optional | A link to a thumbnail picture illustrating the content of the distribution | -| [checksum](#checksum) | More than one type | Optional | Checksum used to verify that the downloadable file content has not changed | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#@id) | string | Optional | | +| [@type](#@type) | string | Optional | | +| [representationTechnique](#representationTechnique) | More than one type | Optional | Method or schema used to structure the distribution content (for example, CSV convention, XML schema, or spatial representation type) | +| [status](#status) | More than one type | Optional | The status of the distribution in the context of maturity lifecycle | +| [characterEncoding](#characterEncoding) | More than one type | Optional | List of character encodings used in the Distribution, using IANA character set names (for example, UTF-8) | +| [accessService](#accessService) | null or array of [DataService](./quality-governance.md#data-service) classes | Optional | A data service that gives access to the distribution of the dataset | +| [accessURL](#accessURL) | More than one type | Recommended | URL for indirect access to the Distribution (for example, a landing page, API docs, or request form), not a direct file download | +| [byteSize](#byteSize) | null or string | Optional | The size of a Distribution in bytes | +| [compressFormat](#compressFormat) | null or string | Optional | The format of the file in which the data is contained in a compressed form, e.g. to reduce the size of the downloadable file | +| [downloadURL](#downloadURL) | More than one type | Optional | Direct URL to a downloadable file for the Distribution; use accessURL for indirect access | +| [mediaType](#mediaType) | null or string | Optional | MIME type of the Distribution (for example, text/csv or application/json), from the IANA media types registry: https://www.iana.org/assignments/media-types/media-types.xhtml | +| [packageFormat](#packageFormat) | null or string | Optional | The format of the file in which one or more data files are grouped together, e.g. to enable a set of related files to be downloaded together | +| [spatialResolutionInMeters](#spatialResolutionInMeters) | null or string | Optional | The minimum spatial separation resolvable in a dataset distribution, measured in meters | +| [temporalResolution](#temporalResolution) | null or string | Optional | The minimum time period resolvable in the dataset distribution | +| [availability](#availability) | More than one type | Optional | An indication how long it is planned to keep the Distribution of the Dataset available | +| [accessRestriction](#accessRestriction) | null or array of [AccessRestriction](./constraints-and-restrictions.md#access-restriction) classes | Recommended | List of access restrictions related to the distribution | +| [cuiRestriction](#cuiRestriction) | More than one type | Recommended | Controlled Unclassified Information restriction related to the distribution | +| [describedBy](#describedBy) | More than one type | Recommended | A distribution containing the Data Dictionary for this distribution | +| [useRestriction](#useRestriction) | null or array of [UseRestriction](./constraints-and-restrictions.md#use-restriction) classes | Recommended | Use restriction related to the distribution | +| [accessRights](#accessRights) | More than one type | Optional | Information about whether the distribution is publicly accessible, restricted, or not public | +| [conformsTo](#conformsTo) | null or array of [Standard](./quality-governance.md#standard) classes | Optional | List of standards, schemas, or reference systems the Distribution follows (prefer stable URIs when available) | +| [description](#description) | null or string | Recommended | Plain-language summary of the distribution | +| [format](#format) | null or string | Recommended | A human-readable description of the file format of the Distribution that provides useful information that might not be apparent from mediaType | +| [identifier](#identifier) | More than one type | Optional | The unique identifier for the Distribution (e.g. DOI, ISBN) | +| [otherIdentifier](#otherIdentifier) | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | Optional | A list of identifiers for the Distribution besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog | +| [issued](#issued) | More than one type | Optional | The date of formal issuance (e.g., publication) of the Distribution | +| [language](#language) | More than one type | Optional | ISO 639-1 language code values used in the distribution metadata text, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html | +| [license](#license) | More than one type | Recommended | License that governs how the distribution can be used or reused | +| [modified](#modified) | More than one type | Recommended | The most recent date on which the Distribution was changed or modified | +| [rights](#rights) | null or array of string | Recommended | Rights statements not already covered by license or accessRights, such as copyright or policy restrictions | +| [title](#title) | null or string | Recommended | Human-readable title of the distribution | +| [hasQualityMeasurement](#hasQualityMeasurement) | null or array of [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) classes | Optional | Quality measurements for the distribution (for example, completeness, accuracy, or timeliness) | +| [page](#page) | null or array of [Document](./quality-governance.md#document) classes | Optional | A page or document about this Distribution | +| [image](#image) | More than one type | Optional | A link to a thumbnail picture illustrating the content of the distribution | +| [checksum](#checksum) | More than one type | Optional | Checksum used to verify that the downloadable file content has not changed | ## `Distribution > @id` @@ -102,9 +102,9 @@ A specific representation of a dataset, such as a file, feed, or API response Method or schema used to structure the distribution content (for example, CSV convention, XML schema, or spatial representation type) -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------------------- | @@ -120,7 +120,7 @@ Method or schema used to structure the distribution content (for example, CSV co inline description of Concept -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------- | | **Additional properties** | Any type allowed | | **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | @@ -133,9 +133,9 @@ inline description of Concept The status of the distribution in the context of maturity lifecycle -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | -------------------------------------------------- | @@ -151,7 +151,7 @@ The status of the distribution in the context of maturity lifecycle inline description of Concept -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | @@ -162,9 +162,9 @@ inline description of Concept List of character encodings used in the Distribution, using IANA character set names (for example, UTF-8) -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -186,8 +186,8 @@ List of character encodings used in the Distribution, using IANA character set n ### `Distribution > characterEncoding > anyOf > List of encodings` -| **Type** | `array of string` | -| -------- | ----------------- | +| **Type** | array of string | +| -------- | --------------- | | Each item of this array must be | Description | | ------------------------------------------------------- | ----------- | @@ -204,8 +204,8 @@ List of character encodings used in the Distribution, using IANA character set n A data service that gives access to the distribution of the dataset -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [DataService](./quality-governance.md#data-service) classes | +| -------- | ---------------------------------------------------------------------------- | | Each item of this array must be | Description | | --------------------------------------------------- | ------------------------------------------------------------------- | @@ -217,9 +217,9 @@ A data service that gives access to the distribution of the dataset URL for indirect access to the Distribution (for example, a landing page, API docs, or request form), not a direct file download -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -287,9 +287,9 @@ The format of the file in which the data is contained in a compressed form, e.g. Direct URL to a downloadable file for the Distribution; use accessURL for indirect access -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -387,9 +387,9 @@ The minimum time period resolvable in the dataset distribution An indication how long it is planned to keep the Distribution of the Dataset available -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | -------------------------------------------------------- | @@ -405,7 +405,7 @@ An indication how long it is planned to keep the Distribution of the Dataset ava inline description of Concept -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | @@ -416,8 +416,8 @@ inline description of Concept List of access restrictions related to the distribution -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [AccessRestriction](./constraints-and-restrictions.md#access-restriction) classes | +| -------- | -------------------------------------------------------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------------------------------------------------- | ----------------------------------------------------------- | @@ -429,9 +429,9 @@ List of access restrictions related to the distribution Controlled Unclassified Information restriction related to the distribution -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ---------------------------------------------------------- | @@ -460,9 +460,9 @@ inline description of CUIRestriction A distribution containing the Data Dictionary for this distribution -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------- | @@ -492,8 +492,8 @@ inline description of the data dictionary Use restriction related to the distribution -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [UseRestriction](./constraints-and-restrictions.md#use-restriction) classes | +| -------- | -------------------------------------------------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------------------------------------------- | --------------------------------------------------- | @@ -505,9 +505,9 @@ Use restriction related to the distribution Information about whether the distribution is publicly accessible, restricted, or not public -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -540,8 +540,8 @@ Text description of the access rights List of standards, schemas, or reference systems the Distribution follows (prefer stable URIs when available) -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Standard](./quality-governance.md#standard) classes | +| -------- | --------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------- | ------------------------------------------------------------- | @@ -587,9 +587,9 @@ A human-readable description of the file format of the Distribution that provide The unique identifier for the Distribution (e.g. DOI, ISBN) -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------ | @@ -605,7 +605,7 @@ The unique identifier for the Distribution (e.g. DOI, ISBN) inline description of Identifier -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | @@ -616,8 +616,8 @@ inline description of Identifier A list of identifiers for the Distribution besides the main identifier, e.g. the URI or other unique identifiers in the context of the Catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | +| -------- | ------------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | @@ -631,9 +631,9 @@ A list of identifiers for the Distribution besides the main identifier, e.g. the The date of formal issuance (e.g., publication) of the Distribution -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -665,9 +665,9 @@ The date of formal issuance (e.g., publication) of the Distribution ### `Distribution > issued > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------- | @@ -716,9 +716,9 @@ A year and month in YYYY-MM format ISO 639-1 language code values used in the distribution metadata text, such as en or es, full list can be seen at https://id.loc.gov/vocabulary/iso639-1.html -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -755,8 +755,8 @@ ISO 639-1 language code values used in the distribution metadata text, such as e ### `Distribution > language > anyOf > List of languages` -| **Type** | `array of string` | -| -------- | ----------------- | +| **Type** | array of string | +| -------- | --------------- | | Each item of this array must be | Description | | ----------------------------------------- | ----------- | @@ -777,9 +777,9 @@ ISO 639-1 language code values used in the distribution metadata text, such as e License that governs how the distribution can be used or reused -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -812,9 +812,9 @@ Full text of the license The most recent date on which the Distribution was changed or modified -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -850,9 +850,9 @@ The most recent date on which the Distribution was changed or modified ### `Distribution > modified > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------- | @@ -901,8 +901,8 @@ A year and month in YYYY-MM format Rights statements not already covered by license or accessRights, such as copyright or policy restrictions -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Examples:** @@ -952,8 +952,8 @@ Human-readable title of the distribution Quality measurements for the distribution (for example, completeness, accuracy, or timeliness) -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) classes | +| -------- | ------------------------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------------------------- | ------------------------------------------------------------- | @@ -967,8 +967,8 @@ Quality measurements for the distribution (for example, completeness, accuracy, A page or document about this Distribution -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Document](./quality-governance.md#document) classes | +| -------- | --------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------- | ----------------------------------------------------- | @@ -980,9 +980,9 @@ A page or document about this Distribution A link to a thumbnail picture illustrating the content of the distribution -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------- | @@ -1008,9 +1008,9 @@ The link to the image Checksum used to verify that the downloadable file content has not changed -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ---------------------------------------------------- | diff --git a/jsonschema/docs/identifiers-and-relationships.md b/jsonschema/docs/identifiers-and-relationships.md index 9d6c7848..b2effe65 100644 --- a/jsonschema/docs/identifiers-and-relationships.md +++ b/jsonschema/docs/identifiers-and-relationships.md @@ -8,9 +8,9 @@ Supporting classes for identifiers, relationships, checksums, and controlled con A unique identifier and optionally it's scheme and other relevant information -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------- | @@ -69,9 +69,9 @@ The name of the agency that issued the identifier the agency that manages the identifier scheme -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------------ | @@ -98,9 +98,9 @@ inline description of the creator The date of formal issuance (e.g., publication) of the Identifier -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------------------------------- | @@ -114,9 +114,9 @@ The date of formal issuance (e.g., publication) of the Identifier #### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | -------------------------------------------- | @@ -365,9 +365,9 @@ A lower case hexadecimal encoded digest value produced using a specific algorith A controlled term or label, optionally drawn from a concept scheme -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | -------------------- | @@ -450,9 +450,9 @@ Concept scheme defining this concept List of abbreviations or codes from code lists for the Concept -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------- | @@ -466,8 +466,8 @@ List of abbreviations or codes from code lists for the Concept #### `Concept > anyOf > item 1 > notation > anyOf > item 1` -| **Type** | `array of string` | -| -------- | ----------------- | +| **Type** | array of string | +| -------- | --------------- | | Each item of this array must be | Description | | ------------------------------------------------- | ----------- | @@ -571,9 +571,9 @@ A version number or other version designation of the concept scheme The date on which the Concept Scheme was first created -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -605,9 +605,9 @@ The date on which the Concept Scheme was first created ### `ConceptScheme > created > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------ | @@ -677,9 +677,9 @@ A description of the concept scheme The date of formal issuance (e.g., publication) of the concept scheme -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -711,9 +711,9 @@ The date of formal issuance (e.g., publication) of the concept scheme ### `ConceptScheme > issued > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------- | @@ -764,9 +764,9 @@ A year and month in YYYY-MM format The most recent date at which the concept scheme was changed or modified -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -798,9 +798,9 @@ The most recent date at which the concept scheme was changed or modified ### `ConceptScheme > modified > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------- | diff --git a/jsonschema/docs/quality-governance.md b/jsonschema/docs/quality-governance.md index ff54a5b2..da9a53ad 100644 --- a/jsonschema/docs/quality-governance.md +++ b/jsonschema/docs/quality-governance.md @@ -33,19 +33,19 @@ A standard or specification that another resource conforms to } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------------------ | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| [@id](#standard--@id) | string | Optional | | -| [@type](#standard--@type) | string | Optional | | -| [created](#standard--created) | More than one type | Optional | The date on which the Standard has been first created | -| [description](#standard--description) | null or string | Recommended | Plain-language summary of the standard | -| [identifier](#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](#standard--otherIdentifier) | null or array | 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](#standard--issued) | More than one type | Recommended | The date of formal issuance (e.g., publication) of the Standard | -| [modified](#standard--modified) | More than one type | Optional | The most recent date on which the Standard was changed or modified | -| [title](#standard--title) | null or string | Recommended | Human-readable title of the standard | -| [category](#standard--category) | null or array | Optional | List of categories for the Standard | -| [inScheme](#standard--inScheme) | More than one type | Recommended | The reference register to which the Standard belongs | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------ | ------------------------------------------------------------------------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| [@id](#standard--@id) | string | Optional | | +| [@type](#standard--@type) | string | Optional | | +| [created](#standard--created) | More than one type | Optional | The date on which the Standard has been first created | +| [description](#standard--description) | null or string | Recommended | Plain-language summary of the standard | +| [identifier](#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](#standard--otherIdentifier) | null or array of [Identifier](./identifiers-and-relationships.md#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](#standard--issued) | More than one type | Recommended | The date of formal issuance (e.g., publication) of the Standard | +| [modified](#standard--modified) | More than one type | Optional | The most recent date on which the Standard was changed or modified | +| [title](#standard--title) | null or string | Recommended | Human-readable title of the standard | +| [category](#standard--category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of categories for the Standard | +| [inScheme](#standard--inScheme) | More than one type | Recommended | The reference register to which the Standard belongs | ## `Standard > @id` @@ -77,9 +77,9 @@ A standard or specification that another resource conforms to The date on which the Standard has been first created -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -111,9 +111,9 @@ The date on which the Standard has been first created ### `Standard > created > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------ | @@ -181,9 +181,9 @@ Plain-language summary of the standard The unique identifier for the Standard, e.g. the URI or other unique identifier in the context of the Catalog -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------ | @@ -199,7 +199,7 @@ The unique identifier for the Standard, e.g. the URI or other unique identifier inline description of Identifier -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------------- | | **Additional properties** | Any type allowed | | **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | @@ -210,8 +210,8 @@ inline description of Identifier 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` | -| -------- | --------------- | +| **Type** | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | +| -------- | ------------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | @@ -223,9 +223,9 @@ A list of identifiers for the Standard besides the main identifier, e.g. the URI The date of formal issuance (e.g., publication) of the Standard -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -257,9 +257,9 @@ The date of formal issuance (e.g., publication) of the Standard ### `Standard > issued > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------- | @@ -310,9 +310,9 @@ A year and month in YYYY-MM format The most recent date on which the Standard was changed or modified -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -344,9 +344,9 @@ The most recent date on which the Standard was changed or modified ### `Standard > modified > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------- | @@ -414,8 +414,8 @@ Human-readable title of the standard List of categories for the Standard -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -427,9 +427,9 @@ List of categories for the Standard The reference register to which the Standard belongs -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ---------------------------------------------------- | @@ -483,25 +483,25 @@ A publication or other document related to a resource } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------------------------------ | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [@id](#document--@id) | string | Optional | | -| [@type](#document--@type) | string | Optional | | -| [accessURL](#document--accessURL) | More than one type | Optional | A URL that gives access to the Document | -| [downloadURL](#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](#document--creator) | null or array | Optional | The individual(s) responsible for creating the Document | -| [mediaType](#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](#document--abstract) | null or string | Optional | Text abstract of the Document | -| [bibliographicCitation](#document--bibliographicCitation) | null or string | Recommended | Bibliographic citation as text | -| [conformsTo](#document--conformsTo) | null or array | Optional | List of standards or specifications the document follows | -| [corporateCreator](#document--corporateCreator) | null or array | Optional | The corporate organization(s) responsible for creating the Document | -| [description](#document--description) | null or string | Recommended | Plain-language summary of the document | -| [identifier](#document--identifier) | More than one type | Recommended | The unique identifier for the Document (e.g. DOI, ISBN) | -| [otherIdentifier](#document--otherIdentifier) | null or array | 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](#document--issued) | More than one type | Recommended | Publication date of the Document | -| [publisher](#document--publisher) | null or array | Recommended | The organization(s) that published the Document | -| [title](#document--title) | string | Mandatory | The title of the Document | -| [category](#document--category) | null or array | Optional | List of categories/genres for the Document | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------------------ | ------------------------------------------------------------------------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [@id](#document--@id) | string | Optional | | +| [@type](#document--@type) | string | Optional | | +| [accessURL](#document--accessURL) | More than one type | Optional | A URL that gives access to the Document | +| [downloadURL](#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](#document--creator) | null or array of [Kind](./agents.md#kind) classes | Optional | The individual(s) responsible for creating the Document | +| [mediaType](#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](#document--abstract) | null or string | Optional | Text abstract of the Document | +| [bibliographicCitation](#document--bibliographicCitation) | null or string | Recommended | Bibliographic citation as text | +| [conformsTo](#document--conformsTo) | null or array of [Standard](./quality-governance.md#standard) classes | Optional | List of standards or specifications the document follows | +| [corporateCreator](#document--corporateCreator) | null or array of [Organization](./agents.md#organization) classes | Optional | The corporate organization(s) responsible for creating the Document | +| [description](#document--description) | null or string | Recommended | Plain-language summary of the document | +| [identifier](#document--identifier) | More than one type | Recommended | The unique identifier for the Document (e.g. DOI, ISBN) | +| [otherIdentifier](#document--otherIdentifier) | null or array of [Identifier](./identifiers-and-relationships.md#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](#document--issued) | More than one type | Recommended | Publication date of the Document | +| [publisher](#document--publisher) | null or array of [Organization](./agents.md#organization) classes | Recommended | The organization(s) that published the Document | +| [title](#document--title) | string | Mandatory | The title of the Document | +| [category](#document--category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of categories/genres for the Document | ## `Document > @id` @@ -531,9 +531,9 @@ A publication or other document related to a resource A URL that gives access to the Document -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -565,9 +565,9 @@ reference iri of Document A URL that is a direct link to a downloadable file of the Document in a given format -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -601,8 +601,8 @@ reference iri of Document The individual(s) responsible for creating the Document -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Kind](./agents.md#kind) classes | +| -------- | ------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | ----------------------------------------------- | @@ -663,8 +663,8 @@ Bibliographic citation as text List of standards or specifications the document follows -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Standard](./quality-governance.md#standard) classes | +| -------- | --------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------- | ------------------------------------------------------------- | @@ -678,8 +678,8 @@ List of standards or specifications the document follows The corporate organization(s) responsible for creating the Document -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Organization](./agents.md#organization) classes | +| -------- | ----------------------------------------------------------------- | | Each item of this array must be | Description | | ---------------------------------------- | --------------------------------------------------------------------------------- | @@ -710,9 +710,9 @@ Plain-language summary of the document The unique identifier for the Document (e.g. DOI, ISBN) -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------ | @@ -728,7 +728,7 @@ The unique identifier for the Document (e.g. DOI, ISBN) inline description of Identifier -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | @@ -739,8 +739,8 @@ inline description of Identifier 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` | -| -------- | --------------- | +| **Type** | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | +| -------- | ------------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | @@ -754,9 +754,9 @@ A list of identifiers for the Document besides the main identifier, e.g. the URI Publication date of the Document -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -788,9 +788,9 @@ Publication date of the Document ### `Document > issued > anyOf > item 1` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------- | @@ -839,8 +839,8 @@ A year and month in YYYY-MM format The organization(s) that published the Document -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Organization](./agents.md#organization) classes | +| -------- | ----------------------------------------------------------------- | | Each item of this array must be | Description | | ---------------------------------------- | --------------------------------------------------------------------------------- | @@ -868,8 +868,8 @@ The title of the Document List of categories/genres for the Document -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -913,7 +913,7 @@ A record in a catalog, describing the registration of a single resource | [status](#catalog-record--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](#catalog-record--conformsTo) | More than one type | Recommended | An Application Profile that the Catalog Record's metadata conforms to | | [description](#catalog-record--description) | null or array of string | Optional | A list of free-text accounts of the catalog record | -| [issued](#catalog-record--issued) | null or array | Optional | List of dates on which the catalog record was included in the catalog | +| [issued](#catalog-record--issued) | null or array of object | Optional | List of dates on which the catalog record was included in the catalog | | [language](#catalog-record--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](#catalog-record--modified) | More than one type | Mandatory | The most recent date on which the catalog record was changed or modified | | [source](#catalog-record--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 | @@ -950,9 +950,9 @@ A record in a catalog, describing the registration of a single resource The status of the catalog record in the context of editorial flow of the dataset and data service descriptions -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | -------------------------------------------------- | @@ -968,7 +968,7 @@ The status of the catalog record in the context of editorial flow of the dataset inline description of status -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------- | | **Additional properties** | Any type allowed | | **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | @@ -981,9 +981,9 @@ inline description of status An Application Profile that the Catalog Record's metadata conforms to -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------------------------ | @@ -1012,8 +1012,8 @@ inline description of application profile A list of free-text accounts of the catalog record -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Example:** @@ -1041,8 +1041,8 @@ A list of free-text accounts of the catalog record List of dates on which the catalog record was included in the catalog -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of object | +| -------- | ----------------------- | **Examples:** @@ -1076,9 +1076,9 @@ List of dates on which the catalog record was included in the catalog ### Date string -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | -------------------------------- | @@ -1127,9 +1127,9 @@ A year and month in YYYY-MM format 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** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -1166,8 +1166,8 @@ Language code used in catalog record metadata text, using ISO 639-1 values such ### `CatalogRecord > language > anyOf > Array of language codes` -| **Type** | `array of string` | -| -------- | ----------------- | +| **Type** | array of string | +| -------- | --------------- | | Each item of this array must be | Description | | ----------------------------------------- | ----------- | @@ -1190,10 +1190,10 @@ Language code used in catalog record metadata text, using ISO 639-1 values such The most recent date on which the catalog record was changed or modified -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Required** | Yes | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Required** | Yes | +| **Additional properties** | Any type allowed | **Examples:** @@ -1370,38 +1370,38 @@ A service that provides access to data or data processing functions } ``` -| Property | Type | Requirement Level | Title/Description | -| -------------------------------------------------------- | ----------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| [@id](#data-service--@id) | string | Optional | | -| [@type](#data-service--@type) | string | Optional | | -| [contactPoint](#data-service--contactPoint) | array | Mandatory | Contact information for questions about the Data Service. Include an email address that is continuously monitored | -| [endpointDescription](#data-service--endpointDescription) | null or array of string | Recommended | List of endpoint descriptions with operations and parameters (for example, OpenAPI or similar service documentation) | -| [endpointURL](#data-service--endpointURL) | array of string | Mandatory | A list of root locations or primary endpoints of the service (a Web-resolvable IRI) | -| [keyword](#data-service--keyword) | null or array of string | Optional | List of keywords or tags describing the data service | -| [servesDataset](#data-service--servesDataset) | null or array | Recommended | List of datasets this service provides access to | -| [spatialResolutionInMeters](#data-service--spatialResolutionInMeters) | null or string | Optional | The minimum spatial separation resolvable in a Data Service, measured in meters | -| [temporalResolution](#data-service--temporalResolution) | null or string | Optional | The minimum time period resolvable by the Data Service | -| [theme](#data-service--theme) | null or array | Optional | List of themes or categories for the data service | -| [accessRights](#data-service--accessRights) | More than one type | Optional | Information about whether the data service is publicly accessible, restricted, or not public | -| [conformsTo](#data-service--conformsTo) | null or array | Optional | List of general standards or specifications that the Data Service endpoints implement | -| [created](#data-service--created) | More than one type | Optional | The date on which the Data Service was first created | -| [creator](#data-service--creator) | null or array | Optional | List of agents primarily responsible for producing the Data Service | -| [description](#data-service--description) | null or string | Optional | Plain-language summary of the data service | -| [identifier](#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](#data-service--otherIdentifier) | null or array | 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](#data-service--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](#data-service--license) | More than one type | Recommended | License that governs how the data service can be used or reused | -| [modified](#data-service--modified) | More than one type | Optional | The most recent date on which the Data Service was changed or modified | -| [publisher](#data-service--publisher) | object | Mandatory | Person or organization responsible for publishing and making the data service available | -| [rights](#data-service--rights) | null or array of string | Optional | Rights statements not already covered by license or accessRights, such as copyright or policy restrictions | -| [rightsHolder](#data-service--rightsHolder) | null or array | Optional | A list of Agents (organizations) holding rights on the Data Service | -| [spatial](#data-service--spatial) | null or array | Optional | A geographic region that is covered by the Data Service | -| [temporal](#data-service--temporal) | null or array | Optional | Time periods covered by the data service | -| [title](#data-service--title) | string | Mandatory | Human-readable title of the data service | -| [category](#data-service--category) | null or array | Optional | List of high-level categories for the data service | -| [hasQualityMeasurement](#data-service--hasQualityMeasurement) | null or array | Optional | Quality measurements for the data service (for example, availability, response time, or reliability) | -| [qualifiedAttribution](#data-service--qualifiedAttribution) | null or array | Optional | List of agents with specific responsibilities for the data service | -| [wasUsedBy](#data-service--wasUsedBy) | null or array | Optional | List of activities that used or tested the data service | +| Property | Type | Requirement Level | Title/Description | +| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#data-service--@id) | string | Optional | | +| [@type](#data-service--@type) | string | Optional | | +| [contactPoint](#data-service--contactPoint) | array of [Kind](./agents.md#kind) classes | Mandatory | Contact information for questions about the Data Service. Include an email address that is continuously monitored | +| [endpointDescription](#data-service--endpointDescription) | null or array of string | Recommended | List of endpoint descriptions with operations and parameters (for example, OpenAPI or similar service documentation) | +| [endpointURL](#data-service--endpointURL) | array of string | Mandatory | A list of root locations or primary endpoints of the service (a Web-resolvable IRI) | +| [keyword](#data-service--keyword) | null or array of string | Optional | List of keywords or tags describing the data service | +| [servesDataset](#data-service--servesDataset) | null or array of [Dataset](./dataset.md#root) classes | Recommended | List of datasets this service provides access to | +| [spatialResolutionInMeters](#data-service--spatialResolutionInMeters) | null or string | Optional | The minimum spatial separation resolvable in a Data Service, measured in meters | +| [temporalResolution](#data-service--temporalResolution) | null or string | Optional | The minimum time period resolvable by the Data Service | +| [theme](#data-service--theme) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of themes or categories for the data service | +| [accessRights](#data-service--accessRights) | More than one type | Optional | Information about whether the data service is publicly accessible, restricted, or not public | +| [conformsTo](#data-service--conformsTo) | null or array of [Standard](./quality-governance.md#standard) classes | Optional | List of general standards or specifications that the Data Service endpoints implement | +| [created](#data-service--created) | More than one type | Optional | The date on which the Data Service was first created | +| [creator](#data-service--creator) | null or array of [Agent](./agents.md#agent) classes | Optional | List of agents primarily responsible for producing the Data Service | +| [description](#data-service--description) | null or string | Optional | Plain-language summary of the data service | +| [identifier](#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](#data-service--otherIdentifier) | null or array of [Identifier](./identifiers-and-relationships.md#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](#data-service--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](#data-service--license) | More than one type | Recommended | License that governs how the data service can be used or reused | +| [modified](#data-service--modified) | More than one type | Optional | The most recent date on which the Data Service was changed or modified | +| [publisher](#data-service--publisher) | object | Mandatory | Person or organization responsible for publishing and making the data service available | +| [rights](#data-service--rights) | null or array of string | Optional | Rights statements not already covered by license or accessRights, such as copyright or policy restrictions | +| [rightsHolder](#data-service--rightsHolder) | null or array of [Organization](./agents.md#organization) classes | Optional | A list of Agents (organizations) holding rights on the Data Service | +| [spatial](#data-service--spatial) | null or array of [Location](./temporal-spatial-metrics.md#location) classes | Optional | A geographic region that is covered by the Data Service | +| [temporal](#data-service--temporal) | null or array of [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) classes | Optional | Time periods covered by the data service | +| [title](#data-service--title) | string | Mandatory | Human-readable title of the data service | +| [category](#data-service--category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of high-level categories for the data service | +| [hasQualityMeasurement](#data-service--hasQualityMeasurement) | null or array of [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) classes | Optional | Quality measurements for the data service (for example, availability, response time, or reliability) | +| [qualifiedAttribution](#data-service--qualifiedAttribution) | null or array of [Attribution](./quality-governance.md#attribution) classes | Optional | List of agents with specific responsibilities for the data service | +| [wasUsedBy](#data-service--wasUsedBy) | null or array of [Activity](./temporal-spatial-metrics.md#activity) classes | Optional | List of activities that used or tested the data service | ## `DataService > @id` @@ -1431,9 +1431,9 @@ A service that provides access to data or data processing functions Contact information for questions about the Data Service. Include an email address that is continuously monitored -| **Type** | `array` | -| ------------ | ------- | -| **Required** | Yes | +| **Type** | array of [Kind](./agents.md#kind) classes | +| ------------ | ----------------------------------------- | +| **Required** | Yes | | Each item of this array must be | Description | | ------------------------------- | ----------------------------------------------- | @@ -1445,8 +1445,8 @@ Contact information for questions about the Data Service. Include an email addre List of endpoint descriptions with operations and parameters (for example, OpenAPI or similar service documentation) -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Examples:** @@ -1477,9 +1477,9 @@ List of endpoint descriptions with operations and parameters (for example, OpenA A list of root locations or primary endpoints of the service (a Web-resolvable IRI) -| **Type** | `array of string` | -| ------------ | ----------------- | -| **Required** | Yes | +| **Type** | array of string | +| ------------ | --------------- | +| **Required** | Yes | **Examples:** @@ -1516,8 +1516,8 @@ The root location or primary endpoint of the service (a Web-resolvable IRI) List of keywords or tags describing the data service -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Examples:** @@ -1558,8 +1558,8 @@ List of keywords or tags describing the data service List of datasets this service provides access to -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Dataset](./dataset.md#root) classes | +| -------- | ----------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | --------------------------------------------------------- | @@ -1603,8 +1603,8 @@ The minimum time period resolvable by the Data Service List of themes or categories for the data service -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -1616,9 +1616,9 @@ List of themes or categories for the data service Information about whether the data service is publicly accessible, restricted, or not public -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -1649,8 +1649,8 @@ Text description of the access rights List of general standards or specifications that the Data Service endpoints implement -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Standard](./quality-governance.md#standard) classes | +| -------- | --------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------- | ------------------------------------------------------------- | @@ -1664,9 +1664,9 @@ List of general standards or specifications that the Data Service endpoints impl The date on which the Data Service was first created -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -1698,9 +1698,9 @@ The date on which the Data Service was first created ### `DataService > created > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------ | @@ -1749,8 +1749,8 @@ A year and month in YYYY-MM format List of agents primarily responsible for producing the Data Service -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Agent](./agents.md#agent) classes | +| -------- | --------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------- | -------------------------------------------------------------------------------- | @@ -1777,9 +1777,9 @@ Plain-language summary of the data service The unique identifier for the Data Service, e.g. the URI or other unique identifier in the context of the Catalog -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ---------------------------------- | @@ -1795,7 +1795,7 @@ The unique identifier for the Data Service, e.g. the URI or other unique identif inline description of Identifier -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------------- | | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | @@ -1806,8 +1806,8 @@ inline description of Identifier 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` | -| -------- | --------------- | +| **Type** | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | +| -------- | ------------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | @@ -1819,9 +1819,9 @@ A list of identifiers for the Data Service besides the main identifier, e.g. the 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** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -1858,8 +1858,8 @@ ISO 639-1 language code values supported by the data service, such as en or es, ### `DataService > language > anyOf > List of lanuages` -| **Type** | `array of string` | -| -------- | ----------------- | +| **Type** | array of string | +| -------- | --------------- | | Each item of this array must be | Description | | ----------------------------------------- | ----------- | @@ -1880,9 +1880,9 @@ ISO 639-1 language code values supported by the data service, such as en or es, License that governs how the data service can be used or reused -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -1915,9 +1915,9 @@ Full text of the license The most recent date on which the Data Service was changed or modified -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -1949,9 +1949,9 @@ The most recent date on which the Data Service was changed or modified ### `DataService > modified > anyOf > Date string` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------- | @@ -2012,8 +2012,8 @@ Person or organization responsible for publishing and making the data service av Rights statements not already covered by license or accessRights, such as copyright or policy restrictions -| **Type** | `null or array of string` | -| -------- | ------------------------- | +| **Type** | null or array of string | +| -------- | ----------------------- | **Example:** @@ -2038,8 +2038,8 @@ Rights statements not already covered by license or accessRights, such as copyri A list of Agents (organizations) holding rights on the Data Service -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Organization](./agents.md#organization) classes | +| -------- | ----------------------------------------------------------------- | | Each item of this array must be | Description | | ---------------------------------------- | --------------------------------------------------------------------------------- | @@ -2053,8 +2053,8 @@ A list of Agents (organizations) holding rights on the Data Service A geographic region that is covered by the Data Service -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Location](./temporal-spatial-metrics.md#location) classes | +| -------- | --------------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------------- | -------------------------------- | @@ -2068,8 +2068,8 @@ A geographic region that is covered by the Data Service Time periods covered by the data service -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) classes | +| -------- | ------------------------------------------------------------------------------------- | | Each item of this array must be | Description | | ------------------------------------------------------------ | ---------------------------------------------------------------------- | @@ -2097,8 +2097,8 @@ Human-readable title of the data service List of high-level categories for the data service -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | @@ -2112,8 +2112,8 @@ List of high-level categories for the data service Quality measurements for the data service (for example, availability, response time, or reliability) -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) classes | +| -------- | ------------------------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------------------------- | ------------------------------------------------------------- | @@ -2125,8 +2125,8 @@ Quality measurements for the data service (for example, availability, response t List of agents with specific responsibilities for the data service -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Attribution](./quality-governance.md#attribution) classes | +| -------- | --------------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------------- | ------------------------------------------------- | @@ -2138,8 +2138,8 @@ List of agents with specific responsibilities for the data service List of activities that used or tested the data service -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Activity](./temporal-spatial-metrics.md#activity) classes | +| -------- | --------------------------------------------------------------------------- | | Each item of this array must be | Description | | -------------------------------------------------- | -------------------------------------------------------------- | diff --git a/jsonschema/docs/temporal-spatial-metrics.md b/jsonschema/docs/temporal-spatial-metrics.md index 3fd7f3f7..969b954f 100644 --- a/jsonschema/docs/temporal-spatial-metrics.md +++ b/jsonschema/docs/temporal-spatial-metrics.md @@ -8,9 +8,9 @@ Supporting classes for time periods, locations, quality metrics, measurements, a Information about a specific time period with a start- and/or end-time -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -80,9 +80,9 @@ Information about a specific time period with a start- and/or end-time The end date of the period of time -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -114,9 +114,9 @@ The end date of the period of time ### `PeriodOfTime > endDate > anyOf > item 1` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ------------------------------------ | @@ -165,9 +165,9 @@ A year and month in YYYY-MM format The start date of the period of time -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -199,9 +199,9 @@ The start date of the period of time ### `PeriodOfTime > startDate > anyOf > item 1` -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | -------------------------------------- | @@ -366,18 +366,18 @@ A named place or geographic area } ``` -| Property | Type | Requirement Level | Title/Description | -| ------------------------------------ | ------------------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [@id](#location--@id) | string | Optional | | -| [@type](#location--@type) | string | Optional | | -| [bbox](#location--bbox) | More than one type | Recommended | Bounding box for the location, described in WKT, GeoJSON, or GML format | -| [centroid](#location--centroid) | More than one type | Optional | The geographic center (centroid) of a location described in WKT, GeoJSON, or GML format | -| [identifier](#location--identifier) | More than one type | Optional | The unique geographic identifier for the Location, e.g., the URI or other unique identifier in the context of the relevant gazetteer | -| [otherIdentifier](#location--otherIdentifier) | null or array | Optional | A list of geographic identifiers for the Location besides the main identifier, e.g. the URI or other unique identifiers in the context of the relevant gazetteer | -| [geometry](#location--geometry) | More than one type | Optional | Associates a location with a corresponding geometry described in WKT, GeoJSON, or GML format | -| [inScheme](#location--inScheme) | More than one type | Optional | The gazetteer to which the location belongs | -| [altLabel](#location--altLabel) | null or string | Optional | An alternative label or name for a location | -| [prefLabel](#location--prefLabel) | null or string | Recommended | Preferred label or name of the Location | +| Property | Type | Requirement Level | Title/Description | +| ------------------------------------ | ------------------------------------------------------------------------------------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [@id](#location--@id) | string | Optional | | +| [@type](#location--@type) | string | Optional | | +| [bbox](#location--bbox) | More than one type | Recommended | Bounding box for the location, described in WKT, GeoJSON, or GML format | +| [centroid](#location--centroid) | More than one type | Optional | The geographic center (centroid) of a location described in WKT, GeoJSON, or GML format | +| [identifier](#location--identifier) | More than one type | Optional | The unique geographic identifier for the Location, e.g., the URI or other unique identifier in the context of the relevant gazetteer | +| [otherIdentifier](#location--otherIdentifier) | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | Optional | A list of geographic identifiers for the Location besides the main identifier, e.g. the URI or other unique identifiers in the context of the relevant gazetteer | +| [geometry](#location--geometry) | More than one type | Optional | Associates a location with a corresponding geometry described in WKT, GeoJSON, or GML format | +| [inScheme](#location--inScheme) | More than one type | Optional | The gazetteer to which the location belongs | +| [altLabel](#location--altLabel) | null or string | Optional | An alternative label or name for a location | +| [prefLabel](#location--prefLabel) | null or string | Recommended | Preferred label or name of the Location | ## `Location > @id` @@ -409,9 +409,9 @@ A named place or geographic area Bounding box for the location, described in WKT, GeoJSON, or GML format -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Examples:** @@ -504,9 +504,9 @@ Specific value: `"Polygon"` The geographic center (centroid) of a location described in WKT, GeoJSON, or GML format -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -555,9 +555,9 @@ Centroid represented in GeoJSON format; force point usage with coordinates of lo **Requirement:** Optional -| **Type** | `array of number` | -| ------------ | ----------------- | -| **Required** | Yes | +| **Type** | array of number | +| ------------ | --------------- | +| **Required** | Yes | | Each item of this array must be | Description | | --------------------------------------------------------- | ----------- | @@ -584,9 +584,9 @@ Specific value: `"Point"` The unique geographic identifier for the Location, e.g., the URI or other unique identifier in the context of the relevant gazetteer -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ---------------------------------- | @@ -602,7 +602,7 @@ The unique geographic identifier for the Location, e.g., the URI or other unique inline description of Identifier -| **Type** | More than one type | +| **Type** | `combining` | | ------------------------- | ----------------------------------------------------------- | | **Additional properties** | Any type allowed | | **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | @@ -613,8 +613,8 @@ inline description of Identifier A list of geographic identifiers for the Location besides the main identifier, e.g. the URI or other unique identifiers in the context of the relevant gazetteer -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Identifier](./identifiers-and-relationships.md#identifier) classes | +| -------- | ------------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | @@ -626,9 +626,9 @@ A list of geographic identifiers for the Location besides the main identifier, e Associates a location with a corresponding geometry described in WKT, GeoJSON, or GML format -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | **Example:** @@ -724,9 +724,9 @@ Geometry represented in GeoJSON format The gazetteer to which the location belongs -| **Type** | More than one type | -| ------------------------- | ------------------ | -| **Additional properties** | Any type allowed | +| **Type** | `combining` | +| ------------------------- | ---------------- | +| **Additional properties** | Any type allowed | | Any of | | ----------------------------------- | @@ -1022,12 +1022,12 @@ An activity related to creating, changing, or using a resource } ``` -| Property | Type | Requirement Level | Title/Description | -| ---------------------- | ------------- | ----------------- | --------------------------------------- | -| [@id](#activity--@id) | string | Optional | | -| [@type](#activity--@type) | string | Optional | | -| [category](#activity--category) | null or array | Optional | List of categories for the Activity | -| [label](#activity--label) | string | Mandatory | A human-readable label for the activity | +| Property | Type | Requirement Level | Title/Description | +| ---------------------- | ------------------------------------------------------------------------------ | ----------------- | --------------------------------------- | +| [@id](#activity--@id) | string | Optional | | +| [@type](#activity--@type) | string | Optional | | +| [category](#activity--category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of categories for the Activity | +| [label](#activity--label) | string | Mandatory | A human-readable label for the activity | ## `Activity > @id` @@ -1057,8 +1057,8 @@ An activity related to creating, changing, or using a resource List of categories for the Activity -| **Type** | `null or array` | -| -------- | --------------- | +| **Type** | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | +| -------- | ------------------------------------------------------------------------------ | | Each item of this array must be | Description | | ----------------------------------------------------- | ------------------------------------------------------------------ | diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index 22849225..c7d3126c 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -400,6 +400,30 @@ def property_summary_text(schema): return "" +def _array_item_type_label(item_schema): + canonical_link = _canonical_class_doc_link(item_schema) + if canonical_link: + return f"{canonical_link} classes" + + title = getattr(item_schema, "title", None) + if should_render_title(item_schema): + return title + + return getattr(item_schema, "type_name", "item") + + +def _display_type_label(schema): + array_item = getattr(schema, "array_items_def", None) + tuple_items = getattr(schema, "tuple_validation_items", None) or [] + if array_item and not tuple_items: + label = f"array of {_array_item_type_label(array_item)}" + if "null" in str(getattr(schema, "type_name", "")).lower(): + return f"null or {label}" + return label + + return None + + def schema_requirement_level(schema): """Template helper for property requirement level. @@ -456,6 +480,9 @@ def properties_table_wrap(properties_list, schema): line[property_column_index] = line[property_column_index][2:] property_node = property_nodes[index - 1] + display_type = _display_type_label(property_node) + if display_type: + line[property_column_index + 1] = display_type requirement = schema_requirement_level(property_node) line.insert(property_column_index + 2, requirement) line[property_column_index + 3] = _escape_for_table( @@ -495,7 +522,12 @@ def type_info_table_wrap(type_info_list, schema): # edit lines for line in type_info_list: - if line[0].strip("*") == "Defined in": + line_label = line[0].strip("*") + if line_label == "Type": + display_type = _display_type_label(schema) + if display_type: + line[1] = display_type + elif line_label == "Defined in": if canonical_link: line[1] = canonical_link else: @@ -503,7 +535,7 @@ def type_info_table_wrap(type_info_list, schema): match = re.match(r"^/dcat-us/3.0.0/definitions/(\w+)", line[1]) class_name = match.group(1) line[1] = f"[{class_name.title()}](./{class_name.title()}.md)" - elif line[0].strip("*") == "Same definition as" and canonical_link: + elif line_label == "Same definition as" and canonical_link: line[1] = canonical_link elif "`combining`" in line: # replace combining with something better From 4ff3c774feb89b7414e5c601ee1c46bb474817df Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 22:33:36 -0600 Subject: [PATCH 08/13] Remove index.md, we don't need it. Update readme. Co-authored-by: Copilot --- jsonschema/docs/README.md | 48 +++++++++++++++++++++--------- jsonschema/docs/index.md | 18 ----------- jsonschema/generate_schema_docs.py | 27 ----------------- 3 files changed, 34 insertions(+), 59 deletions(-) delete mode 100644 jsonschema/docs/index.md diff --git a/jsonschema/docs/README.md b/jsonschema/docs/README.md index 6b8ce540..7995c10e 100644 --- a/jsonschema/docs/README.md +++ b/jsonschema/docs/README.md @@ -1,27 +1,47 @@ -# Schema documentation +# DCAT-US 3 Schema Documentation -This directory contains Markdown documentation for the DCAT-US JSON schema. -The docs are generated with the `generate_schema_docs.py` script from the -parent directory. The docs are derived automatically from the JSON Schema -files without any manual intervention. +This directory contains the generated Markdown documentation for the DCAT-US 3 +JSON Schema. The documentation is intended to provide a review-friendly, +human-readable view of the schema so contributors and implementers can inspect +the classes, fields, examples, and requirement levels without reading raw JSON +Schema files directly. -When you have made any changes to the schema files, run +## Documentation pages + +### Main classes + +- [Catalog](./catalog.md) +- [Dataset](./dataset.md) +- [Dataset Series](./dataset-series.md) +- [Distribution](./distribution.md) + +### Supporting classes + +- [Agents](./agents.md): [Agent](./agents.md#agent), [Organization](./agents.md#organization), [Kind](./agents.md#kind) +- [Constraints and Restrictions](./constraints-and-restrictions.md): [AccessRestriction](./constraints-and-restrictions.md#access-restriction), [CUIRestriction](./constraints-and-restrictions.md#cui-restriction), [UseRestriction](./constraints-and-restrictions.md#use-restriction) +- [Identifiers and Relationships](./identifiers-and-relationships.md): [Identifier](./identifiers-and-relationships.md#identifier), [Relationship](./identifiers-and-relationships.md#relationship), [Checksum](./identifiers-and-relationships.md#checksum), [Concept](./identifiers-and-relationships.md#concept), [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) +- [Temporal, Spatial, and Metrics](./temporal-spatial-metrics.md): [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time), [Location](./temporal-spatial-metrics.md#location), [Metric](./temporal-spatial-metrics.md#metric), [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement), [Activity](./temporal-spatial-metrics.md#activity), [Address](./temporal-spatial-metrics.md#address) +- [Quality and Governance](./quality-governance.md): [Standard](./quality-governance.md#standard), [Document](./quality-governance.md#document), [CatalogRecord](./quality-governance.md#catalog-record), [DataService](./quality-governance.md#data-service), [Attribution](./quality-governance.md#attribution) + +## Regenerating the docs + +The docs are generated with `generate_schema_docs.py` from the parent directory. +They are derived automatically from the JSON Schema files without manual edits. + +When you change schema files, run: ``` poetry run python generate_schema_docs.py ``` -in the parent directory to update the documentation here. - ## Version controlling derived files -For convenience, we want these files to be under version control, but we -also want to ensure that they are up to date with any changes in the schema -files. We use a Github Actions script to run +These generated files are kept under version control for convenience, but they +must always match the current schema definitions. CI validates that by running: ``` -poetry run generate_schema_docs.py --check +poetry run python generate_schema_docs.py --check ``` -which validates that the documentation generated from the present version of -the schema matches precisely with what is in this directory. +That check fails if the generated output differs from what is committed in this +directory. diff --git a/jsonschema/docs/index.md b/jsonschema/docs/index.md deleted file mode 100644 index 6ee6a660..00000000 --- a/jsonschema/docs/index.md +++ /dev/null @@ -1,18 +0,0 @@ -# DCAT-US 3 Schema Documentation - -DCAT-US 3 is documented here as a smaller set of review-friendly pages. - -## Main classes - -- [Catalog](./catalog.md) -- [Dataset](./dataset.md) -- [Dataset Series](./dataset-series.md) -- [Distribution](./distribution.md) - -## Supporting classes - -- [Agents](./agents.md): [Agent](./agents.md#agent), [Organization](./agents.md#organization), [Kind](./agents.md#kind) -- [Constraints and Restrictions](./constraints-and-restrictions.md): [AccessRestriction](./constraints-and-restrictions.md#access-restriction), [CUIRestriction](./constraints-and-restrictions.md#cui-restriction), [UseRestriction](./constraints-and-restrictions.md#use-restriction) -- [Identifiers and Relationships](./identifiers-and-relationships.md): [Identifier](./identifiers-and-relationships.md#identifier), [Relationship](./identifiers-and-relationships.md#relationship), [Checksum](./identifiers-and-relationships.md#checksum), [Concept](./identifiers-and-relationships.md#concept), [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) -- [Temporal, Spatial, and Metrics](./temporal-spatial-metrics.md): [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time), [Location](./temporal-spatial-metrics.md#location), [Metric](./temporal-spatial-metrics.md#metric), [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement), [Activity](./temporal-spatial-metrics.md#activity), [Address](./temporal-spatial-metrics.md#address) -- [Quality and Governance](./quality-governance.md): [Standard](./quality-governance.md#standard), [Document](./quality-governance.md#document), [CatalogRecord](./quality-governance.md#catalog-record), [DataService](./quality-governance.md#data-service), [Attribution](./quality-governance.md#attribution) diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index c7d3126c..1b4f2b53 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -281,31 +281,6 @@ def _read_generated_doc(docs_dir, file_name): return path.read_text(encoding="utf-8") -def _build_index_page(): - lines = [ - "# DCAT-US 3 Schema Documentation", - "", - "DCAT-US 3 is documented here as a smaller set of review-friendly pages.", - "", - "## Main classes", - "", - ] - - for page in MAIN_CLASS_PAGES: - lines.append(f"- [{page['title']}](./{page['output']})") - - lines.extend(["", "## Supporting classes", ""]) - - for page in GROUPED_CLASS_PAGES: - class_links = ", ".join( - f"[{_class_name_from_file(class_file)}](./{page['output']}#{_class_anchor(_class_name_from_file(class_file))})" - for class_file in page["classes"] - ) - lines.append(f"- [{page['title']}](./{page['output']}): {class_links}") - - return "\n".join(lines) - - def _clear_generated_markdown(output_dir): for markdown_file in Path(output_dir).glob("*.md"): if markdown_file.name == "README.md": @@ -344,8 +319,6 @@ def _build_public_docs(rendered_docs_dir, output_dir): f"# {page['title']}\n\n{page['intro']}\n\n{page_content}", ) - _write_text(output_dir / "index.md", _build_index_page()) - def _normalize_requirement_level(value): """Return a normalized requirement level label.""" From 88a9453f337d09c3563d332ee39058267d25742e Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 23:44:32 -0600 Subject: [PATCH 09/13] Add examples to concept. Co-authored-by: Copilot --- jsonschema/definitions/Concept.json | 90 +++++++++-- .../docs/identifiers-and-relationships.md | 146 ++++++++++++++++++ 2 files changed, 227 insertions(+), 9 deletions(-) diff --git a/jsonschema/definitions/Concept.json b/jsonschema/definitions/Concept.json index 50f18ddd..4ccfcba4 100644 --- a/jsonschema/definitions/Concept.json +++ b/jsonschema/definitions/Concept.json @@ -7,14 +7,32 @@ { "type": "string", "title": "Concept", - "description": "The value of the concept, expressed as a string. This is only used when the concept is not further described by the properties of the Concept object and is not linked to a concept scheme." + "description": "The value of the concept, expressed as a string. This is only used when the concept is not further described by the properties of the Concept object and is not linked to a concept scheme.", + "examples": [ "Environment", "Climate Science" ] }, { "type": "object", + "examples": [ + { + "@type": "Concept", + "prefLabel": "Environment" + }, + { + "@type": "Concept", + "prefLabel": "Climate Science", + "definition": "The scientific study of climate patterns and change.", + "inScheme": { + "@id": "https://example.gov/concept-schemes/science-domains", + "@type": "ConceptScheme", + "title": "Science Domains" + } + } + ], "properties": { "@id": { "type": "string", - "format": "iri" + "format": "iri", + "examples": [ "https://example.gov/concepts/environment" ] }, "@type": { "type": "string", @@ -23,17 +41,36 @@ "altLabel": { "title": "alternate label", "description": "Alternative label for a concept", - "type": ["null", "string"] + "type": [ "null", "string" ], + "examples": [ "Ecology" ] }, "definition": { "title": "definition", "description": "Definition of the controlled vocabulary term", - "type": ["null", "string"] + "type": [ "null", "string" ], + "examples": [ + "The scientific study of climate patterns and change.", + "The natural world, including air, water, land, plants, and animals, especially as affected by human activity." + ] }, "inScheme": { "title": "in scheme", "description": "Concept scheme defining this concept", - "$ref": "/dcat-us/3.0.0/definitions/conceptscheme" + "$ref": "/dcat-us/3.0.0/definitions/conceptscheme", + "examples": [ + { + "@id": "https://example.gov/concept-schemes/science-domains", + "@type": "ConceptScheme", + "title": "Science Domains" + }, + { + "@id": "https://example.gov/concept-schemes/data-themes", + "@type": "ConceptScheme", + "version": "2.0", + "description": "DCAT-US approved themes for categorizing datasets", + "title": "Data Themes" + } + ] }, "notation": { "title": "notation", @@ -48,19 +85,54 @@ "type": "string" } } - ] + ], + "examples": [ [ "ENV", "E01", "ENVI" ] ] }, "prefLabel": { "title": "preferred label", "description": "Preferred label for the term", - "type": "string" + "type": "string", + "examples": [ "Environment", "Climate Science" ] } }, - "required": ["prefLabel"] + "required": [ "prefLabel" ] } ], "_oldDocs": { "rdfClass": "skos:Concept", "rationale": "The inclusion of skos:Concept in DCAT-US 3.0 enhances semantic search in catalogs, enabling more accurate discovery of Catalogs, Datasets, and Data Services. It improves user experience, promotes data discoverability, and supports better resource utilization. Additionally, it aligns with international standards like SKOS, ensuring compatibility and adherence to recognized controlled vocabulary practices." - } + }, + "examples": [ + "Environment", + "Climate Science", + { + "@type": "Concept", + "prefLabel": "Environment" + }, + { + "@type": "Concept", + "prefLabel": "Climate Science", + "definition": "The scientific study of climate patterns and change.", + "inScheme": { + "@id": "https://example.gov/concept-schemes/science-domains", + "@type": "ConceptScheme", + "title": "Science Domains" + } + }, + { + "@id": "https://example.gov/concepts/environment", + "@type": "Concept", + "prefLabel": "Environment", + "altLabel": "Ecology", + "definition": "The natural world, including air, water, land, plants, and animals, especially as affected by human activity.", + "notation": [ "ENV", "E01", "ENVI" ], + "inScheme": { + "@id": "https://example.gov/concept-schemes/data-themes", + "@type": "ConceptScheme", + "version": "2.0", + "description": "DCAT-US approved themes for categorizing datasets", + "title": "Data Themes" + } + } + ] } diff --git a/jsonschema/docs/identifiers-and-relationships.md b/jsonschema/docs/identifiers-and-relationships.md index b2effe65..49a7944f 100644 --- a/jsonschema/docs/identifiers-and-relationships.md +++ b/jsonschema/docs/identifiers-and-relationships.md @@ -369,6 +369,58 @@ A controlled term or label, optionally drawn from a concept scheme | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | +**Examples:** + +```json +"Environment" +``` + +```json +"Climate Science" +``` + +```json +{ + "@type": "Concept", + "prefLabel": "Environment" +} +``` + +```json +{ + "@type": "Concept", + "prefLabel": "Climate Science", + "definition": "The scientific study of climate patterns and change.", + "inScheme": { + "@id": "https://example.gov/concept-schemes/science-domains", + "@type": "ConceptScheme", + "title": "Science Domains" + } +} +``` + +```json +{ + "@id": "https://example.gov/concepts/environment", + "@type": "Concept", + "prefLabel": "Environment", + "altLabel": "Ecology", + "definition": "The natural world, including air, water, land, plants, and animals, especially as affected by human activity.", + "notation": [ + "ENV", + "E01", + "ENVI" + ], + "inScheme": { + "@id": "https://example.gov/concept-schemes/data-themes", + "@type": "ConceptScheme", + "version": "2.0", + "description": "DCAT-US approved themes for categorizing datasets", + "title": "Data Themes" + } +} +``` + | Any of | | -------------------- | | [Concept](#concept--anyOf_i0) | @@ -381,12 +433,44 @@ The value of the concept, expressed as a string. This is only used when the conc | **Type** | `string` | | -------- | -------- | +**Examples:** + +```json +"Environment" +``` + +```json +"Climate Science" +``` + ## `Concept > anyOf > item 1` | **Type** | `object` | | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | +**Examples:** + +```json +{ + "@type": "Concept", + "prefLabel": "Environment" +} +``` + +```json +{ + "@type": "Concept", + "prefLabel": "Climate Science", + "definition": "The scientific study of climate patterns and change.", + "inScheme": { + "@id": "https://example.gov/concept-schemes/science-domains", + "@type": "ConceptScheme", + "title": "Science Domains" + } +} +``` + | Property | Type | Requirement Level | Title/Description | | ----------------------------------- | ------------------ | ----------------- | -------------------------------------------------------------- | | [@id](#concept--anyOf_i1_@id) | string | Optional | | @@ -405,6 +489,12 @@ The value of the concept, expressed as a string. This is only used when the conc | ---------- | -------- | | **Format** | `iri` | +**Example:** + +```json +"https://example.gov/concepts/environment" +``` + ### `Concept > anyOf > item 1 > @type` **Requirement:** Optional @@ -424,6 +514,12 @@ Alternative label for a concept | **Type** | `null or string` | | -------- | ---------------- | +**Example:** + +```json +"Ecology" +``` + ### `Concept > anyOf > item 1 > definition` **Requirement:** Optional @@ -433,6 +529,16 @@ Definition of the controlled vocabulary term | **Type** | `null or string` | | -------- | ---------------- | +**Examples:** + +```json +"The scientific study of climate patterns and change." +``` + +```json +"The natural world, including air, water, land, plants, and animals, especially as affected by human activity." +``` + ### `Concept > anyOf > item 1 > inScheme` **Requirement:** Optional @@ -444,6 +550,26 @@ Concept scheme defining this concept | **Additional properties** | Any type allowed | | **Defined in** | [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) | +**Examples:** + +```json +{ + "@id": "https://example.gov/concept-schemes/science-domains", + "@type": "ConceptScheme", + "title": "Science Domains" +} +``` + +```json +{ + "@id": "https://example.gov/concept-schemes/data-themes", + "@type": "ConceptScheme", + "version": "2.0", + "description": "DCAT-US approved themes for categorizing datasets", + "title": "Data Themes" +} +``` + ### `Concept > anyOf > item 1 > notation` **Requirement:** Optional @@ -454,6 +580,16 @@ List of abbreviations or codes from code lists for the Concept | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | +**Example:** + +```json +[ + "ENV", + "E01", + "ENVI" +] +``` + | Any of | | ------------------------------------- | | [item 0](#concept--anyOf_i1_notation_anyOf_i0) | @@ -490,6 +626,16 @@ Preferred label for the term | ------------ | -------- | | **Required** | Yes | +**Examples:** + +```json +"Environment" +``` + +```json +"Climate Science" +``` + --- From ea7b02435a8599deb79f1432c08ef210f442030e Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 23:44:42 -0600 Subject: [PATCH 10/13] Update styling --- jsonschema/definitions/Concept.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/jsonschema/definitions/Concept.json b/jsonschema/definitions/Concept.json index 4ccfcba4..0b05ba2a 100644 --- a/jsonschema/definitions/Concept.json +++ b/jsonschema/definitions/Concept.json @@ -8,7 +8,7 @@ "type": "string", "title": "Concept", "description": "The value of the concept, expressed as a string. This is only used when the concept is not further described by the properties of the Concept object and is not linked to a concept scheme.", - "examples": [ "Environment", "Climate Science" ] + "examples": ["Environment", "Climate Science"] }, { "type": "object", @@ -32,7 +32,7 @@ "@id": { "type": "string", "format": "iri", - "examples": [ "https://example.gov/concepts/environment" ] + "examples": ["https://example.gov/concepts/environment"] }, "@type": { "type": "string", @@ -41,13 +41,13 @@ "altLabel": { "title": "alternate label", "description": "Alternative label for a concept", - "type": [ "null", "string" ], - "examples": [ "Ecology" ] + "type": ["null", "string"], + "examples": ["Ecology"] }, "definition": { "title": "definition", "description": "Definition of the controlled vocabulary term", - "type": [ "null", "string" ], + "type": ["null", "string"], "examples": [ "The scientific study of climate patterns and change.", "The natural world, including air, water, land, plants, and animals, especially as affected by human activity." @@ -86,16 +86,16 @@ } } ], - "examples": [ [ "ENV", "E01", "ENVI" ] ] + "examples": [["ENV", "E01", "ENVI"]] }, "prefLabel": { "title": "preferred label", "description": "Preferred label for the term", "type": "string", - "examples": [ "Environment", "Climate Science" ] + "examples": ["Environment", "Climate Science"] } }, - "required": [ "prefLabel" ] + "required": ["prefLabel"] } ], "_oldDocs": { @@ -125,7 +125,7 @@ "prefLabel": "Environment", "altLabel": "Ecology", "definition": "The natural world, including air, water, land, plants, and animals, especially as affected by human activity.", - "notation": [ "ENV", "E01", "ENVI" ], + "notation": ["ENV", "E01", "ENVI"], "inScheme": { "@id": "https://example.gov/concept-schemes/data-themes", "@type": "ConceptScheme", From 336ec8a17a0f56f48377af35c2c7a3b43bb657ce Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 23:48:16 -0600 Subject: [PATCH 11/13] Add anchor links for classes and fields Co-authored-by: Copilot --- jsonschema/docs/agents.md | 44 +-- jsonschema/docs/catalog.md | 122 +++---- .../docs/constraints-and-restrictions.md | 40 +-- jsonschema/docs/dataset-series.md | 72 ++--- jsonschema/docs/dataset.md | 236 +++++++------- jsonschema/docs/distribution.md | 158 ++++----- .../docs/identifiers-and-relationships.md | 126 ++++---- jsonschema/docs/quality-governance.md | 302 +++++++++--------- jsonschema/docs/temporal-spatial-metrics.md | 140 ++++---- jsonschema/generate_schema_docs.py | 36 ++- 10 files changed, 655 insertions(+), 621 deletions(-) diff --git a/jsonschema/docs/agents.md b/jsonschema/docs/agents.md index 9903cc6e..5d6d6c13 100644 --- a/jsonschema/docs/agents.md +++ b/jsonschema/docs/agents.md @@ -31,7 +31,7 @@ A person, organization, software agent, or other entity involved with a resource | [category](#agent--category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | The type of the agent that makes the item available | | [name](#agent--name) | string | Mandatory | The name of the agent | -## `Agent > @id` +## `Agent > @id` [#](#agent--@id) **Requirement:** Optional @@ -45,7 +45,7 @@ A person, organization, software agent, or other entity involved with a resource "https://example.gov/agents/data-steward-001" ``` -## `Agent > @type` +## `Agent > @type` [#](#agent--@type) **Requirement:** Optional @@ -53,7 +53,7 @@ A person, organization, software agent, or other entity involved with a resource | ----------- | --------- | | **Default** | `"Agent"` | -## `Agent > category` +## `Agent > category` [#](#agent--category) **Requirement:** Optional @@ -66,7 +66,7 @@ The type of the agent that makes the item available | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `Agent > name` +## `Agent > name` [#](#agent--name) **Requirement:** Mandatory @@ -139,7 +139,7 @@ An organization involved with a resource, including parent or child organization | [notation](#organization--notation) | null or array of string | Optional | List of abbreviations or codes from code lists for an organization (e.g. DOI, DOD) | | [prefLabel](#organization--prefLabel) | null or string | Optional | Preferred or legal name of the organization | -## `Organization > @id` +## `Organization > @id` [#](#organization--@id) **Requirement:** Optional @@ -153,7 +153,7 @@ An organization involved with a resource, including parent or child organization "https://example.gov/organizations/census-bureau" ``` -## `Organization > @type` +## `Organization > @type` [#](#organization--@type) **Requirement:** Optional @@ -161,7 +161,7 @@ An organization involved with a resource, including parent or child organization | ----------- | ---------------- | | **Default** | `"Organization"` | -## `Organization > name` +## `Organization > name` [#](#organization--name) **Requirement:** Mandatory @@ -181,7 +181,7 @@ The full name of the Organization "U.S. Census Bureau" ``` -## `Organization > subOrganizationOf` +## `Organization > subOrganizationOf` [#](#organization--subOrganizationOf) **Requirement:** Optional @@ -194,7 +194,7 @@ Represents hierarchical containment of Organizations or OrganizationalUnits; ind | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## `Organization > altLabel` +## `Organization > altLabel` [#](#organization--altLabel) **Title:** alternative label @@ -215,7 +215,7 @@ alternative name (trading name, colloquial name) for an organization "Census Bureau" ``` -## `Organization > notation` +## `Organization > notation` [#](#organization--notation) **Requirement:** Optional @@ -237,12 +237,12 @@ List of abbreviations or codes from code lists for an organization (e.g. DOI, DO | ------------------------------- | ----------- | | [Abbreviation](#organization--notation_items) | - | -### Abbreviation +### Abbreviation [#](#organization--notation_items) | **Type** | `string` | | -------- | -------- | -## `Organization > prefLabel` +## `Organization > prefLabel` [#](#organization--prefLabel) **Title:** preferred label @@ -304,7 +304,7 @@ Contact information for an individual or entity | [tel](#kind--tel) | null or string | Optional | The telephone number for the contact | | [title](#kind--title) | null or string | Optional | The position role of the person to contact | -## `Kind > @id` +## `Kind > @id` [#](#kind--@id) **Requirement:** Optional @@ -318,7 +318,7 @@ Contact information for an individual or entity "https://example.gov/contacts/climate-support-001" ``` -## `Kind > @type` +## `Kind > @type` [#](#kind--@type) **Requirement:** Optional @@ -326,7 +326,7 @@ Contact information for an individual or entity | ----------- | -------- | | **Default** | `"Kind"` | -## `Kind > address` +## `Kind > address` [#](#kind--address) **Requirement:** Optional @@ -339,7 +339,7 @@ The address of the contact | ------------------------------------------------ | ------------------------- | | [Address](./temporal-spatial-metrics.md#address) | A single physical address | -## `Kind > hasEmail` +## `Kind > hasEmail` [#](#kind--hasEmail) **Title:** Email @@ -365,7 +365,7 @@ Email address for the contact in mailto: format (for example, mailto:support@exa | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^mailto:[\w\_\~\!\$\&\'\(\)\*\+\,\;\=\:.-]+@[\w.-]+\.[\w.-]+?$``` [Test](https://regex101.com/?regex=%5Emailto%3A%5B%5Cw%5C_%5C~%5C%21%5C%24%5C%26%5C%27%5C%28%5C%29%5C%2A%5C%2B%5C%2C%5C%3B%5C%3D%5C%3A.-%5D%2B%40%5B%5Cw.-%5D%2B%5C.%5B%5Cw.-%5D%2B%3F%24&testString=%22mailto%3Aclimate-support%40example.gov%22) | -## `Kind > family-name` +## `Kind > family-name` [#](#kind--family-name) **Requirement:** Optional @@ -380,7 +380,7 @@ The family name of the contact "Smith" ``` -## `Kind > fn` +## `Kind > fn` [#](#kind--fn) **Title:** formatted name @@ -402,7 +402,7 @@ The formatted text of the name of the contact "Dr. Jane Smith" ``` -## `Kind > given-name` +## `Kind > given-name` [#](#kind--given-name) **Requirement:** Optional @@ -417,7 +417,7 @@ The given name of the contact "Jane" ``` -## `Kind > organization-name` +## `Kind > organization-name` [#](#kind--organization-name) **Requirement:** Optional @@ -432,7 +432,7 @@ The name of the organization to contact "National Climate Data Center" ``` -## `Kind > tel` +## `Kind > tel` [#](#kind--tel) **Title:** telephone @@ -449,7 +449,7 @@ The telephone number for the contact "+1-555-123-4567" ``` -## `Kind > title` +## `Kind > title` [#](#kind--title) **Title:** position title diff --git a/jsonschema/docs/catalog.md b/jsonschema/docs/catalog.md index f3ed3254..005df777 100644 --- a/jsonschema/docs/catalog.md +++ b/jsonschema/docs/catalog.md @@ -101,7 +101,7 @@ A curated collection of metadata about datasets, data services, or other resourc | [homepage](#homepage) | More than one type | Recommended | Main public web page for the catalog, usually an HTML page | | [qualifiedAttribution](#qualifiedAttribution) | null or array of [Attribution](./quality-governance.md#attribution) classes | Optional | List of agents with specific responsibilities for the catalog | -## `DCAT-US 3 Catalog > @id` +## `DCAT-US 3 Catalog > @id` [#](#@id) **Requirement:** Optional @@ -115,7 +115,7 @@ A curated collection of metadata about datasets, data services, or other resourc "https://example.gov/catalogs/federal-data-catalog" ``` -## `DCAT-US 3 Catalog > @type` +## `DCAT-US 3 Catalog > @type` [#](#@type) **Requirement:** Optional @@ -123,7 +123,7 @@ A curated collection of metadata about datasets, data services, or other resourc | ----------- | ----------- | | **Default** | `"Catalog"` | -## `DCAT-US 3 Catalog > catalog` +## `DCAT-US 3 Catalog > catalog` [#](#catalog) **Title:** Related catalogs @@ -138,7 +138,7 @@ List of related catalogs that are useful in the context of this catalog | ----------------------------------- | ---------------------------------------------------------------------------------- | | [DCAT-US 3 Catalog](#catalog_items) | A curated collection of metadata about datasets, data services, or other resources | -## `DCAT-US 3 Catalog > contactPoint` +## `DCAT-US 3 Catalog > contactPoint` [#](#contactPoint) **Title:** Contact points @@ -153,7 +153,7 @@ Contact information people can use to ask questions or send feedback about the c | ------------------------------- | ----------------------------------------------- | | [Kind](./agents.md#kind) | Contact information for an individual or entity | -## `DCAT-US 3 Catalog > dataset` +## `DCAT-US 3 Catalog > dataset` [#](#dataset) **Requirement:** Mandatory @@ -167,7 +167,7 @@ List of datasets included in the catalog. Use this together with service so the | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## `DCAT-US 3 Catalog > keyword` +## `DCAT-US 3 Catalog > keyword` [#](#keyword) **Title:** keyword/tag @@ -193,7 +193,7 @@ List of keywords or tags describing the catalog | ------------------------------- | ----------- | | [keyword items](#keyword_items) | - | -### Array Item +### Array Item [#](#keyword_items) | **Type** | `string` | | -------- | -------- | @@ -202,7 +202,7 @@ List of keywords or tags describing the catalog | -------------- | - | | **Min length** | 1 | -## `DCAT-US 3 Catalog > record` +## `DCAT-US 3 Catalog > record` [#](#record) **Title:** catalog record @@ -217,7 +217,7 @@ A catalog record describing how a single resource (such as a dataset or data ser | ------------------------------------------------------- | ----------------------------------------------------------------------- | | [CatalogRecord](./quality-governance.md#catalog-record) | A record in a catalog, describing the registration of a single resource | -## `DCAT-US 3 Catalog > service` +## `DCAT-US 3 Catalog > service` [#](#service) **Requirement:** Optional @@ -230,7 +230,7 @@ List of data services included in the catalog. Use this together with dataset so | --------------------------------------------------- | ------------------------------------------------------------------- | | [DataService](./quality-governance.md#data-service) | A service that provides access to data or data processing functions | -## `DCAT-US 3 Catalog > theme` +## `DCAT-US 3 Catalog > theme` [#](#theme) **Title:** theme/category @@ -245,7 +245,7 @@ List of themes or categories for the catalog. A catalog can have more than one t | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `DCAT-US 3 Catalog > themeTaxonomy` +## `DCAT-US 3 Catalog > themeTaxonomy` [#](#themeTaxonomy) **Title:** themes @@ -260,7 +260,7 @@ Controlled vocabulary or taxonomy used to classify catalog resources, such as da | ------------------------------------------------------------------ | --------------------------------------------------------------------- | | [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) | A controlled vocabulary or other list of approved terms for a concept | -## `DCAT-US 3 Catalog > accessRights` +## `DCAT-US 3 Catalog > accessRights` [#](#accessRights) **Requirement:** Optional @@ -281,19 +281,19 @@ Information about whether the catalog is publicly accessible, restricted, or not | [Null allowed when not required](#accessRights_anyOf_i0) | | [item 1](#accessRights_anyOf_i1) | -### `DCAT-US 3 Catalog > accessRights > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > accessRights > anyOf > Null allowed when not required` [#](#accessRights_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DCAT-US 3 Catalog > accessRights > anyOf > item 1` +### `DCAT-US 3 Catalog > accessRights > anyOf > item 1` [#](#accessRights_anyOf_i1) Text description of the access rights | **Type** | `string` | | -------- | -------- | -## `DCAT-US 3 Catalog > conformsTo` +## `DCAT-US 3 Catalog > conformsTo` [#](#conformsTo) **Title:** schema version @@ -310,12 +310,12 @@ Standard, schema, profile, or model that this catalog follows | [Null allowed when not required](#conformsTo_anyOf_i0) | | [Standard](#conformsTo_anyOf_i1) | -### `DCAT-US 3 Catalog > conformsTo > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > conformsTo > anyOf > Null allowed when not required` [#](#conformsTo_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DCAT-US 3 Catalog > conformsTo > anyOf > Standard` +### `DCAT-US 3 Catalog > conformsTo > anyOf > Standard` [#](#conformsTo_anyOf_i1) A standard or specification that another resource conforms to @@ -324,7 +324,7 @@ A standard or specification that another resource conforms to | **Additional properties** | Any type allowed | | **Same definition as** | [Standard](./quality-governance.md#standard) | -## `DCAT-US 3 Catalog > creator` +## `DCAT-US 3 Catalog > creator` [#](#creator) **Requirement:** Optional @@ -337,7 +337,7 @@ Person or organization responsible for creating the catalog metadata | ------------------------------- | -------------------------------------------------------------------------------- | | [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | -## `DCAT-US 3 Catalog > description` +## `DCAT-US 3 Catalog > description` [#](#description) **Requirement:** Optional @@ -356,7 +356,7 @@ Plain-language summary of the catalog "A comprehensive catalog of federal government data assets spanning multiple agencies and data domains." ``` -## `DCAT-US 3 Catalog > hasPart` +## `DCAT-US 3 Catalog > hasPart` [#](#hasPart) **Requirement:** Optional @@ -369,7 +369,7 @@ List of catalogs that are contained within this catalog | ----------------------------------- | ---------------------------------------------------------------------------------- | | [DCAT-US 3 Catalog](#hasPart_items) | A curated collection of metadata about datasets, data services, or other resources | -## `DCAT-US 3 Catalog > identifier` +## `DCAT-US 3 Catalog > identifier` [#](#identifier) **Requirement:** Optional @@ -384,12 +384,12 @@ Main unique identifier for the catalog, such as a URI or another persistent iden | [Null allowed when not required](#identifier_anyOf_i0) | | [Identifier](#identifier_anyOf_i1) | -### `DCAT-US 3 Catalog > identifier > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > identifier > anyOf > Null allowed when not required` [#](#identifier_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DCAT-US 3 Catalog > identifier > anyOf > Identifier` +### `DCAT-US 3 Catalog > identifier > anyOf > Identifier` [#](#identifier_anyOf_i1) inline description of Identifier @@ -398,7 +398,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | -## `DCAT-US 3 Catalog > otherIdentifier` +## `DCAT-US 3 Catalog > otherIdentifier` [#](#otherIdentifier) **Requirement:** Optional @@ -411,7 +411,7 @@ A list of identifiers for the Catalog besides the main identifier, e.g. the URI | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## `DCAT-US 3 Catalog > issued` +## `DCAT-US 3 Catalog > issued` [#](#issued) **Title:** release date @@ -446,12 +446,12 @@ Date when the catalog was formally issued, such as its initial publication date | [Null allowed when not required](#issued_anyOf_i0) | | [Date string](#issued_anyOf_i1) | -### `DCAT-US 3 Catalog > issued > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > issued > anyOf > Null allowed when not required` [#](#issued_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DCAT-US 3 Catalog > issued > anyOf > Date string` +### `DCAT-US 3 Catalog > issued > anyOf > Date string` [#](#issued_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -464,19 +464,19 @@ Date when the catalog was formally issued, such as its initial publication date | [item 2](#issued_anyOf_i1_anyOf_i2) | | [item 3](#issued_anyOf_i1_anyOf_i3) | -#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 0` +#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 0` [#](#issued_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 1` +#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 1` [#](#issued_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 2` +#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 2` [#](#issued_anyOf_i1_anyOf_i2) A year in YYYY format @@ -487,7 +487,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 3` +#### `DCAT-US 3 Catalog > issued > anyOf > Date string > anyOf > item 3` [#](#issued_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -498,7 +498,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `DCAT-US 3 Catalog > language` +## `DCAT-US 3 Catalog > language` [#](#language) **Requirement:** Recommended @@ -529,12 +529,12 @@ Language codes used for catalog metadata text (such as titles and descriptions), | [Language code](#language_anyOf_i1) | | [List of language codes](#language_anyOf_i2) | -### `DCAT-US 3 Catalog > language > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > language > anyOf > Null allowed when not required` [#](#language_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DCAT-US 3 Catalog > language > anyOf > Language code` +### `DCAT-US 3 Catalog > language > anyOf > Language code` [#](#language_anyOf_i1) | **Type** | `string` | | -------- | -------- | @@ -543,7 +543,7 @@ Language codes used for catalog metadata text (such as titles and descriptions), | -------------- | - | | **Max length** | 2 | -### `DCAT-US 3 Catalog > language > anyOf > List of language codes` +### `DCAT-US 3 Catalog > language > anyOf > List of language codes` [#](#language_anyOf_i2) | **Type** | array of string | | -------- | --------------- | @@ -552,7 +552,7 @@ Language codes used for catalog metadata text (such as titles and descriptions), | ----------------------------------------- | ----------- | | [Language code](#language_anyOf_i2_items) | - | -#### Language code +#### Language code [#](#language_anyOf_i2_items) | **Type** | `string` | | -------- | -------- | @@ -561,7 +561,7 @@ Language codes used for catalog metadata text (such as titles and descriptions), | -------------- | - | | **Max length** | 2 | -## `DCAT-US 3 Catalog > license` +## `DCAT-US 3 Catalog > license` [#](#license) **Requirement:** Optional @@ -582,19 +582,19 @@ License that governs how the catalog can be used or reused | [Null allowed when not required](#license_anyOf_i0) | | [item 1](#license_anyOf_i1) | -### `DCAT-US 3 Catalog > license > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > license > anyOf > Null allowed when not required` [#](#license_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DCAT-US 3 Catalog > license > anyOf > item 1` +### `DCAT-US 3 Catalog > license > anyOf > item 1` [#](#license_anyOf_i1) Full text of the license | **Type** | `string` | | -------- | -------- | -## `DCAT-US 3 Catalog > modified` +## `DCAT-US 3 Catalog > modified` [#](#modified) **Title:** update/modification date @@ -629,12 +629,12 @@ Most recent date when the catalog content changed, not just catalog-record metad | [Null allowed when not required](#modified_anyOf_i0) | | [Date string](#modified_anyOf_i1) | -### `DCAT-US 3 Catalog > modified > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > modified > anyOf > Null allowed when not required` [#](#modified_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DCAT-US 3 Catalog > modified > anyOf > Date string` +### `DCAT-US 3 Catalog > modified > anyOf > Date string` [#](#modified_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -647,19 +647,19 @@ Most recent date when the catalog content changed, not just catalog-record metad | [item 2](#modified_anyOf_i1_anyOf_i2) | | [item 3](#modified_anyOf_i1_anyOf_i3) | -#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 0` +#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 0` [#](#modified_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 1` +#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 1` [#](#modified_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 2` +#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 2` [#](#modified_anyOf_i1_anyOf_i2) A year in YYYY format @@ -670,7 +670,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 3` +#### `DCAT-US 3 Catalog > modified > anyOf > Date string > anyOf > item 3` [#](#modified_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -681,7 +681,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `DCAT-US 3 Catalog > publisher` +## `DCAT-US 3 Catalog > publisher` [#](#publisher) **Requirement:** Optional @@ -696,12 +696,12 @@ Person or organization responsible for publishing and making the catalog availab | [Null allowed when not required](#publisher_anyOf_i0) | | [Agent](#publisher_anyOf_i1) | -### `DCAT-US 3 Catalog > publisher > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > publisher > anyOf > Null allowed when not required` [#](#publisher_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DCAT-US 3 Catalog > publisher > anyOf > Agent` +### `DCAT-US 3 Catalog > publisher > anyOf > Agent` [#](#publisher_anyOf_i1) inline description of the publisher @@ -710,7 +710,7 @@ inline description of the publisher | **Additional properties** | Any type allowed | | **Same definition as** | [Agent](./agents.md#agent) | -## `DCAT-US 3 Catalog > rights` +## `DCAT-US 3 Catalog > rights` [#](#rights) **Requirement:** Recommended @@ -738,14 +738,14 @@ Rights statements about the catalog that are not already covered by license or a | ------------------------------- | ---------------------------------- | | [rights items](#rights_items) | Full text of a statement of rights | -### Array Item +### Array Item [#](#rights_items) Full text of a statement of rights | **Type** | `string` | | -------- | -------- | -## `DCAT-US 3 Catalog > rightsHolder` +## `DCAT-US 3 Catalog > rightsHolder` [#](#rightsHolder) **Requirement:** Optional @@ -758,7 +758,7 @@ Organizations that hold rights in the catalog | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## `DCAT-US 3 Catalog > spatial` +## `DCAT-US 3 Catalog > spatial` [#](#spatial) **Title:** spatial/geographic coverage @@ -773,7 +773,7 @@ Geographic area covered by the catalog | -------------------------------------------------- | -------------------------------- | | [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | -## `DCAT-US 3 Catalog > subject` +## `DCAT-US 3 Catalog > subject` [#](#subject) **Requirement:** Optional @@ -786,7 +786,7 @@ List of subjects of the catalog | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `DCAT-US 3 Catalog > temporal` +## `DCAT-US 3 Catalog > temporal` [#](#temporal) **Title:** temporal coverage @@ -801,7 +801,7 @@ Time periods covered by the catalog | ------------------------------------------------------------ | ---------------------------------------------------------------------- | | [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | -## `DCAT-US 3 Catalog > title` +## `DCAT-US 3 Catalog > title` [#](#title) **Requirement:** Optional @@ -820,7 +820,7 @@ Human-readable title of the catalog "Federal Data Catalog" ``` -## `DCAT-US 3 Catalog > category` +## `DCAT-US 3 Catalog > category` [#](#category) **Requirement:** Optional @@ -833,7 +833,7 @@ List of high-level categories for the catalog | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `DCAT-US 3 Catalog > homepage` +## `DCAT-US 3 Catalog > homepage` [#](#homepage) **Requirement:** Recommended @@ -848,12 +848,12 @@ Main public web page for the catalog, usually an HTML page | [Null allowed when not required](#homepage_anyOf_i0) | | [Document](#homepage_anyOf_i1) | -### `DCAT-US 3 Catalog > homepage > anyOf > Null allowed when not required` +### `DCAT-US 3 Catalog > homepage > anyOf > Null allowed when not required` [#](#homepage_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DCAT-US 3 Catalog > homepage > anyOf > Document` +### `DCAT-US 3 Catalog > homepage > anyOf > Document` [#](#homepage_anyOf_i1) inline description of the home page @@ -862,7 +862,7 @@ inline description of the home page | **Additional properties** | Any type allowed | | **Same definition as** | [Document](./quality-governance.md#document) | -## `DCAT-US 3 Catalog > qualifiedAttribution` +## `DCAT-US 3 Catalog > qualifiedAttribution` [#](#qualifiedAttribution) **Requirement:** Optional diff --git a/jsonschema/docs/constraints-and-restrictions.md b/jsonschema/docs/constraints-and-restrictions.md index 65871a09..0680670d 100644 --- a/jsonschema/docs/constraints-and-restrictions.md +++ b/jsonschema/docs/constraints-and-restrictions.md @@ -31,7 +31,7 @@ Rules or indicators that describe who can access a resource | [restrictionStatus](#access-restriction--restrictionStatus) | object | Mandatory | The indication of whether or not there are access restrictions on the item, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/access-restriction-status | | [specificRestriction](#access-restriction--specificRestriction) | More than one type | Recommended | Authority, code list entry, or policy reference that defines the specific access restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-access-restriction | -## `AccessRestriction > @id` +## `AccessRestriction > @id` [#](#access-restriction--@id) **Requirement:** Optional @@ -39,7 +39,7 @@ Rules or indicators that describe who can access a resource | ---------- | -------- | | **Format** | `iri` | -## `AccessRestriction > @type` +## `AccessRestriction > @type` [#](#access-restriction--@type) **Requirement:** Optional @@ -47,7 +47,7 @@ Rules or indicators that describe who can access a resource | ----------- | --------------------- | | **Default** | `"AccessRestriction"` | -## `AccessRestriction > restrictionNote` +## `AccessRestriction > restrictionNote` [#](#access-restriction--restrictionNote) **Requirement:** Optional @@ -62,7 +62,7 @@ A note related to the access restriction "Access restricted to authorized personnel only." ``` -## `AccessRestriction > restrictionStatus` +## `AccessRestriction > restrictionStatus` [#](#access-restriction--restrictionStatus) **Requirement:** Mandatory @@ -84,7 +84,7 @@ The indication of whether or not there are access restrictions on the item, cons "Unrestricted" ``` -## `AccessRestriction > specificRestriction` +## `AccessRestriction > specificRestriction` [#](#access-restriction--specificRestriction) **Requirement:** Recommended @@ -109,12 +109,12 @@ Authority, code list entry, or policy reference that defines the specific access | [Null allowed when not required](#access-restriction--specificRestriction_anyOf_i0) | | [Concept](#access-restriction--specificRestriction_anyOf_i1) | -### `AccessRestriction > specificRestriction > anyOf > Null allowed when not required` +### `AccessRestriction > specificRestriction > anyOf > Null allowed when not required` [#](#access-restriction--specificRestriction_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `AccessRestriction > specificRestriction > anyOf > Concept` +### `AccessRestriction > specificRestriction > anyOf > Concept` [#](#access-restriction--specificRestriction_anyOf_i1) inline description of the specific restriction @@ -153,7 +153,7 @@ Information describing Controlled Unclassified Information (CUI) restrictions fo | [designationIndicator](#cui-restriction--designationIndicator) | string | Mandatory | Agency that designated the information as CUI; include at least "Controlled by:" and, when possible, contact information | | [requiredIndicatorPerAuthority](#cui-restriction--requiredIndicatorPerAuthority) | null or array of string | Optional | List of free-text required indicators from the applicable authority (for example, category descriptions or distribution statements) | -## `CUIRestriction > @id` +## `CUIRestriction > @id` [#](#cui-restriction--@id) **Requirement:** Optional @@ -167,7 +167,7 @@ Information describing Controlled Unclassified Information (CUI) restrictions fo "https://example.gov/cui-restrictions/dataset-001" ``` -## `CUIRestriction > @type` +## `CUIRestriction > @type` [#](#cui-restriction--@type) **Requirement:** Optional @@ -175,7 +175,7 @@ Information describing Controlled Unclassified Information (CUI) restrictions fo | ----------- | ------------------ | | **Default** | `"CUIRestriction"` | -## `CUIRestriction > cuiBannerMarking` +## `CUIRestriction > cuiBannerMarking` [#](#cui-restriction--cuiBannerMarking) **Requirement:** Mandatory @@ -195,7 +195,7 @@ CUI (Controlled Unclassified Information) banner marking is required for any unc "CUI//SP-PRVCY//SP-LEGAL" ``` -## `CUIRestriction > designationIndicator` +## `CUIRestriction > designationIndicator` [#](#cui-restriction--designationIndicator) **Title:** CUI designation indicator @@ -217,7 +217,7 @@ Agency that designated the information as CUI; include at least "Controlled by:" "Controlled by: DOC; POC: Jane Smith, mailto:jane.smith@example.gov, XXX-XXX-XXXX" ``` -## `CUIRestriction > requiredIndicatorPerAuthority` +## `CUIRestriction > requiredIndicatorPerAuthority` [#](#cui-restriction--requiredIndicatorPerAuthority) **Requirement:** Optional @@ -239,7 +239,7 @@ List of free-text required indicators from the applicable authority (for example | -------------------------------------------------------- | ----------- | | [Indicator string](#cui-restriction--requiredIndicatorPerAuthority_items) | - | -### Indicator string +### Indicator string [#](#cui-restriction--requiredIndicatorPerAuthority_items) | **Type** | `string` | | -------- | -------- | @@ -275,7 +275,7 @@ Rules or legal limits on how a resource may be used | [restrictionStatus](#use-restriction--restrictionStatus) | object | Mandatory | Indication of whether or not there are use restrictions on the archival materials, consider using a controlled vocabulary such as https://www.archives.gov/research/catalog/lcdrg/authority-lists/use-restriction-status | | [specificRestriction](#use-restriction--specificRestriction) | More than one type | Recommended | Authority, code list entry, or policy reference that defines the specific use restriction; consider using a controlled vocabulary such as the NARA https://www.archives.gov/research/catalog/lcdrg/authority-lists/specific-use-restriction | -## `UseRestriction > @id` +## `UseRestriction > @id` [#](#use-restriction--@id) **Requirement:** Optional @@ -289,7 +289,7 @@ Rules or legal limits on how a resource may be used "https://example.gov/restrictions/use-restriction-001" ``` -## `UseRestriction > @type` +## `UseRestriction > @type` [#](#use-restriction--@type) **Requirement:** Optional @@ -297,7 +297,7 @@ Rules or legal limits on how a resource may be used | ----------- | ------------------ | | **Default** | `"UseRestriction"` | -## `UseRestriction > restrictionNote` +## `UseRestriction > restrictionNote` [#](#use-restriction--restrictionNote) **Requirement:** Optional @@ -316,7 +316,7 @@ Significant information pertaining to the use or reproduction of the data "This data may be used for research purposes. Commercial use requires written permission from the data steward." ``` -## `UseRestriction > restrictionStatus` +## `UseRestriction > restrictionStatus` [#](#use-restriction--restrictionStatus) **Requirement:** Mandatory @@ -338,7 +338,7 @@ Indication of whether or not there are use restrictions on the archival material "Unrestricted" ``` -## `UseRestriction > specificRestriction` +## `UseRestriction > specificRestriction` [#](#use-restriction--specificRestriction) **Requirement:** Recommended @@ -363,12 +363,12 @@ Authority, code list entry, or policy reference that defines the specific use re | [Null allowed when not required](#use-restriction--specificRestriction_anyOf_i0) | | [Concept](#use-restriction--specificRestriction_anyOf_i1) | -### `UseRestriction > specificRestriction > anyOf > Null allowed when not required` +### `UseRestriction > specificRestriction > anyOf > Null allowed when not required` [#](#use-restriction--specificRestriction_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `UseRestriction > specificRestriction > anyOf > Concept` +### `UseRestriction > specificRestriction > anyOf > Concept` [#](#use-restriction--specificRestriction_anyOf_i1) inline description of the specific restriction diff --git a/jsonschema/docs/dataset-series.md b/jsonschema/docs/dataset-series.md index ae90bfa7..c4e3dd2c 100644 --- a/jsonschema/docs/dataset-series.md +++ b/jsonschema/docs/dataset-series.md @@ -158,7 +158,7 @@ A group of related datasets that are published separately | [temporal](#temporal) | null or array of [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) classes | Recommended | Time periods covered by the dataset series | | [title](#title) | string | Mandatory | Human-readable title of the dataset series | -## `DatasetSeries > @id` +## `DatasetSeries > @id` [#](#@id) **Requirement:** Optional @@ -172,7 +172,7 @@ A group of related datasets that are published separately "https://example.gov/series/annual-climate-observations" ``` -## `DatasetSeries > @type` +## `DatasetSeries > @type` [#](#@type) **Requirement:** Optional @@ -180,7 +180,7 @@ A group of related datasets that are published separately | ----------- | ----------------- | | **Default** | `"DatasetSeries"` | -## `DatasetSeries > contactPoint` +## `DatasetSeries > contactPoint` [#](#contactPoint) **Requirement:** Recommended @@ -193,7 +193,7 @@ List of contacts people can use to ask questions or send feedback about the data | ------------------------------- | ----------------------------------------------- | | [Kind](./agents.md#kind) | Contact information for an individual or entity | -## `DatasetSeries > first` +## `DatasetSeries > first` [#](#first) **Requirement:** Recommended @@ -208,12 +208,12 @@ The first dataset in an ordered dataset series | [Null allowed when not required](#first_anyOf_i0) | | [Dataset](#first_anyOf_i1) | -### `DatasetSeries > first > anyOf > Null allowed when not required` +### `DatasetSeries > first > anyOf > Null allowed when not required` [#](#first_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DatasetSeries > first > anyOf > Dataset` +### `DatasetSeries > first > anyOf > Dataset` [#](#first_anyOf_i1) inline description of the first dataset @@ -225,7 +225,7 @@ inline description of the first dataset --- **See Also:** (related supporting classes) -## `DatasetSeries > last` +## `DatasetSeries > last` [#](#last) **Requirement:** Recommended @@ -240,12 +240,12 @@ The last dataset in an ordered dataset series | [Null allowed when not required](#last_anyOf_i0) | | [Dataset](#last_anyOf_i1) | -### `DatasetSeries > last > anyOf > Null allowed when not required` +### `DatasetSeries > last > anyOf > Null allowed when not required` [#](#last_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DatasetSeries > last > anyOf > Dataset` +### `DatasetSeries > last > anyOf > Dataset` [#](#last_anyOf_i1) inline description of the last dataset @@ -257,7 +257,7 @@ inline description of the last dataset --- **See Also:** (related supporting classes) -## `DatasetSeries > seriesMember` +## `DatasetSeries > seriesMember` [#](#seriesMember) **Requirement:** Recommended @@ -270,7 +270,7 @@ List of members of the Dataset Series | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## `DatasetSeries > accrualPeriodicity` +## `DatasetSeries > accrualPeriodicity` [#](#accrualPeriodicity) **Title:** frequency @@ -295,12 +295,12 @@ The frequency at which the Dataset Series is updated. This is the series update | [item 2](#accrualPeriodicity_anyOf_i2) | | [item 3](#accrualPeriodicity_anyOf_i3) | -### `DatasetSeries > accrualPeriodicity > anyOf > Null allowed when not required` +### `DatasetSeries > accrualPeriodicity > anyOf > Null allowed when not required` [#](#accrualPeriodicity_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DatasetSeries > accrualPeriodicity > anyOf > item 1` +### `DatasetSeries > accrualPeriodicity > anyOf > item 1` [#](#accrualPeriodicity_anyOf_i1) ISO 19115 Maintenance Frequency code @@ -321,7 +321,7 @@ Must be one of: * "notPlanned" * "unknown" -### `DatasetSeries > accrualPeriodicity > anyOf > item 2` +### `DatasetSeries > accrualPeriodicity > anyOf > item 2` [#](#accrualPeriodicity_anyOf_i2) ISO-8601 Maintenance Frequency code for recurring values, see https://www.iso.org/standard/70907.html @@ -332,7 +332,7 @@ ISO-8601 Maintenance Frequency code for recurring values, see https://www.iso.or | --------------------------------- | ----------------------------------------------------------------- | | **Must match regular expression** | ```^R/P.+$``` [Test](https://regex101.com/?regex=%5ER%2FP.%2B%24) | -### `DatasetSeries > accrualPeriodicity > anyOf > item 3` +### `DatasetSeries > accrualPeriodicity > anyOf > item 3` [#](#accrualPeriodicity_anyOf_i3) Dublin Core Collection Frequency Vocabulary, see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/#vocabulary-terms @@ -358,7 +358,7 @@ Must be one of: * "semiweekly" * "threeTimesAWeek" -## `DatasetSeries > description` +## `DatasetSeries > description` [#](#description) **Requirement:** Mandatory @@ -374,7 +374,7 @@ Plain-language summary of the dataset series "An annual series of comprehensive climate observation datasets collected from monitoring stations across the United States. Each dataset in the series covers one calendar year of daily observations." ``` -## `DatasetSeries > issued` +## `DatasetSeries > issued` [#](#issued) **Title:** release date @@ -409,12 +409,12 @@ Date when the Dataset Series was formally established or published, not the rele | [Null allowed when not required](#issued_anyOf_i0) | | [Date string](#issued_anyOf_i1) | -### `DatasetSeries > issued > anyOf > Null allowed when not required` +### `DatasetSeries > issued > anyOf > Null allowed when not required` [#](#issued_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DatasetSeries > issued > anyOf > Date string` +### `DatasetSeries > issued > anyOf > Date string` [#](#issued_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -427,19 +427,19 @@ Date when the Dataset Series was formally established or published, not the rele | [item 2](#issued_anyOf_i1_anyOf_i2) | | [item 3](#issued_anyOf_i1_anyOf_i3) | -#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 0` +#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 0` [#](#issued_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 1` +#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 1` [#](#issued_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 2` +#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 2` [#](#issued_anyOf_i1_anyOf_i2) A year in YYYY format @@ -450,7 +450,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 3` +#### `DatasetSeries > issued > anyOf > Date string > anyOf > item 3` [#](#issued_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -461,7 +461,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `DatasetSeries > modified` +## `DatasetSeries > modified` [#](#modified) **Title:** update/modification date @@ -500,12 +500,12 @@ Most recent date when the Dataset Series changed, not the modified date of the n | [Null allowed when not required](#modified_anyOf_i0) | | [Date string](#modified_anyOf_i1) | -### `DatasetSeries > modified > anyOf > Null allowed when not required` +### `DatasetSeries > modified > anyOf > Null allowed when not required` [#](#modified_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DatasetSeries > modified > anyOf > Date string` +### `DatasetSeries > modified > anyOf > Date string` [#](#modified_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -518,19 +518,19 @@ Most recent date when the Dataset Series changed, not the modified date of the n | [item 2](#modified_anyOf_i1_anyOf_i2) | | [item 3](#modified_anyOf_i1_anyOf_i3) | -#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 0` +#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 0` [#](#modified_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 1` +#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 1` [#](#modified_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 2` +#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 2` [#](#modified_anyOf_i1_anyOf_i2) A year in YYYY format @@ -541,7 +541,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 3` +#### `DatasetSeries > modified > anyOf > Date string > anyOf > item 3` [#](#modified_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -552,7 +552,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `DatasetSeries > publisher` +## `DatasetSeries > publisher` [#](#publisher) **Requirement:** Recommended @@ -567,12 +567,12 @@ Organization responsible for maintaining the Dataset Series as a coherent series | [Null allowed when not required](#publisher_anyOf_i0) | | [Agent](#publisher_anyOf_i1) | -### `DatasetSeries > publisher > anyOf > Null allowed when not required` +### `DatasetSeries > publisher > anyOf > Null allowed when not required` [#](#publisher_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DatasetSeries > publisher > anyOf > Agent` +### `DatasetSeries > publisher > anyOf > Agent` [#](#publisher_anyOf_i1) inline description of publisher @@ -581,7 +581,7 @@ inline description of publisher | **Additional properties** | Any type allowed | | **Same definition as** | [Agent](./agents.md#agent) | -## `DatasetSeries > spatial` +## `DatasetSeries > spatial` [#](#spatial) **Title:** spatial/geographic coverage @@ -596,7 +596,7 @@ A geographic region that is covered by the Dataset Series | -------------------------------------------------- | -------------------------------- | | [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | -## `DatasetSeries > temporal` +## `DatasetSeries > temporal` [#](#temporal) **Title:** temporal coverage @@ -611,7 +611,7 @@ Time periods covered by the dataset series | ------------------------------------------------------------ | ---------------------------------------------------------------------- | | [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | -## `DatasetSeries > title` +## `DatasetSeries > title` [#](#title) **Requirement:** Mandatory diff --git a/jsonschema/docs/dataset.md b/jsonschema/docs/dataset.md index d4a6e8fe..31fd2072 100644 --- a/jsonschema/docs/dataset.md +++ b/jsonschema/docs/dataset.md @@ -158,7 +158,7 @@ A collection of data published or curated by one provider | [image](#image) | More than one type | Optional | Thumbnail image illustrating the dataset, especially useful for visual data such as maps, photos, or video | | [scopeNote](#scopeNote) | null or string | Optional | usage note for the dataset | -## `Dataset > @id` +## `Dataset > @id` [#](#@id) **Requirement:** Optional @@ -172,7 +172,7 @@ A collection of data published or curated by one provider "https://example.gov/datasets/national-climate-observations-2024" ``` -## `Dataset > @type` +## `Dataset > @type` [#](#@type) **Requirement:** Optional @@ -180,7 +180,7 @@ A collection of data published or curated by one provider | ----------- | ----------- | | **Default** | `"Dataset"` | -## `Dataset > otherIdentifier` +## `Dataset > otherIdentifier` [#](#otherIdentifier) **Requirement:** Optional @@ -193,7 +193,7 @@ Additional identifiers for the dataset besides the main identifier, such as a DO | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## `Dataset > sample` +## `Dataset > sample` [#](#sample) **Requirement:** Optional @@ -206,7 +206,7 @@ List of sample distributions for the dataset | -------------------------------------- | ----------------------------------------------------------------------------- | | [Distribution](./distribution.md#root) | A specific representation of a dataset, such as a file, feed, or API response | -## `Dataset > status` +## `Dataset > status` [#](#status) **Title:** lifecycle status @@ -223,12 +223,12 @@ Lifecycle status of the dataset, such as completed, deprecated, under developmen | [Null allowed when not required](#status_anyOf_i0) | | [Concept](#status_anyOf_i1) | -### `Dataset > status > anyOf > Null allowed when not required` +### `Dataset > status > anyOf > Null allowed when not required` [#](#status_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > status > anyOf > Concept` +### `Dataset > status > anyOf > Concept` [#](#status_anyOf_i1) inline description of Concept @@ -237,7 +237,7 @@ inline description of Concept | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | -## `Dataset > supportedSchema` +## `Dataset > supportedSchema` [#](#supportedSchema) **Requirement:** Optional @@ -252,12 +252,12 @@ supported schema for this dataset | [Null allowed when not required](#supportedSchema_anyOf_i0) | | [Dataset](#supportedSchema_anyOf_i1) | -### `Dataset > supportedSchema > anyOf > Null allowed when not required` +### `Dataset > supportedSchema > anyOf > Null allowed when not required` [#](#supportedSchema_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > supportedSchema > anyOf > Dataset` +### `Dataset > supportedSchema > anyOf > Dataset` [#](#supportedSchema_anyOf_i1) inline description of the supported schema @@ -269,7 +269,7 @@ inline description of the supported schema --- **See Also:** (related supporting classes) -## `Dataset > versionNotes` +## `Dataset > versionNotes` [#](#versionNotes) **Requirement:** Optional @@ -284,7 +284,7 @@ Notes describing how this version differs from earlier versions of the dataset "Initial release of 2024 climate observations data." ``` -## `Dataset > contactPoint` +## `Dataset > contactPoint` [#](#contactPoint) **Requirement:** Mandatory @@ -300,7 +300,7 @@ A contact point for questions about the Dataset (single contact or list). Includ | [Kind](#contactPoint_anyOf_i0) | | [List of contacts](#contactPoint_anyOf_i1) | -### `Dataset > contactPoint > anyOf > Kind` +### `Dataset > contactPoint > anyOf > Kind` [#](#contactPoint_anyOf_i0) inline description of Kind @@ -309,7 +309,7 @@ inline description of Kind | **Additional properties** | Any type allowed | | **Same definition as** | [Kind](./agents.md#kind) | -### `Dataset > contactPoint > anyOf > List of contacts` +### `Dataset > contactPoint > anyOf > List of contacts` [#](#contactPoint_anyOf_i1) | **Type** | array of [Kind](./agents.md#kind) classes | | -------- | ----------------------------------------- | @@ -318,7 +318,7 @@ inline description of Kind | ------------------------------- | ----------------------------------------------- | | [Kind](./agents.md#kind) | Contact information for an individual or entity | -## `Dataset > distribution` +## `Dataset > distribution` [#](#distribution) **Title:** dataset distribution @@ -333,7 +333,7 @@ List of available distributions for the dataset. This can be omitted when no dis | -------------------------------------- | ----------------------------------------------------------------------------- | | [Distribution](./distribution.md#root) | A specific representation of a dataset, such as a file, feed, or API response | -## `Dataset > first` +## `Dataset > first` [#](#first) **Requirement:** Optional @@ -348,12 +348,12 @@ the first item of the sequence the dataset belongs to | [Null allowed when not required](#first_anyOf_i0) | | [Dataset](#first_anyOf_i1) | -### `Dataset > first > anyOf > Null allowed when not required` +### `Dataset > first > anyOf > Null allowed when not required` [#](#first_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > first > anyOf > Dataset` +### `Dataset > first > anyOf > Dataset` [#](#first_anyOf_i1) inline description of Dataset @@ -365,7 +365,7 @@ inline description of Dataset --- **See Also:** (related supporting classes) -## `Dataset > hasCurrentVersion` +## `Dataset > hasCurrentVersion` [#](#hasCurrentVersion) **Title:** current version @@ -382,12 +382,12 @@ reference to the current (latest) version of a dataset | [Null allowed when not required](#hasCurrentVersion_anyOf_i0) | | [Dataset](#hasCurrentVersion_anyOf_i1) | -### `Dataset > hasCurrentVersion > anyOf > Null allowed when not required` +### `Dataset > hasCurrentVersion > anyOf > Null allowed when not required` [#](#hasCurrentVersion_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > hasCurrentVersion > anyOf > Dataset` +### `Dataset > hasCurrentVersion > anyOf > Dataset` [#](#hasCurrentVersion_anyOf_i1) inline description of Dataset @@ -399,7 +399,7 @@ inline description of Dataset --- **See Also:** (related supporting classes) -## `Dataset > hasVersion` +## `Dataset > hasVersion` [#](#hasVersion) **Requirement:** Optional @@ -412,7 +412,7 @@ List of related Datasets that are a version, edition, or adaptation of the descr | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## `Dataset > inSeries` +## `Dataset > inSeries` [#](#inSeries) **Requirement:** Optional @@ -425,7 +425,7 @@ Dataset series this dataset belongs to | ----------------------------------------- | --------------------------------------------------------- | | [DatasetSeries](./dataset-series.md#root) | A group of related datasets that are published separately | -## `Dataset > keyword` +## `Dataset > keyword` [#](#keyword) **Title:** keyword/tag @@ -463,7 +463,7 @@ List of keywords or tags describing the dataset | ---------------------------------- | ----------- | | [Non-empty string](#keyword_items) | - | -### Non-empty string +### Non-empty string [#](#keyword_items) | **Type** | `string` | | -------- | -------- | @@ -472,7 +472,7 @@ List of keywords or tags describing the dataset | -------------- | - | | **Min length** | 1 | -## `Dataset > landingPage` +## `Dataset > landingPage` [#](#landingPage) **Requirement:** Recommended @@ -487,12 +487,12 @@ A web page from the original data provider that gives access to the Dataset, its | [Null allowed when not required](#landingPage_anyOf_i0) | | [Document](#landingPage_anyOf_i1) | -### `Dataset > landingPage > anyOf > Null allowed when not required` +### `Dataset > landingPage > anyOf > Null allowed when not required` [#](#landingPage_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > landingPage > anyOf > Document` +### `Dataset > landingPage > anyOf > Document` [#](#landingPage_anyOf_i1) inline description of Document @@ -501,7 +501,7 @@ inline description of Document | **Additional properties** | Any type allowed | | **Same definition as** | [Document](./quality-governance.md#document) | -## `Dataset > previousVersion` +## `Dataset > previousVersion` [#](#previousVersion) **Requirement:** Optional @@ -516,12 +516,12 @@ reference to the previous dataset version | [Null allowed when not required](#previousVersion_anyOf_i0) | | [Dataset](#previousVersion_anyOf_i1) | -### `Dataset > previousVersion > anyOf > Null allowed when not required` +### `Dataset > previousVersion > anyOf > Null allowed when not required` [#](#previousVersion_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > previousVersion > anyOf > Dataset` +### `Dataset > previousVersion > anyOf > Dataset` [#](#previousVersion_anyOf_i1) inline description of Dataset @@ -533,7 +533,7 @@ inline description of Dataset --- **See Also:** (related supporting classes) -## `Dataset > qualifiedRelation` +## `Dataset > qualifiedRelation` [#](#qualifiedRelation) **Requirement:** Optional @@ -546,7 +546,7 @@ Detailed relationship between the dataset and another resource, including the ro | --------------------------------------------------------------- | ------------------------------------------------------------------- | | [Relationship](./identifiers-and-relationships.md#relationship) | Additional information about how one resource is related to another | -## `Dataset > spatialResolutionInMeters` +## `Dataset > spatialResolutionInMeters` [#](#spatialResolutionInMeters) **Title:** Spatial resolution (meters) @@ -563,7 +563,7 @@ Smallest spatial distance between data points, in meters, represented as a singl "1000" ``` -## `Dataset > temporalResolution` +## `Dataset > temporalResolution` [#](#temporalResolution) **Requirement:** Optional @@ -578,7 +578,7 @@ Smallest time interval between data points, using xsd:duration format (for examp "P1D" ``` -## `Dataset > theme` +## `Dataset > theme` [#](#theme) **Title:** theme/category @@ -593,7 +593,7 @@ List of themes or categories for the dataset | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `Dataset > version` +## `Dataset > version` [#](#version) **Requirement:** Optional @@ -608,7 +608,7 @@ The version indicator (name or identifier) of a resource "2024.1" ``` -## `Dataset > describedBy` +## `Dataset > describedBy` [#](#describedBy) **Title:** data dictionary @@ -625,12 +625,12 @@ A distribution describing the Data Dictionary for this dataset | [Null allowed when not required](#describedBy_anyOf_i0) | | [Distribution](#describedBy_anyOf_i1) | -### `Dataset > describedBy > anyOf > Null allowed when not required` +### `Dataset > describedBy > anyOf > Null allowed when not required` [#](#describedBy_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > describedBy > anyOf > Distribution` +### `Dataset > describedBy > anyOf > Distribution` [#](#describedBy_anyOf_i1) inline description of Distribution @@ -642,7 +642,7 @@ inline description of Distribution --- **See Also:** (related supporting classes) -## `Dataset > liabilityStatement` +## `Dataset > liabilityStatement` [#](#liabilityStatement) **Requirement:** Optional @@ -663,19 +663,19 @@ A liability statement about the dataset that may clarify limitations of responsi | [Null allowed when not required](#liabilityStatement_anyOf_i0) | | [item 1](#liabilityStatement_anyOf_i1) | -### `Dataset > liabilityStatement > anyOf > Null allowed when not required` +### `Dataset > liabilityStatement > anyOf > Null allowed when not required` [#](#liabilityStatement_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > liabilityStatement > anyOf > item 1` +### `Dataset > liabilityStatement > anyOf > item 1` [#](#liabilityStatement_anyOf_i1) Full text of the liability statement | **Type** | `string` | | -------- | -------- | -## `Dataset > metadataDistribution` +## `Dataset > metadataDistribution` [#](#metadataDistribution) **Requirement:** Optional @@ -688,7 +688,7 @@ Distribution of the original metadata document this dataset was derived from | -------------------------------------- | ----------------------------------------------------------------------------- | | [Distribution](./distribution.md#root) | A specific representation of a dataset, such as a file, feed, or API response | -## `Dataset > purpose` +## `Dataset > purpose` [#](#purpose) **Requirement:** Optional @@ -703,7 +703,7 @@ The purpose of the dataset "To provide comprehensive, high-quality climate observations for research, planning, and decision-making related to weather and climate." ``` -## `Dataset > accessRights` +## `Dataset > accessRights` [#](#accessRights) **Requirement:** Optional @@ -728,19 +728,19 @@ Information about whether the dataset is publicly accessible, restricted, or not | [Null allowed when not required](#accessRights_anyOf_i0) | | [item 1](#accessRights_anyOf_i1) | -### `Dataset > accessRights > anyOf > Null allowed when not required` +### `Dataset > accessRights > anyOf > Null allowed when not required` [#](#accessRights_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > accessRights > anyOf > item 1` +### `Dataset > accessRights > anyOf > item 1` [#](#accessRights_anyOf_i1) Text description of the access rights | **Type** | `string` | | -------- | -------- | -## `Dataset > accrualPeriodicity` +## `Dataset > accrualPeriodicity` [#](#accrualPeriodicity) **Title:** frequency @@ -765,12 +765,12 @@ The frequency at which the Dataset is updated | [item 2](#accrualPeriodicity_anyOf_i2) | | [item 3](#accrualPeriodicity_anyOf_i3) | -### `Dataset > accrualPeriodicity > anyOf > Null allowed when not required` +### `Dataset > accrualPeriodicity > anyOf > Null allowed when not required` [#](#accrualPeriodicity_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > accrualPeriodicity > anyOf > item 1` +### `Dataset > accrualPeriodicity > anyOf > item 1` [#](#accrualPeriodicity_anyOf_i1) ISO 19115 Maintenance Frequency code @@ -791,7 +791,7 @@ Must be one of: * "notPlanned" * "unknown" -### `Dataset > accrualPeriodicity > anyOf > item 2` +### `Dataset > accrualPeriodicity > anyOf > item 2` [#](#accrualPeriodicity_anyOf_i2) ISO-8601 Maintenance Frequency code for recurring values, see https://www.iso.org/standard/70907.html @@ -802,7 +802,7 @@ ISO-8601 Maintenance Frequency code for recurring values, see https://www.iso.or | --------------------------------- | ----------------------------------------------------------------- | | **Must match regular expression** | ```^R/P.+$``` [Test](https://regex101.com/?regex=%5ER%2FP.%2B%24) | -### `Dataset > accrualPeriodicity > anyOf > item 3` +### `Dataset > accrualPeriodicity > anyOf > item 3` [#](#accrualPeriodicity_anyOf_i3) Dublin Core Collection Frequency Vocabulary, see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/#vocabulary-terms @@ -828,7 +828,7 @@ Must be one of: * "semiweekly" * "threeTimesAWeek" -## `Dataset > conformsTo` +## `Dataset > conformsTo` [#](#conformsTo) **Requirement:** Optional @@ -841,7 +841,7 @@ List of standards, schemas, or profiles the dataset follows | -------------------------------------------- | ------------------------------------------------------------- | | [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | -## `Dataset > contributor` +## `Dataset > contributor` [#](#contributor) **Requirement:** Optional @@ -854,7 +854,7 @@ List of agents contributing to the Dataset | ------------------------------- | -------------------------------------------------------------------------------- | | [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | -## `Dataset > created` +## `Dataset > created` [#](#created) **Title:** creation date @@ -889,12 +889,12 @@ The date on which the Dataset was first created | [Null allowed when not required](#created_anyOf_i0) | | [Date string](#created_anyOf_i1) | -### `Dataset > created > anyOf > Null allowed when not required` +### `Dataset > created > anyOf > Null allowed when not required` [#](#created_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > created > anyOf > Date string` +### `Dataset > created > anyOf > Date string` [#](#created_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -907,19 +907,19 @@ The date on which the Dataset was first created | [item 2](#created_anyOf_i1_anyOf_i2) | | [item 3](#created_anyOf_i1_anyOf_i3) | -#### `Dataset > created > anyOf > Date string > anyOf > item 0` +#### `Dataset > created > anyOf > Date string > anyOf > item 0` [#](#created_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `Dataset > created > anyOf > Date string > anyOf > item 1` +#### `Dataset > created > anyOf > Date string > anyOf > item 1` [#](#created_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `Dataset > created > anyOf > Date string > anyOf > item 2` +#### `Dataset > created > anyOf > Date string > anyOf > item 2` [#](#created_anyOf_i1_anyOf_i2) A year in YYYY format @@ -930,7 +930,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `Dataset > created > anyOf > Date string > anyOf > item 3` +#### `Dataset > created > anyOf > Date string > anyOf > item 3` [#](#created_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -941,7 +941,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `Dataset > creator` +## `Dataset > creator` [#](#creator) **Requirement:** Optional @@ -956,12 +956,12 @@ Person or organization responsible for creating the dataset | [Null allowed when not required](#creator_anyOf_i0) | | [Agent](#creator_anyOf_i1) | -### `Dataset > creator > anyOf > Null allowed when not required` +### `Dataset > creator > anyOf > Null allowed when not required` [#](#creator_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > creator > anyOf > Agent` +### `Dataset > creator > anyOf > Agent` [#](#creator_anyOf_i1) inline description of Agent @@ -970,7 +970,7 @@ inline description of Agent | **Additional properties** | Any type allowed | | **Same definition as** | [Agent](./agents.md#agent) | -## `Dataset > description` +## `Dataset > description` [#](#description) **Requirement:** Mandatory @@ -990,7 +990,7 @@ Plain-language summary of the dataset "Comprehensive daily climate observations collected from monitoring stations across the United States, including temperature, precipitation, humidity, and wind measurements." ``` -## `Dataset > hasPart` +## `Dataset > hasPart` [#](#hasPart) **Requirement:** Optional @@ -1003,7 +1003,7 @@ List of related datasets that are part of the described dataset | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## `Dataset > identifier` +## `Dataset > identifier` [#](#identifier) **Requirement:** Mandatory @@ -1019,12 +1019,12 @@ The unique identifier for the Dataset, e.g. the URI or other unique identifier i | [Null allowed when not required](#identifier_anyOf_i0) | | [Identifier](#identifier_anyOf_i1) | -### `Dataset > identifier > anyOf > Null allowed when not required` +### `Dataset > identifier > anyOf > Null allowed when not required` [#](#identifier_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > identifier > anyOf > Identifier` +### `Dataset > identifier > anyOf > Identifier` [#](#identifier_anyOf_i1) inline description of Identifier @@ -1033,7 +1033,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | -## `Dataset > isReferencedBy` +## `Dataset > isReferencedBy` [#](#isReferencedBy) **Requirement:** Optional @@ -1054,7 +1054,7 @@ List of links to related resources, such as publications, that reference, cite, | ------------------------------- | ------------------------- | | [Link](#isReferencedBy_items) | reference iri of Resource | -### Link +### Link [#](#isReferencedBy_items) reference iri of Resource @@ -1062,7 +1062,7 @@ reference iri of Resource | ---------- | -------- | | **Format** | `iri` | -## `Dataset > issued` +## `Dataset > issued` [#](#issued) **Title:** release date @@ -1097,12 +1097,12 @@ Date when the dataset was first published. If the exact publication date is unkn | [Null allowed when not required](#issued_anyOf_i0) | | [Date string](#issued_anyOf_i1) | -### `Dataset > issued > anyOf > Null allowed when not required` +### `Dataset > issued > anyOf > Null allowed when not required` [#](#issued_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > issued > anyOf > Date string` +### `Dataset > issued > anyOf > Date string` [#](#issued_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -1115,19 +1115,19 @@ Date when the dataset was first published. If the exact publication date is unkn | [item 2](#issued_anyOf_i1_anyOf_i2) | | [item 3](#issued_anyOf_i1_anyOf_i3) | -#### `Dataset > issued > anyOf > Date string > anyOf > item 0` +#### `Dataset > issued > anyOf > Date string > anyOf > item 0` [#](#issued_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `Dataset > issued > anyOf > Date string > anyOf > item 1` +#### `Dataset > issued > anyOf > Date string > anyOf > item 1` [#](#issued_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `Dataset > issued > anyOf > Date string > anyOf > item 2` +#### `Dataset > issued > anyOf > Date string > anyOf > item 2` [#](#issued_anyOf_i1_anyOf_i2) A year in YYYY format @@ -1138,7 +1138,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `Dataset > issued > anyOf > Date string > anyOf > item 3` +#### `Dataset > issued > anyOf > Date string > anyOf > item 3` [#](#issued_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -1149,7 +1149,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `Dataset > language` +## `Dataset > language` [#](#language) **Requirement:** Optional @@ -1173,12 +1173,12 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en | [Language code](#language_anyOf_i1) | | [List of languages](#language_anyOf_i2) | -### `Dataset > language > anyOf > Null allowed when not required` +### `Dataset > language > anyOf > Null allowed when not required` [#](#language_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > language > anyOf > Language code` +### `Dataset > language > anyOf > Language code` [#](#language_anyOf_i1) | **Type** | `string` | | -------- | -------- | @@ -1187,7 +1187,7 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en | -------------- | - | | **Max length** | 2 | -### `Dataset > language > anyOf > List of languages` +### `Dataset > language > anyOf > List of languages` [#](#language_anyOf_i2) | **Type** | array of string | | -------- | --------------- | @@ -1196,7 +1196,7 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en | ----------------------------------------- | ----------- | | [Language code](#language_anyOf_i2_items) | - | -#### Language code +#### Language code [#](#language_anyOf_i2_items) | **Type** | `string` | | -------- | -------- | @@ -1205,7 +1205,7 @@ ISO 639-1 language code values used in the dataset text or metadata, such as en | -------------- | - | | **Max length** | 2 | -## `Dataset > modified` +## `Dataset > modified` [#](#modified) **Title:** last modified @@ -1240,12 +1240,12 @@ Most recent date when the dataset's actual data changed, not just metadata | [Null allowed when not required](#modified_anyOf_i0) | | [Date string](#modified_anyOf_i1) | -### `Dataset > modified > anyOf > Null allowed when not required` +### `Dataset > modified > anyOf > Null allowed when not required` [#](#modified_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > modified > anyOf > Date string` +### `Dataset > modified > anyOf > Date string` [#](#modified_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -1258,19 +1258,19 @@ Most recent date when the dataset's actual data changed, not just metadata | [item 2](#modified_anyOf_i1_anyOf_i2) | | [item 3](#modified_anyOf_i1_anyOf_i3) | -#### `Dataset > modified > anyOf > Date string > anyOf > item 0` +#### `Dataset > modified > anyOf > Date string > anyOf > item 0` [#](#modified_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `Dataset > modified > anyOf > Date string > anyOf > item 1` +#### `Dataset > modified > anyOf > Date string > anyOf > item 1` [#](#modified_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `Dataset > modified > anyOf > Date string > anyOf > item 2` +#### `Dataset > modified > anyOf > Date string > anyOf > item 2` [#](#modified_anyOf_i1_anyOf_i2) A year in YYYY format @@ -1281,7 +1281,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `Dataset > modified > anyOf > Date string > anyOf > item 3` +#### `Dataset > modified > anyOf > Date string > anyOf > item 3` [#](#modified_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -1292,7 +1292,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `Dataset > provenance` +## `Dataset > provenance` [#](#provenance) **Requirement:** Optional @@ -1314,14 +1314,14 @@ List of statements about the lineage of a Dataset, including any changes in its | ------------------------------------- | ------------------------------------- | | [provenance items](#provenance_items) | Full text of the provenance statement | -### Array Item +### Array Item [#](#provenance_items) Full text of the provenance statement | **Type** | `string` | | -------- | -------- | -## `Dataset > publisher` +## `Dataset > publisher` [#](#publisher) **Requirement:** Mandatory @@ -1333,7 +1333,7 @@ Organization responsible for publishing and making the dataset available | **Additional properties** | Any type allowed | | **Defined in** | [Organization](./agents.md#organization) | -## `Dataset > relation` +## `Dataset > relation` [#](#relation) **Title:** related resource @@ -1356,7 +1356,7 @@ List of links to related resources when the relationship is not otherwise specif | ------------------------------- | ------------------------- | | [Link](#relation_items) | reference iri of Resource | -### Link +### Link [#](#relation_items) reference iri of Resource @@ -1364,7 +1364,7 @@ reference iri of Resource | ---------- | -------- | | **Format** | `iri` | -## `Dataset > replaces` +## `Dataset > replaces` [#](#replaces) **Requirement:** Optional @@ -1377,7 +1377,7 @@ List of Datasets replaced by this Dataset | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## `Dataset > rights` +## `Dataset > rights` [#](#rights) **Requirement:** Recommended @@ -1404,14 +1404,14 @@ Rights statements not already covered by license or accessRights, such as copyri | ------------------------------- | ---------------------------------- | | [rights items](#rights_items) | Full text of a statement of rights | -### Array Item +### Array Item [#](#rights_items) Full text of a statement of rights | **Type** | `string` | | -------- | -------- | -## `Dataset > rightsHolder` +## `Dataset > rightsHolder` [#](#rightsHolder) **Requirement:** Optional @@ -1424,7 +1424,7 @@ List of agents (organizations) holding rights on the Dataset | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## `Dataset > source` +## `Dataset > source` [#](#source) **Title:** data source @@ -1439,7 +1439,7 @@ List of related Datasets from which the described Dataset is derived | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## `Dataset > spatial` +## `Dataset > spatial` [#](#spatial) **Title:** spatial/geographic coverage @@ -1457,12 +1457,12 @@ A geographic region or regions that are covered by the Dataset | [Location](#spatial_anyOf_i1) | | [List of geographic regions](#spatial_anyOf_i2) | -### `Dataset > spatial > anyOf > Null allowed when not required` +### `Dataset > spatial > anyOf > Null allowed when not required` [#](#spatial_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > spatial > anyOf > Location` +### `Dataset > spatial > anyOf > Location` [#](#spatial_anyOf_i1) inline description of Location @@ -1471,7 +1471,7 @@ inline description of Location | **Additional properties** | Any type allowed | | **Same definition as** | [Location](./temporal-spatial-metrics.md#location) | -### `Dataset > spatial > anyOf > List of geographic regions` +### `Dataset > spatial > anyOf > List of geographic regions` [#](#spatial_anyOf_i2) | **Type** | array of [Location](./temporal-spatial-metrics.md#location) classes | | -------- | ------------------------------------------------------------------- | @@ -1480,7 +1480,7 @@ inline description of Location | -------------------------------------------------- | -------------------------------- | | [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | -## `Dataset > subject` +## `Dataset > subject` [#](#subject) **Requirement:** Optional @@ -1493,7 +1493,7 @@ List of primary subjects for the dataset, usually narrower than broad theme cate | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `Dataset > temporal` +## `Dataset > temporal` [#](#temporal) **Title:** temporal coverage @@ -1508,7 +1508,7 @@ Time periods covered by the dataset | ------------------------------------------------------------ | ---------------------------------------------------------------------- | | [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | -## `Dataset > title` +## `Dataset > title` [#](#title) **Requirement:** Mandatory @@ -1528,7 +1528,7 @@ Human-readable title of the dataset "National Climate Observations 2024" ``` -## `Dataset > category` +## `Dataset > category` [#](#category) **Requirement:** Optional @@ -1541,7 +1541,7 @@ List of high-level categories for the dataset | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `Dataset > hasQualityMeasurement` +## `Dataset > hasQualityMeasurement` [#](#hasQualityMeasurement) **Title:** quality measurement @@ -1556,7 +1556,7 @@ List of quality measurements for the dataset (for example, completeness, accurac | ----------------------------------------------------------------------- | ------------------------------------------------------------- | | [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) | A measurement of a resource against a specific quality metric | -## `Dataset > page` +## `Dataset > page` [#](#page) **Title:** documentation @@ -1571,7 +1571,7 @@ List of pages or documents about this dataset | -------------------------------------------- | ----------------------------------------------------- | | [Document](./quality-governance.md#document) | A publication or other document related to a resource | -## `Dataset > qualifiedAttribution` +## `Dataset > qualifiedAttribution` [#](#qualifiedAttribution) **Requirement:** Optional @@ -1584,7 +1584,7 @@ List of agents with specific responsibilities for the dataset | -------------------------------------------------- | ------------------------------------------------- | | [Attribution](./quality-governance.md#attribution) | A responsibility that an agent has for a resource | -## `Dataset > wasAttributedTo` +## `Dataset > wasAttributedTo` [#](#wasAttributedTo) **Title:** attribution @@ -1599,7 +1599,7 @@ List of agents attributed to this dataset | ------------------------------- | -------------------------------------------------------------------------------- | | [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | -## `Dataset > wasGeneratedBy` +## `Dataset > wasGeneratedBy` [#](#wasGeneratedBy) **Requirement:** Optional @@ -1612,7 +1612,7 @@ List of activities that generated, or provide the business context for the creat | -------------------------------------------------- | -------------------------------------------------------------- | | [Activity](./temporal-spatial-metrics.md#activity) | An activity related to creating, changing, or using a resource | -## `Dataset > wasUsedBy` +## `Dataset > wasUsedBy` [#](#wasUsedBy) **Title:** used by @@ -1627,7 +1627,7 @@ List of activities that used the Dataset | -------------------------------------------------- | -------------------------------------------------------------- | | [Activity](./temporal-spatial-metrics.md#activity) | An activity related to creating, changing, or using a resource | -## `Dataset > image` +## `Dataset > image` [#](#image) **Requirement:** Optional @@ -1642,12 +1642,12 @@ Thumbnail image illustrating the dataset, especially useful for visual data such | [Null allowed when not required](#image_anyOf_i0) | | [Link](#image_anyOf_i1) | -### `Dataset > image > anyOf > Null allowed when not required` +### `Dataset > image > anyOf > Null allowed when not required` [#](#image_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Dataset > image > anyOf > Link` +### `Dataset > image > anyOf > Link` [#](#image_anyOf_i1) The link to the image @@ -1655,7 +1655,7 @@ The link to the image | ---------- | -------- | | **Format** | `iri` | -## `Dataset > scopeNote` +## `Dataset > scopeNote` [#](#scopeNote) **Title:** usage note diff --git a/jsonschema/docs/distribution.md b/jsonschema/docs/distribution.md index 500da883..2cda7b37 100644 --- a/jsonschema/docs/distribution.md +++ b/jsonschema/docs/distribution.md @@ -74,7 +74,7 @@ A specific representation of a dataset, such as a file, feed, or API response | [image](#image) | More than one type | Optional | A link to a thumbnail picture illustrating the content of the distribution | | [checksum](#checksum) | More than one type | Optional | Checksum used to verify that the downloadable file content has not changed | -## `Distribution > @id` +## `Distribution > @id` [#](#@id) **Requirement:** Optional @@ -88,7 +88,7 @@ A specific representation of a dataset, such as a file, feed, or API response "https://example.gov/distributions/climate-data-csv-001" ``` -## `Distribution > @type` +## `Distribution > @type` [#](#@type) **Requirement:** Optional @@ -96,7 +96,7 @@ A specific representation of a dataset, such as a file, feed, or API response | ----------- | ---------------- | | **Default** | `"Distribution"` | -## `Distribution > representationTechnique` +## `Distribution > representationTechnique` [#](#representationTechnique) **Requirement:** Optional @@ -111,12 +111,12 @@ Method or schema used to structure the distribution content (for example, CSV co | [Null allowed when not required](#representationTechnique_anyOf_i0) | | [Concept](#representationTechnique_anyOf_i1) | -### `Distribution > representationTechnique > anyOf > Null allowed when not required` +### `Distribution > representationTechnique > anyOf > Null allowed when not required` [#](#representationTechnique_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > representationTechnique > anyOf > Concept` +### `Distribution > representationTechnique > anyOf > Concept` [#](#representationTechnique_anyOf_i1) inline description of Concept @@ -125,7 +125,7 @@ inline description of Concept | **Additional properties** | Any type allowed | | **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | -## `Distribution > status` +## `Distribution > status` [#](#status) **Title:** lifecycle status @@ -142,12 +142,12 @@ The status of the distribution in the context of maturity lifecycle | [Null allowed when not required](#status_anyOf_i0) | | [Concept](#status_anyOf_i1) | -### `Distribution > status > anyOf > Null allowed when not required` +### `Distribution > status > anyOf > Null allowed when not required` [#](#status_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > status > anyOf > Concept` +### `Distribution > status > anyOf > Concept` [#](#status_anyOf_i1) inline description of Concept @@ -156,7 +156,7 @@ inline description of Concept | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | -## `Distribution > characterEncoding` +## `Distribution > characterEncoding` [#](#characterEncoding) **Requirement:** Optional @@ -179,12 +179,12 @@ List of character encodings used in the Distribution, using IANA character set n | [Null allowed when not required](#characterEncoding_anyOf_i0) | | [List of encodings](#characterEncoding_anyOf_i1) | -### `Distribution > characterEncoding > anyOf > Null allowed when not required` +### `Distribution > characterEncoding > anyOf > Null allowed when not required` [#](#characterEncoding_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > characterEncoding > anyOf > List of encodings` +### `Distribution > characterEncoding > anyOf > List of encodings` [#](#characterEncoding_anyOf_i1) | **Type** | array of string | | -------- | --------------- | @@ -193,12 +193,12 @@ List of character encodings used in the Distribution, using IANA character set n | ------------------------------------------------------- | ----------- | | [Character encoding](#characterEncoding_anyOf_i1_items) | - | -#### Character encoding +#### Character encoding [#](#characterEncoding_anyOf_i1_items) | **Type** | `string` | | -------- | -------- | -## `Distribution > accessService` +## `Distribution > accessService` [#](#accessService) **Requirement:** Optional @@ -211,7 +211,7 @@ A data service that gives access to the distribution of the dataset | --------------------------------------------------- | ------------------------------------------------------------------- | | [DataService](./quality-governance.md#data-service) | A service that provides access to data or data processing functions | -## `Distribution > accessURL` +## `Distribution > accessURL` [#](#accessURL) **Requirement:** Recommended @@ -236,12 +236,12 @@ URL for indirect access to the Distribution (for example, a landing page, API do | [Null allowed when not required](#accessURL_anyOf_i0) | | [URL](#accessURL_anyOf_i1) | -### `Distribution > accessURL > anyOf > Null allowed when not required` +### `Distribution > accessURL > anyOf > Null allowed when not required` [#](#accessURL_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > accessURL > anyOf > URL` +### `Distribution > accessURL > anyOf > URL` [#](#accessURL_anyOf_i1) reference iri of Resource @@ -249,7 +249,7 @@ reference iri of Resource | ---------- | -------- | | **Format** | `iri` | -## `Distribution > byteSize` +## `Distribution > byteSize` [#](#byteSize) **Requirement:** Optional @@ -264,7 +264,7 @@ The size of a Distribution in bytes "52428800" ``` -## `Distribution > compressFormat` +## `Distribution > compressFormat` [#](#compressFormat) **Title:** compression format @@ -281,7 +281,7 @@ The format of the file in which the data is contained in a compressed form, e.g. "application/gzip" ``` -## `Distribution > downloadURL` +## `Distribution > downloadURL` [#](#downloadURL) **Requirement:** Optional @@ -302,12 +302,12 @@ Direct URL to a downloadable file for the Distribution; use accessURL for indire | [Null allowed when not required](#downloadURL_anyOf_i0) | | [URL](#downloadURL_anyOf_i1) | -### `Distribution > downloadURL > anyOf > Null allowed when not required` +### `Distribution > downloadURL > anyOf > Null allowed when not required` [#](#downloadURL_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > downloadURL > anyOf > URL` +### `Distribution > downloadURL > anyOf > URL` [#](#downloadURL_anyOf_i1) reference iri of Resource @@ -315,7 +315,7 @@ reference iri of Resource | ---------- | -------- | | **Format** | `iri` | -## `Distribution > mediaType` +## `Distribution > mediaType` [#](#mediaType) **Requirement:** Optional @@ -330,7 +330,7 @@ MIME type of the Distribution (for example, text/csv or application/json), from "text/csv" ``` -## `Distribution > packageFormat` +## `Distribution > packageFormat` [#](#packageFormat) **Title:** packaging format @@ -347,7 +347,7 @@ The format of the file in which one or more data files are grouped together, e.g "application/zip" ``` -## `Distribution > spatialResolutionInMeters` +## `Distribution > spatialResolutionInMeters` [#](#spatialResolutionInMeters) **Title:** Spatial resolution (meters) @@ -364,7 +364,7 @@ The minimum spatial separation resolvable in a dataset distribution, measured in "1000" ``` -## `Distribution > temporalResolution` +## `Distribution > temporalResolution` [#](#temporalResolution) **Title:** termporal resolution @@ -381,7 +381,7 @@ The minimum time period resolvable in the dataset distribution "P1D" ``` -## `Distribution > availability` +## `Distribution > availability` [#](#availability) **Requirement:** Optional @@ -396,12 +396,12 @@ An indication how long it is planned to keep the Distribution of the Dataset ava | [Null allowed when not required](#availability_anyOf_i0) | | [Concept](#availability_anyOf_i1) | -### `Distribution > availability > anyOf > Null allowed when not required` +### `Distribution > availability > anyOf > Null allowed when not required` [#](#availability_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > availability > anyOf > Concept` +### `Distribution > availability > anyOf > Concept` [#](#availability_anyOf_i1) inline description of Concept @@ -410,7 +410,7 @@ inline description of Concept | **Additional properties** | Any type allowed | | **Same definition as** | [Concept](./identifiers-and-relationships.md#concept) | -## `Distribution > accessRestriction` +## `Distribution > accessRestriction` [#](#accessRestriction) **Requirement:** Recommended @@ -423,7 +423,7 @@ List of access restrictions related to the distribution | ------------------------------------------------------------------------- | ----------------------------------------------------------- | | [AccessRestriction](./constraints-and-restrictions.md#access-restriction) | Rules or indicators that describe who can access a resource | -## `Distribution > cuiRestriction` +## `Distribution > cuiRestriction` [#](#cuiRestriction) **Requirement:** Recommended @@ -438,12 +438,12 @@ Controlled Unclassified Information restriction related to the distribution | [Null allowed when not required](#cuiRestriction_anyOf_i0) | | [CUIRestriction](#cuiRestriction_anyOf_i1) | -### `Distribution > cuiRestriction > anyOf > Null allowed when not required` +### `Distribution > cuiRestriction > anyOf > Null allowed when not required` [#](#cuiRestriction_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > cuiRestriction > anyOf > CUIRestriction` +### `Distribution > cuiRestriction > anyOf > CUIRestriction` [#](#cuiRestriction_anyOf_i1) inline description of CUIRestriction @@ -452,7 +452,7 @@ inline description of CUIRestriction | **Additional properties** | Any type allowed | | **Same definition as** | [CUIRestriction](./constraints-and-restrictions.md#cui-restriction) | -## `Distribution > describedBy` +## `Distribution > describedBy` [#](#describedBy) **Title:** data dictionary @@ -469,12 +469,12 @@ A distribution containing the Data Dictionary for this distribution | [Null allowed when not required](#describedBy_anyOf_i0) | | [Distribution](#describedBy_anyOf_i1) | -### `Distribution > describedBy > anyOf > Null allowed when not required` +### `Distribution > describedBy > anyOf > Null allowed when not required` [#](#describedBy_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > describedBy > anyOf > Distribution` +### `Distribution > describedBy > anyOf > Distribution` [#](#describedBy_anyOf_i1) inline description of the data dictionary @@ -486,7 +486,7 @@ inline description of the data dictionary --- **See Also:** (related supporting classes) -## `Distribution > useRestriction` +## `Distribution > useRestriction` [#](#useRestriction) **Requirement:** Recommended @@ -499,7 +499,7 @@ Use restriction related to the distribution | ------------------------------------------------------------------- | --------------------------------------------------- | | [UseRestriction](./constraints-and-restrictions.md#use-restriction) | Rules or legal limits on how a resource may be used | -## `Distribution > accessRights` +## `Distribution > accessRights` [#](#accessRights) **Requirement:** Optional @@ -520,19 +520,19 @@ Information about whether the distribution is publicly accessible, restricted, o | [Null allowed when not required](#accessRights_anyOf_i0) | | [item 1](#accessRights_anyOf_i1) | -### `Distribution > accessRights > anyOf > Null allowed when not required` +### `Distribution > accessRights > anyOf > Null allowed when not required` [#](#accessRights_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > accessRights > anyOf > item 1` +### `Distribution > accessRights > anyOf > item 1` [#](#accessRights_anyOf_i1) Text description of the access rights | **Type** | `string` | | -------- | -------- | -## `Distribution > conformsTo` +## `Distribution > conformsTo` [#](#conformsTo) **Title:** linked schemas @@ -547,7 +547,7 @@ List of standards, schemas, or reference systems the Distribution follows (prefe | -------------------------------------------- | ------------------------------------------------------------- | | [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | -## `Distribution > description` +## `Distribution > description` [#](#description) **Requirement:** Recommended @@ -566,7 +566,7 @@ Plain-language summary of the distribution "A CSV file containing historical climate data including daily temperature and precipitation readings." ``` -## `Distribution > format` +## `Distribution > format` [#](#format) **Requirement:** Recommended @@ -581,7 +581,7 @@ A human-readable description of the file format of the Distribution that provide "CSV" ``` -## `Distribution > identifier` +## `Distribution > identifier` [#](#identifier) **Requirement:** Optional @@ -596,12 +596,12 @@ The unique identifier for the Distribution (e.g. DOI, ISBN) | [Null allowed when not required](#identifier_anyOf_i0) | | [Identifier](#identifier_anyOf_i1) | -### `Distribution > identifier > anyOf > Null allowed when not required` +### `Distribution > identifier > anyOf > Null allowed when not required` [#](#identifier_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > identifier > anyOf > Identifier` +### `Distribution > identifier > anyOf > Identifier` [#](#identifier_anyOf_i1) inline description of Identifier @@ -610,7 +610,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | -## `Distribution > otherIdentifier` +## `Distribution > otherIdentifier` [#](#otherIdentifier) **Requirement:** Optional @@ -623,7 +623,7 @@ A list of identifiers for the Distribution besides the main identifier, e.g. the | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## `Distribution > issued` +## `Distribution > issued` [#](#issued) **Title:** release date @@ -658,12 +658,12 @@ The date of formal issuance (e.g., publication) of the Distribution | [Null allowed when not required](#issued_anyOf_i0) | | [Date string](#issued_anyOf_i1) | -### `Distribution > issued > anyOf > Null allowed when not required` +### `Distribution > issued > anyOf > Null allowed when not required` [#](#issued_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > issued > anyOf > Date string` +### `Distribution > issued > anyOf > Date string` [#](#issued_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -676,19 +676,19 @@ The date of formal issuance (e.g., publication) of the Distribution | [item 2](#issued_anyOf_i1_anyOf_i2) | | [item 3](#issued_anyOf_i1_anyOf_i3) | -#### `Distribution > issued > anyOf > Date string > anyOf > item 0` +#### `Distribution > issued > anyOf > Date string > anyOf > item 0` [#](#issued_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `Distribution > issued > anyOf > Date string > anyOf > item 1` +#### `Distribution > issued > anyOf > Date string > anyOf > item 1` [#](#issued_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `Distribution > issued > anyOf > Date string > anyOf > item 2` +#### `Distribution > issued > anyOf > Date string > anyOf > item 2` [#](#issued_anyOf_i1_anyOf_i2) A year in YYYY format @@ -699,7 +699,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `Distribution > issued > anyOf > Date string > anyOf > item 3` +#### `Distribution > issued > anyOf > Date string > anyOf > item 3` [#](#issued_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -710,7 +710,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `Distribution > language` +## `Distribution > language` [#](#language) **Requirement:** Optional @@ -739,12 +739,12 @@ ISO 639-1 language code values used in the distribution metadata text, such as e | [Language code](#language_anyOf_i1) | | [List of languages](#language_anyOf_i2) | -### `Distribution > language > anyOf > Null allowed when not required` +### `Distribution > language > anyOf > Null allowed when not required` [#](#language_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > language > anyOf > Language code` +### `Distribution > language > anyOf > Language code` [#](#language_anyOf_i1) | **Type** | `string` | | -------- | -------- | @@ -753,7 +753,7 @@ ISO 639-1 language code values used in the distribution metadata text, such as e | -------------- | - | | **Max length** | 2 | -### `Distribution > language > anyOf > List of languages` +### `Distribution > language > anyOf > List of languages` [#](#language_anyOf_i2) | **Type** | array of string | | -------- | --------------- | @@ -762,7 +762,7 @@ ISO 639-1 language code values used in the distribution metadata text, such as e | ----------------------------------------- | ----------- | | [Language code](#language_anyOf_i2_items) | - | -#### Language code +#### Language code [#](#language_anyOf_i2_items) | **Type** | `string` | | -------- | -------- | @@ -771,7 +771,7 @@ ISO 639-1 language code values used in the distribution metadata text, such as e | -------------- | - | | **Max length** | 2 | -## `Distribution > license` +## `Distribution > license` [#](#license) **Requirement:** Recommended @@ -792,19 +792,19 @@ License that governs how the distribution can be used or reused | [Null allowed when not required](#license_anyOf_i0) | | [item 1](#license_anyOf_i1) | -### `Distribution > license > anyOf > Null allowed when not required` +### `Distribution > license > anyOf > Null allowed when not required` [#](#license_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > license > anyOf > item 1` +### `Distribution > license > anyOf > item 1` [#](#license_anyOf_i1) Full text of the license | **Type** | `string` | | -------- | -------- | -## `Distribution > modified` +## `Distribution > modified` [#](#modified) **Title:** last modified @@ -843,12 +843,12 @@ The most recent date on which the Distribution was changed or modified | [Null allowed when not required](#modified_anyOf_i0) | | [Date string](#modified_anyOf_i1) | -### `Distribution > modified > anyOf > Null allowed when not required` +### `Distribution > modified > anyOf > Null allowed when not required` [#](#modified_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > modified > anyOf > Date string` +### `Distribution > modified > anyOf > Date string` [#](#modified_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -861,19 +861,19 @@ The most recent date on which the Distribution was changed or modified | [item 2](#modified_anyOf_i1_anyOf_i2) | | [item 3](#modified_anyOf_i1_anyOf_i3) | -#### `Distribution > modified > anyOf > Date string > anyOf > item 0` +#### `Distribution > modified > anyOf > Date string > anyOf > item 0` [#](#modified_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `Distribution > modified > anyOf > Date string > anyOf > item 1` +#### `Distribution > modified > anyOf > Date string > anyOf > item 1` [#](#modified_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `Distribution > modified > anyOf > Date string > anyOf > item 2` +#### `Distribution > modified > anyOf > Date string > anyOf > item 2` [#](#modified_anyOf_i1_anyOf_i2) A year in YYYY format @@ -884,7 +884,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `Distribution > modified > anyOf > Date string > anyOf > item 3` +#### `Distribution > modified > anyOf > Date string > anyOf > item 3` [#](#modified_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -895,7 +895,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `Distribution > rights` +## `Distribution > rights` [#](#rights) **Requirement:** Recommended @@ -922,14 +922,14 @@ Rights statements not already covered by license or accessRights, such as copyri | ------------------------------- | ---------------------------------- | | [rights items](#rights_items) | Full text of a statement of rights | -### Array Item +### Array Item [#](#rights_items) Full text of a statement of rights | **Type** | `string` | | -------- | -------- | -## `Distribution > title` +## `Distribution > title` [#](#title) **Requirement:** Recommended @@ -944,7 +944,7 @@ Human-readable title of the distribution "Climate Data CSV" ``` -## `Distribution > hasQualityMeasurement` +## `Distribution > hasQualityMeasurement` [#](#hasQualityMeasurement) **Title:** quality measurement @@ -959,7 +959,7 @@ Quality measurements for the distribution (for example, completeness, accuracy, | ----------------------------------------------------------------------- | ------------------------------------------------------------- | | [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) | A measurement of a resource against a specific quality metric | -## `Distribution > page` +## `Distribution > page` [#](#page) **Title:** documentation @@ -974,7 +974,7 @@ A page or document about this Distribution | -------------------------------------------- | ----------------------------------------------------- | | [Document](./quality-governance.md#document) | A publication or other document related to a resource | -## `Distribution > image` +## `Distribution > image` [#](#image) **Requirement:** Optional @@ -989,12 +989,12 @@ A link to a thumbnail picture illustrating the content of the distribution | [Null allowed when not required](#image_anyOf_i0) | | [Link](#image_anyOf_i1) | -### `Distribution > image > anyOf > Null allowed when not required` +### `Distribution > image > anyOf > Null allowed when not required` [#](#image_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > image > anyOf > Link` +### `Distribution > image > anyOf > Link` [#](#image_anyOf_i1) The link to the image @@ -1002,7 +1002,7 @@ The link to the image | ---------- | -------- | | **Format** | `iri` | -## `Distribution > checksum` +## `Distribution > checksum` [#](#checksum) **Requirement:** Optional @@ -1017,12 +1017,12 @@ Checksum used to verify that the downloadable file content has not changed | [Null allowed when not required](#checksum_anyOf_i0) | | [Checksum](#checksum_anyOf_i1) | -### `Distribution > checksum > anyOf > Null allowed when not required` +### `Distribution > checksum > anyOf > Null allowed when not required` [#](#checksum_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Distribution > checksum > anyOf > Checksum` +### `Distribution > checksum > anyOf > Checksum` [#](#checksum_anyOf_i1) inline description of Checksum diff --git a/jsonschema/docs/identifiers-and-relationships.md b/jsonschema/docs/identifiers-and-relationships.md index 49a7944f..766af041 100644 --- a/jsonschema/docs/identifiers-and-relationships.md +++ b/jsonschema/docs/identifiers-and-relationships.md @@ -17,12 +17,12 @@ A unique identifier and optionally it's scheme and other relevant information | [Simple string identifier](#identifier--anyOf_i0) | | [Identifier as a complex object](#identifier--anyOf_i1) | -## `Identifier > anyOf > Simple string identifier` +## `Identifier > anyOf > Simple string identifier` [#](#identifier--anyOf_i0) | **Type** | `string` | | -------- | -------- | -## `Identifier > anyOf > Identifier as a complex object` +## `Identifier > anyOf > Identifier as a complex object` [#](#identifier--anyOf_i1) | **Type** | `object` | | ------------------------- | ---------------- | @@ -38,7 +38,7 @@ A unique identifier and optionally it's scheme and other relevant information | [version](#identifier--anyOf_i1_version) | null or string | Optional | version of the identifier scheme | | [notation](#identifier--anyOf_i1_notation) | null or string | Optional | abbreviation or code from code lists for an identifier | -### `Identifier > anyOf > Identifier as a complex object > @id` +### `Identifier > anyOf > Identifier as a complex object > @id` [#](#identifier--anyOf_i1_@id) **Requirement:** Optional @@ -46,7 +46,7 @@ A unique identifier and optionally it's scheme and other relevant information | ---------- | -------- | | **Format** | `iri` | -### `Identifier > anyOf > Identifier as a complex object > @type` +### `Identifier > anyOf > Identifier as a complex object > @type` [#](#identifier--anyOf_i1_@type) **Requirement:** Optional @@ -54,7 +54,7 @@ A unique identifier and optionally it's scheme and other relevant information | ----------- | -------------- | | **Default** | `"Identifier"` | -### `Identifier > anyOf > Identifier as a complex object > schemaAgency` +### `Identifier > anyOf > Identifier as a complex object > schemaAgency` [#](#identifier--anyOf_i1_schemaAgency) **Requirement:** Optional @@ -63,7 +63,7 @@ The name of the agency that issued the identifier | **Type** | `null or string` | | -------- | ---------------- | -### `Identifier > anyOf > Identifier as a complex object > creator` +### `Identifier > anyOf > Identifier as a complex object > creator` [#](#identifier--anyOf_i1_creator) **Requirement:** Optional @@ -78,12 +78,12 @@ the agency that manages the identifier scheme | [Null allowed when not required](#identifier--anyOf_i1_creator_anyOf_i0) | | [Organization](#identifier--anyOf_i1_creator_anyOf_i1) | -#### `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Null allowed when not required` +#### `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Null allowed when not required` [#](#identifier--anyOf_i1_creator_anyOf_i0) | **Type** | `null` | | -------- | ------ | -#### `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Organization` +#### `Identifier > anyOf > Identifier as a complex object > creator > anyOf > Organization` [#](#identifier--anyOf_i1_creator_anyOf_i1) inline description of the creator @@ -92,7 +92,7 @@ inline description of the creator | **Additional properties** | Any type allowed | | **Defined in** | [Organization](./agents.md#organization) | -### `Identifier > anyOf > Identifier as a complex object > issued` +### `Identifier > anyOf > Identifier as a complex object > issued` [#](#identifier--anyOf_i1_issued) **Requirement:** Optional @@ -107,12 +107,12 @@ The date of formal issuance (e.g., publication) of the Identifier | [Null allowed when not required](#identifier--anyOf_i1_issued_anyOf_i0) | | [Date string](#identifier--anyOf_i1_issued_anyOf_i1) | -#### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Null allowed when not required` +#### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Null allowed when not required` [#](#identifier--anyOf_i1_issued_anyOf_i0) | **Type** | `null` | | -------- | ------ | -#### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string` +#### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string` [#](#identifier--anyOf_i1_issued_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -125,19 +125,19 @@ The date of formal issuance (e.g., publication) of the Identifier | [item 2](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i2) | | [item 3](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i3) | -##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 0` +##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 0` [#](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 1` +##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 1` [#](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 2` +##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 2` [#](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i2) A year in YYYY format @@ -148,7 +148,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 3` +##### `Identifier > anyOf > Identifier as a complex object > issued > anyOf > Date string > anyOf > item 3` [#](#identifier--anyOf_i1_issued_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -159,7 +159,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -### `Identifier > anyOf > Identifier as a complex object > version` +### `Identifier > anyOf > Identifier as a complex object > version` [#](#identifier--anyOf_i1_version) **Requirement:** Optional @@ -168,7 +168,7 @@ version of the identifier scheme | **Type** | `null or string` | | -------- | ---------------- | -### `Identifier > anyOf > Identifier as a complex object > notation` +### `Identifier > anyOf > Identifier as a complex object > notation` [#](#identifier--anyOf_i1_notation) **Requirement:** Optional @@ -206,7 +206,7 @@ Additional information about how one resource is related to another | [hadRole](#relationship--hadRole) | string | Mandatory | The function of an entity or agent with respect to a dataset | | [relation](#relationship--relation) | string | Mandatory | The entity related to the dataset. This string should unambiguously identify the related resource using an appropriate identifier. | -## `Relationship > @id` +## `Relationship > @id` [#](#relationship--@id) **Requirement:** Optional @@ -220,7 +220,7 @@ Additional information about how one resource is related to another "https://example.gov/relationships/dataset-001-data-provider" ``` -## `Relationship > @type` +## `Relationship > @type` [#](#relationship--@type) **Requirement:** Optional @@ -228,7 +228,7 @@ Additional information about how one resource is related to another | ----------- | ---------------- | | **Default** | `"Relationship"` | -## `Relationship > hadRole` +## `Relationship > hadRole` [#](#relationship--hadRole) **Title:** role @@ -250,7 +250,7 @@ The function of an entity or agent with respect to a dataset "dataProvider" ``` -## `Relationship > relation` +## `Relationship > relation` [#](#relationship--relation) **Requirement:** Mandatory @@ -299,7 +299,7 @@ A mechanism that can be used to verify that the contents of a distribution have | [algorithm](#checksum--algorithm) | string | Mandatory | The algorithm used to produce the checksum | | [checksumValue](#checksum--checksumValue) | string | Mandatory | A lower case hexadecimal encoded digest value produced using a specific algorithm | -## `Checksum > @id` +## `Checksum > @id` [#](#checksum--@id) **Requirement:** Optional @@ -313,7 +313,7 @@ A mechanism that can be used to verify that the contents of a distribution have "https://example.gov/checksums/dataset-001-sha256" ``` -## `Checksum > @type` +## `Checksum > @type` [#](#checksum--@type) **Requirement:** Optional @@ -321,7 +321,7 @@ A mechanism that can be used to verify that the contents of a distribution have | ----------- | ------------ | | **Default** | `"Checksum"` | -## `Checksum > algorithm` +## `Checksum > algorithm` [#](#checksum--algorithm) **Requirement:** Mandatory @@ -337,7 +337,7 @@ The algorithm used to produce the checksum "SHA-256" ``` -## `Checksum > checksumValue` +## `Checksum > checksumValue` [#](#checksum--checksumValue) **Requirement:** Mandatory @@ -426,7 +426,7 @@ A controlled term or label, optionally drawn from a concept scheme | [Concept](#concept--anyOf_i0) | | [item 1](#concept--anyOf_i1) | -## `Concept > anyOf > Concept` +## `Concept > anyOf > Concept` [#](#concept--anyOf_i0) The value of the concept, expressed as a string. This is only used when the concept is not further described by the properties of the Concept object and is not linked to a concept scheme. @@ -443,7 +443,7 @@ The value of the concept, expressed as a string. This is only used when the conc "Climate Science" ``` -## `Concept > anyOf > item 1` +## `Concept > anyOf > item 1` [#](#concept--anyOf_i1) | **Type** | `object` | | ------------------------- | ---------------- | @@ -481,7 +481,7 @@ The value of the concept, expressed as a string. This is only used when the conc | [notation](#concept--anyOf_i1_notation) | More than one type | Optional | List of abbreviations or codes from code lists for the Concept | | [prefLabel](#concept--anyOf_i1_prefLabel) | string | Optional | Preferred label for the term | -### `Concept > anyOf > item 1 > @id` +### `Concept > anyOf > item 1 > @id` [#](#concept--anyOf_i1_@id) **Requirement:** Optional @@ -495,7 +495,7 @@ The value of the concept, expressed as a string. This is only used when the conc "https://example.gov/concepts/environment" ``` -### `Concept > anyOf > item 1 > @type` +### `Concept > anyOf > item 1 > @type` [#](#concept--anyOf_i1_@type) **Requirement:** Optional @@ -503,7 +503,7 @@ The value of the concept, expressed as a string. This is only used when the conc | ----------- | ----------- | | **Default** | `"Concept"` | -### `Concept > anyOf > item 1 > altLabel` +### `Concept > anyOf > item 1 > altLabel` [#](#concept--anyOf_i1_altLabel) **Title:** alternate label @@ -520,7 +520,7 @@ Alternative label for a concept "Ecology" ``` -### `Concept > anyOf > item 1 > definition` +### `Concept > anyOf > item 1 > definition` [#](#concept--anyOf_i1_definition) **Requirement:** Optional @@ -539,7 +539,7 @@ Definition of the controlled vocabulary term "The natural world, including air, water, land, plants, and animals, especially as affected by human activity." ``` -### `Concept > anyOf > item 1 > inScheme` +### `Concept > anyOf > item 1 > inScheme` [#](#concept--anyOf_i1_inScheme) **Requirement:** Optional @@ -570,7 +570,7 @@ Concept scheme defining this concept } ``` -### `Concept > anyOf > item 1 > notation` +### `Concept > anyOf > item 1 > notation` [#](#concept--anyOf_i1_notation) **Requirement:** Optional @@ -595,12 +595,12 @@ List of abbreviations or codes from code lists for the Concept | [item 0](#concept--anyOf_i1_notation_anyOf_i0) | | [item 1](#concept--anyOf_i1_notation_anyOf_i1) | -#### `Concept > anyOf > item 1 > notation > anyOf > item 0` +#### `Concept > anyOf > item 1 > notation > anyOf > item 0` [#](#concept--anyOf_i1_notation_anyOf_i0) | **Type** | `null` | | -------- | ------ | -#### `Concept > anyOf > item 1 > notation > anyOf > item 1` +#### `Concept > anyOf > item 1 > notation > anyOf > item 1` [#](#concept--anyOf_i1_notation_anyOf_i1) | **Type** | array of string | | -------- | --------------- | @@ -609,12 +609,12 @@ List of abbreviations or codes from code lists for the Concept | ------------------------------------------------- | ----------- | | [item 1 items](#concept--anyOf_i1_notation_anyOf_i1_items) | - | -##### Array Item +##### Array Item [#](#concept--anyOf_i1_notation_anyOf_i1_items) | **Type** | `string` | | -------- | -------- | -### `Concept > anyOf > item 1 > prefLabel` +### `Concept > anyOf > item 1 > prefLabel` [#](#concept--anyOf_i1_prefLabel) **Title:** preferred label @@ -670,7 +670,7 @@ A controlled vocabulary or other list of approved terms for a concept | [modified](#concept-scheme--modified) | More than one type | Optional | The most recent date at which the concept scheme was changed or modified | | [title](#concept-scheme--title) | string | Mandatory | The title of the concept scheme | -## `ConceptScheme > @id` +## `ConceptScheme > @id` [#](#concept-scheme--@id) **Requirement:** Optional @@ -684,7 +684,7 @@ A controlled vocabulary or other list of approved terms for a concept "https://example.gov/concept-schemes/data-classification" ``` -## `ConceptScheme > @type` +## `ConceptScheme > @type` [#](#concept-scheme--@type) **Requirement:** Optional @@ -692,7 +692,7 @@ A controlled vocabulary or other list of approved terms for a concept | ----------- | ----------------- | | **Default** | `"ConceptScheme"` | -## `ConceptScheme > version` +## `ConceptScheme > version` [#](#concept-scheme--version) **Title:** version info @@ -709,7 +709,7 @@ A version number or other version designation of the concept scheme "2.0.1" ``` -## `ConceptScheme > created` +## `ConceptScheme > created` [#](#concept-scheme--created) **Title:** creation date @@ -744,12 +744,12 @@ The date on which the Concept Scheme was first created | [Null allowed when not required](#concept-scheme--created_anyOf_i0) | | [Date string](#concept-scheme--created_anyOf_i1) | -### `ConceptScheme > created > anyOf > Null allowed when not required` +### `ConceptScheme > created > anyOf > Null allowed when not required` [#](#concept-scheme--created_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `ConceptScheme > created > anyOf > Date string` +### `ConceptScheme > created > anyOf > Date string` [#](#concept-scheme--created_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -762,19 +762,19 @@ The date on which the Concept Scheme was first created | [item 2](#concept-scheme--created_anyOf_i1_anyOf_i2) | | [item 3](#concept-scheme--created_anyOf_i1_anyOf_i3) | -#### `ConceptScheme > created > anyOf > Date string > anyOf > item 0` +#### `ConceptScheme > created > anyOf > Date string > anyOf > item 0` [#](#concept-scheme--created_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `ConceptScheme > created > anyOf > Date string > anyOf > item 1` +#### `ConceptScheme > created > anyOf > Date string > anyOf > item 1` [#](#concept-scheme--created_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `ConceptScheme > created > anyOf > Date string > anyOf > item 2` +#### `ConceptScheme > created > anyOf > Date string > anyOf > item 2` [#](#concept-scheme--created_anyOf_i1_anyOf_i2) A year in YYYY format @@ -785,7 +785,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `ConceptScheme > created > anyOf > Date string > anyOf > item 3` +#### `ConceptScheme > created > anyOf > Date string > anyOf > item 3` [#](#concept-scheme--created_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -796,7 +796,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `ConceptScheme > description` +## `ConceptScheme > description` [#](#concept-scheme--description) **Requirement:** Recommended @@ -815,7 +815,7 @@ A description of the concept scheme "A controlled vocabulary for classifying federal government data assets by sensitivity and access requirements." ``` -## `ConceptScheme > issued` +## `ConceptScheme > issued` [#](#concept-scheme--issued) **Title:** publication date @@ -850,12 +850,12 @@ The date of formal issuance (e.g., publication) of the concept scheme | [Null allowed when not required](#concept-scheme--issued_anyOf_i0) | | [Date string](#concept-scheme--issued_anyOf_i1) | -### `ConceptScheme > issued > anyOf > Null allowed when not required` +### `ConceptScheme > issued > anyOf > Null allowed when not required` [#](#concept-scheme--issued_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `ConceptScheme > issued > anyOf > Date string` +### `ConceptScheme > issued > anyOf > Date string` [#](#concept-scheme--issued_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -868,19 +868,19 @@ The date of formal issuance (e.g., publication) of the concept scheme | [item 2](#concept-scheme--issued_anyOf_i1_anyOf_i2) | | [item 3](#concept-scheme--issued_anyOf_i1_anyOf_i3) | -#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 0` +#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 0` [#](#concept-scheme--issued_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 1` +#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 1` [#](#concept-scheme--issued_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 2` +#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 2` [#](#concept-scheme--issued_anyOf_i1_anyOf_i2) A year in YYYY format @@ -891,7 +891,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 3` +#### `ConceptScheme > issued > anyOf > Date string > anyOf > item 3` [#](#concept-scheme--issued_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -902,7 +902,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `ConceptScheme > modified` +## `ConceptScheme > modified` [#](#concept-scheme--modified) **Title:** update/modification date @@ -937,12 +937,12 @@ The most recent date at which the concept scheme was changed or modified | [Null allowed when not required](#concept-scheme--modified_anyOf_i0) | | [Date string](#concept-scheme--modified_anyOf_i1) | -### `ConceptScheme > modified > anyOf > Null allowed when not required` +### `ConceptScheme > modified > anyOf > Null allowed when not required` [#](#concept-scheme--modified_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `ConceptScheme > modified > anyOf > Date string` +### `ConceptScheme > modified > anyOf > Date string` [#](#concept-scheme--modified_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -955,19 +955,19 @@ The most recent date at which the concept scheme was changed or modified | [item 2](#concept-scheme--modified_anyOf_i1_anyOf_i2) | | [item 3](#concept-scheme--modified_anyOf_i1_anyOf_i3) | -#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 0` +#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 0` [#](#concept-scheme--modified_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 1` +#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 1` [#](#concept-scheme--modified_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 2` +#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 2` [#](#concept-scheme--modified_anyOf_i1_anyOf_i2) A year in YYYY format @@ -978,7 +978,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 3` +#### `ConceptScheme > modified > anyOf > Date string > anyOf > item 3` [#](#concept-scheme--modified_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -989,7 +989,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `ConceptScheme > title` +## `ConceptScheme > title` [#](#concept-scheme--title) **Requirement:** Mandatory diff --git a/jsonschema/docs/quality-governance.md b/jsonschema/docs/quality-governance.md index da9a53ad..2dda8dae 100644 --- a/jsonschema/docs/quality-governance.md +++ b/jsonschema/docs/quality-governance.md @@ -47,7 +47,7 @@ A standard or specification that another resource conforms to | [category](#standard--category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of categories for the Standard | | [inScheme](#standard--inScheme) | More than one type | Recommended | The reference register to which the Standard belongs | -## `Standard > @id` +## `Standard > @id` [#](#standard--@id) **Requirement:** Optional @@ -61,7 +61,7 @@ A standard or specification that another resource conforms to "https://example.gov/standards/dcat-us-3" ``` -## `Standard > @type` +## `Standard > @type` [#](#standard--@type) **Requirement:** Optional @@ -69,7 +69,7 @@ A standard or specification that another resource conforms to | ----------- | ------------ | | **Default** | `"Standard"` | -## `Standard > created` +## `Standard > created` [#](#standard--created) **Title:** creation date @@ -104,12 +104,12 @@ The date on which the Standard has been first created | [Null allowed when not required](#standard--created_anyOf_i0) | | [Date string](#standard--created_anyOf_i1) | -### `Standard > created > anyOf > Null allowed when not required` +### `Standard > created > anyOf > Null allowed when not required` [#](#standard--created_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Standard > created > anyOf > Date string` +### `Standard > created > anyOf > Date string` [#](#standard--created_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -122,19 +122,19 @@ The date on which the Standard has been first created | [item 2](#standard--created_anyOf_i1_anyOf_i2) | | [item 3](#standard--created_anyOf_i1_anyOf_i3) | -#### `Standard > created > anyOf > Date string > anyOf > item 0` +#### `Standard > created > anyOf > Date string > anyOf > item 0` [#](#standard--created_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `Standard > created > anyOf > Date string > anyOf > item 1` +#### `Standard > created > anyOf > Date string > anyOf > item 1` [#](#standard--created_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `Standard > created > anyOf > Date string > anyOf > item 2` +#### `Standard > created > anyOf > Date string > anyOf > item 2` [#](#standard--created_anyOf_i1_anyOf_i2) A year in YYYY format @@ -145,7 +145,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `Standard > created > anyOf > Date string > anyOf > item 3` +#### `Standard > created > anyOf > Date string > anyOf > item 3` [#](#standard--created_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -156,7 +156,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `Standard > description` +## `Standard > description` [#](#standard--description) **Requirement:** Recommended @@ -175,7 +175,7 @@ Plain-language summary of the standard "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` +## `Standard > identifier` [#](#standard--identifier) **Requirement:** Recommended @@ -190,12 +190,12 @@ The unique identifier for the Standard, e.g. the URI or other unique identifier | [Null allowed when not required](#standard--identifier_anyOf_i0) | | [Identifier](#standard--identifier_anyOf_i1) | -### `Standard > identifier > anyOf > Null allowed when not required` +### `Standard > identifier > anyOf > Null allowed when not required` [#](#standard--identifier_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Standard > identifier > anyOf > Identifier` +### `Standard > identifier > anyOf > Identifier` [#](#standard--identifier_anyOf_i1) inline description of Identifier @@ -204,7 +204,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | -## `Standard > otherIdentifier` +## `Standard > otherIdentifier` [#](#standard--otherIdentifier) **Requirement:** Optional @@ -217,7 +217,7 @@ A list of identifiers for the Standard besides the main identifier, e.g. the URI | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## `Standard > issued` +## `Standard > issued` [#](#standard--issued) **Requirement:** Recommended @@ -250,12 +250,12 @@ The date of formal issuance (e.g., publication) of the Standard | [Null allowed when not required](#standard--issued_anyOf_i0) | | [Date string](#standard--issued_anyOf_i1) | -### `Standard > issued > anyOf > Null allowed when not required` +### `Standard > issued > anyOf > Null allowed when not required` [#](#standard--issued_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Standard > issued > anyOf > Date string` +### `Standard > issued > anyOf > Date string` [#](#standard--issued_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -268,19 +268,19 @@ The date of formal issuance (e.g., publication) of the Standard | [item 2](#standard--issued_anyOf_i1_anyOf_i2) | | [item 3](#standard--issued_anyOf_i1_anyOf_i3) | -#### `Standard > issued > anyOf > Date string > anyOf > item 0` +#### `Standard > issued > anyOf > Date string > anyOf > item 0` [#](#standard--issued_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `Standard > issued > anyOf > Date string > anyOf > item 1` +#### `Standard > issued > anyOf > Date string > anyOf > item 1` [#](#standard--issued_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `Standard > issued > anyOf > Date string > anyOf > item 2` +#### `Standard > issued > anyOf > Date string > anyOf > item 2` [#](#standard--issued_anyOf_i1_anyOf_i2) A year in YYYY format @@ -291,7 +291,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `Standard > issued > anyOf > Date string > anyOf > item 3` +#### `Standard > issued > anyOf > Date string > anyOf > item 3` [#](#standard--issued_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -302,7 +302,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `Standard > modified` +## `Standard > modified` [#](#standard--modified) **Title:** last modified @@ -337,12 +337,12 @@ The most recent date on which the Standard was changed or modified | [Null allowed when not required](#standard--modified_anyOf_i0) | | [Date string](#standard--modified_anyOf_i1) | -### `Standard > modified > anyOf > Null allowed when not required` +### `Standard > modified > anyOf > Null allowed when not required` [#](#standard--modified_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Standard > modified > anyOf > Date string` +### `Standard > modified > anyOf > Date string` [#](#standard--modified_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -355,19 +355,19 @@ The most recent date on which the Standard was changed or modified | [item 2](#standard--modified_anyOf_i1_anyOf_i2) | | [item 3](#standard--modified_anyOf_i1_anyOf_i3) | -#### `Standard > modified > anyOf > Date string > anyOf > item 0` +#### `Standard > modified > anyOf > Date string > anyOf > item 0` [#](#standard--modified_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `Standard > modified > anyOf > Date string > anyOf > item 1` +#### `Standard > modified > anyOf > Date string > anyOf > item 1` [#](#standard--modified_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `Standard > modified > anyOf > Date string > anyOf > item 2` +#### `Standard > modified > anyOf > Date string > anyOf > item 2` [#](#standard--modified_anyOf_i1_anyOf_i2) A year in YYYY format @@ -378,7 +378,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `Standard > modified > anyOf > Date string > anyOf > item 3` +#### `Standard > modified > anyOf > Date string > anyOf > item 3` [#](#standard--modified_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -389,7 +389,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `Standard > title` +## `Standard > title` [#](#standard--title) **Requirement:** Recommended @@ -408,7 +408,7 @@ Human-readable title of the standard "DCAT-US 3.0 - Data Catalog Vocabulary United States Profile" ``` -## `Standard > category` +## `Standard > category` [#](#standard--category) **Requirement:** Optional @@ -421,7 +421,7 @@ List of categories for the Standard | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `Standard > inScheme` +## `Standard > inScheme` [#](#standard--inScheme) **Requirement:** Recommended @@ -436,12 +436,12 @@ The reference register to which the Standard belongs | [Null allowed when not required](#standard--inScheme_anyOf_i0) | | [ConceptScheme](#standard--inScheme_anyOf_i1) | -### `Standard > inScheme > anyOf > Null allowed when not required` +### `Standard > inScheme > anyOf > Null allowed when not required` [#](#standard--inScheme_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Standard > inScheme > anyOf > ConceptScheme` +### `Standard > inScheme > anyOf > ConceptScheme` [#](#standard--inScheme_anyOf_i1) inline description of ConceptScheme @@ -503,7 +503,7 @@ A publication or other document related to a resource | [title](#document--title) | string | Mandatory | The title of the Document | | [category](#document--category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of categories/genres for the Document | -## `Document > @id` +## `Document > @id` [#](#document--@id) **Requirement:** Optional @@ -517,7 +517,7 @@ A publication or other document related to a resource "https://example.gov/documents/climate-user-guide-001" ``` -## `Document > @type` +## `Document > @type` [#](#document--@type) **Requirement:** Optional @@ -525,7 +525,7 @@ A publication or other document related to a resource | ----------- | ------------ | | **Default** | `"Document"` | -## `Document > accessURL` +## `Document > accessURL` [#](#document--accessURL) **Requirement:** Optional @@ -546,12 +546,12 @@ A URL that gives access to the Document | [Null allowed when not required](#document--accessURL_anyOf_i0) | | [URL](#document--accessURL_anyOf_i1) | -### `Document > accessURL > anyOf > Null allowed when not required` +### `Document > accessURL > anyOf > Null allowed when not required` [#](#document--accessURL_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Document > accessURL > anyOf > URL` +### `Document > accessURL > anyOf > URL` [#](#document--accessURL_anyOf_i1) reference iri of Document @@ -559,7 +559,7 @@ reference iri of Document | ---------- | -------- | | **Format** | `iri` | -## `Document > downloadURL` +## `Document > downloadURL` [#](#document--downloadURL) **Requirement:** Optional @@ -580,12 +580,12 @@ A URL that is a direct link to a downloadable file of the Document in a given fo | [Null allowed when not required](#document--downloadURL_anyOf_i0) | | [URL](#document--downloadURL_anyOf_i1) | -### `Document > downloadURL > anyOf > Null allowed when not required` +### `Document > downloadURL > anyOf > Null allowed when not required` [#](#document--downloadURL_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Document > downloadURL > anyOf > URL` +### `Document > downloadURL > anyOf > URL` [#](#document--downloadURL_anyOf_i1) reference iri of Document @@ -593,7 +593,7 @@ reference iri of Document | ---------- | -------- | | **Format** | `iri` | -## `Document > creator` +## `Document > creator` [#](#document--creator) **Title:** author @@ -608,7 +608,7 @@ The individual(s) responsible for creating the Document | ------------------------------- | ----------------------------------------------- | | [Kind](./agents.md#kind) | Contact information for an individual or entity | -## `Document > mediaType` +## `Document > mediaType` [#](#document--mediaType) **Requirement:** Optional @@ -623,7 +623,7 @@ The file format of the Document as defined in the official register of media typ "application/pdf" ``` -## `Document > abstract` +## `Document > abstract` [#](#document--abstract) **Requirement:** Optional @@ -638,7 +638,7 @@ Text abstract of the Document "This document provides detailed instructions for using climate data products, including API access, file formats, and data interpretation guidelines." ``` -## `Document > bibliographicCitation` +## `Document > bibliographicCitation` [#](#document--bibliographicCitation) **Requirement:** Recommended @@ -657,7 +657,7 @@ Bibliographic citation as text "National Climate Data Center. (2024). Climate Data User Guide. U.S. Department of Commerce." ``` -## `Document > conformsTo` +## `Document > conformsTo` [#](#document--conformsTo) **Requirement:** Optional @@ -670,7 +670,7 @@ List of standards or specifications the document follows | -------------------------------------------- | ------------------------------------------------------------- | | [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | -## `Document > corporateCreator` +## `Document > corporateCreator` [#](#document--corporateCreator) **Title:** corporate author @@ -685,7 +685,7 @@ The corporate organization(s) responsible for creating the Document | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## `Document > description` +## `Document > description` [#](#document--description) **Requirement:** Recommended @@ -704,7 +704,7 @@ Plain-language summary of the document "A comprehensive guide for accessing and using the National Climate Data Center's data products and services." ``` -## `Document > identifier` +## `Document > identifier` [#](#document--identifier) **Requirement:** Recommended @@ -719,12 +719,12 @@ The unique identifier for the Document (e.g. DOI, ISBN) | [Null allowed when not required](#document--identifier_anyOf_i0) | | [Identifier](#document--identifier_anyOf_i1) | -### `Document > identifier > anyOf > Null allowed when not required` +### `Document > identifier > anyOf > Null allowed when not required` [#](#document--identifier_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Document > identifier > anyOf > Identifier` +### `Document > identifier > anyOf > Identifier` [#](#document--identifier_anyOf_i1) inline description of Identifier @@ -733,7 +733,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | -## `Document > otherIdentifier` +## `Document > otherIdentifier` [#](#document--otherIdentifier) **Requirement:** Optional @@ -746,7 +746,7 @@ A list of identifiers for the Document besides the main identifier, e.g. the URI | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## `Document > issued` +## `Document > issued` [#](#document--issued) **Title:** publication date @@ -781,12 +781,12 @@ Publication date of the Document | [Null allowed when not required](#document--issued_anyOf_i0) | | [item 1](#document--issued_anyOf_i1) | -### `Document > issued > anyOf > Null allowed when not required` +### `Document > issued > anyOf > Null allowed when not required` [#](#document--issued_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Document > issued > anyOf > item 1` +### `Document > issued > anyOf > item 1` [#](#document--issued_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -799,19 +799,19 @@ Publication date of the Document | [item 2](#document--issued_anyOf_i1_anyOf_i2) | | [item 3](#document--issued_anyOf_i1_anyOf_i3) | -#### `Document > issued > anyOf > item 1 > anyOf > item 0` +#### `Document > issued > anyOf > item 1 > anyOf > item 0` [#](#document--issued_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `Document > issued > anyOf > item 1 > anyOf > item 1` +#### `Document > issued > anyOf > item 1 > anyOf > item 1` [#](#document--issued_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `Document > issued > anyOf > item 1 > anyOf > item 2` +#### `Document > issued > anyOf > item 1 > anyOf > item 2` [#](#document--issued_anyOf_i1_anyOf_i2) A year in YYYY format @@ -822,7 +822,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `Document > issued > anyOf > item 1 > anyOf > item 3` +#### `Document > issued > anyOf > item 1 > anyOf > item 3` [#](#document--issued_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -833,7 +833,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `Document > publisher` +## `Document > publisher` [#](#document--publisher) **Requirement:** Recommended @@ -846,7 +846,7 @@ The organization(s) that published the Document | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## `Document > title` +## `Document > title` [#](#document--title) **Requirement:** Mandatory @@ -862,7 +862,7 @@ The title of the Document "Climate Data User Guide" ``` -## `Document > category` +## `Document > category` [#](#document--category) **Requirement:** Optional @@ -920,7 +920,7 @@ A record in a catalog, describing the registration of a single resource | [title](#catalog-record--title) | null or string | Optional | A name given to the Catalog Record | | [primaryTopic](#catalog-record--primaryTopic) | string | Mandatory | A link to the Dataset, Data service or Catalog described in the Catalog Record | -## `CatalogRecord > @id` +## `CatalogRecord > @id` [#](#catalog-record--@id) **Requirement:** Optional @@ -934,7 +934,7 @@ A record in a catalog, describing the registration of a single resource "https://example.gov/catalog-records/climate-dataset-record-001" ``` -## `CatalogRecord > @type` +## `CatalogRecord > @type` [#](#catalog-record--@type) **Requirement:** Optional @@ -942,7 +942,7 @@ A record in a catalog, describing the registration of a single resource | ----------- | ----------------- | | **Default** | `"CatalogRecord"` | -## `CatalogRecord > status` +## `CatalogRecord > status` [#](#catalog-record--status) **Title:** change type @@ -959,12 +959,12 @@ The status of the catalog record in the context of editorial flow of the dataset | [Null allowed when not required](#catalog-record--status_anyOf_i0) | | [Concept](#catalog-record--status_anyOf_i1) | -### `CatalogRecord > status > anyOf > Null allowed when not required` +### `CatalogRecord > status > anyOf > Null allowed when not required` [#](#catalog-record--status_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `CatalogRecord > status > anyOf > Concept` +### `CatalogRecord > status > anyOf > Concept` [#](#catalog-record--status_anyOf_i1) inline description of status @@ -973,7 +973,7 @@ inline description of status | **Additional properties** | Any type allowed | | **Defined in** | [Concept](./identifiers-and-relationships.md#concept) | -## `CatalogRecord > conformsTo` +## `CatalogRecord > conformsTo` [#](#catalog-record--conformsTo) **Title:** application profile @@ -990,12 +990,12 @@ An Application Profile that the Catalog Record's metadata conforms to | [Null allowed when not required](#catalog-record--conformsTo_anyOf_i0) | | [Standard](#catalog-record--conformsTo_anyOf_i1) | -### `CatalogRecord > conformsTo > anyOf > Null allowed when not required` +### `CatalogRecord > conformsTo > anyOf > Null allowed when not required` [#](#catalog-record--conformsTo_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `CatalogRecord > conformsTo > anyOf > Standard` +### `CatalogRecord > conformsTo > anyOf > Standard` [#](#catalog-record--conformsTo_anyOf_i1) inline description of application profile @@ -1004,7 +1004,7 @@ inline description of application profile | **Additional properties** | Any type allowed | | **Defined in** | [Standard](./quality-governance.md#standard) | -## `CatalogRecord > description` +## `CatalogRecord > description` [#](#catalog-record--description) **Title:** Descriptions @@ -1028,12 +1028,12 @@ A list of free-text accounts of the catalog record | ---------------------------------------- | ----------- | | [Description string](#catalog-record--description_items) | - | -### Description string +### Description string [#](#catalog-record--description_items) | **Type** | `string` | | -------- | -------- | -## `CatalogRecord > issued` +## `CatalogRecord > issued` [#](#catalog-record--issued) **Title:** listing date @@ -1074,7 +1074,7 @@ List of dates on which the catalog record was included in the catalog | ------------------------------- | ----------- | | [Date string](#catalog-record--issued_items) | - | -### Date string +### Date string [#](#catalog-record--issued_items) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -1087,19 +1087,19 @@ List of dates on which the catalog record was included in the catalog | [item 2](#catalog-record--issued_items_anyOf_i2) | | [item 3](#catalog-record--issued_items_anyOf_i3) | -#### `CatalogRecord > issued > Date string > anyOf > item 0` +#### `CatalogRecord > issued > Date string > anyOf > item 0` [#](#catalog-record--issued_items_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `CatalogRecord > issued > Date string > anyOf > item 1` +#### `CatalogRecord > issued > Date string > anyOf > item 1` [#](#catalog-record--issued_items_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `CatalogRecord > issued > Date string > anyOf > item 2` +#### `CatalogRecord > issued > Date string > anyOf > item 2` [#](#catalog-record--issued_items_anyOf_i2) A year in YYYY format @@ -1110,7 +1110,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `CatalogRecord > issued > Date string > anyOf > item 3` +#### `CatalogRecord > issued > Date string > anyOf > item 3` [#](#catalog-record--issued_items_anyOf_i3) A year and month in YYYY-MM format @@ -1121,7 +1121,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `CatalogRecord > language` +## `CatalogRecord > language` [#](#catalog-record--language) **Requirement:** Optional @@ -1150,12 +1150,12 @@ Language code used in catalog record metadata text, using ISO 639-1 values such | [Language code](#catalog-record--language_anyOf_i1) | | [Array of language codes](#catalog-record--language_anyOf_i2) | -### `CatalogRecord > language > anyOf > Null allowed when not required` +### `CatalogRecord > language > anyOf > Null allowed when not required` [#](#catalog-record--language_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `CatalogRecord > language > anyOf > Language code` +### `CatalogRecord > language > anyOf > Language code` [#](#catalog-record--language_anyOf_i1) | **Type** | `string` | | -------- | -------- | @@ -1164,7 +1164,7 @@ Language code used in catalog record metadata text, using ISO 639-1 values such | -------------- | - | | **Max length** | 2 | -### `CatalogRecord > language > anyOf > Array of language codes` +### `CatalogRecord > language > anyOf > Array of language codes` [#](#catalog-record--language_anyOf_i2) | **Type** | array of string | | -------- | --------------- | @@ -1173,7 +1173,7 @@ Language code used in catalog record metadata text, using ISO 639-1 values such | ----------------------------------------- | ----------- | | [Language code](#catalog-record--language_anyOf_i2_items) | - | -#### Language code +#### Language code [#](#catalog-record--language_anyOf_i2_items) | **Type** | `string` | | -------- | -------- | @@ -1182,7 +1182,7 @@ Language code used in catalog record metadata text, using ISO 639-1 values such | -------------- | - | | **Max length** | 2 | -## `CatalogRecord > modified` +## `CatalogRecord > modified` [#](#catalog-record--modified) **Title:** update/modification date @@ -1220,19 +1220,19 @@ The most recent date on which the catalog record was changed or modified | [item 2](#catalog-record--modified_anyOf_i2) | | [item 3](#catalog-record--modified_anyOf_i3) | -### `CatalogRecord > modified > anyOf > item 0` +### `CatalogRecord > modified > anyOf > item 0` [#](#catalog-record--modified_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -### `CatalogRecord > modified > anyOf > item 1` +### `CatalogRecord > modified > anyOf > item 1` [#](#catalog-record--modified_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -### `CatalogRecord > modified > anyOf > item 2` +### `CatalogRecord > modified > anyOf > item 2` [#](#catalog-record--modified_anyOf_i2) A year in YYYY format @@ -1243,7 +1243,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -### `CatalogRecord > modified > anyOf > item 3` +### `CatalogRecord > modified > anyOf > item 3` [#](#catalog-record--modified_anyOf_i3) A year and month in YYYY-MM format @@ -1254,7 +1254,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `CatalogRecord > source` +## `CatalogRecord > source` [#](#catalog-record--source) **Title:** source metadata @@ -1271,7 +1271,7 @@ The original metadata that was used in creating metadata for the items in the ca "Original metadata harvested from NOAA data portal" ``` -## `CatalogRecord > title` +## `CatalogRecord > title` [#](#catalog-record--title) **Requirement:** Optional @@ -1290,7 +1290,7 @@ A name given to the Catalog Record "Climate Data 2023 Catalog Record" ``` -## `CatalogRecord > primaryTopic` +## `CatalogRecord > primaryTopic` [#](#catalog-record--primaryTopic) **Requirement:** Mandatory @@ -1403,7 +1403,7 @@ A service that provides access to data or data processing functions | [qualifiedAttribution](#data-service--qualifiedAttribution) | null or array of [Attribution](./quality-governance.md#attribution) classes | Optional | List of agents with specific responsibilities for the data service | | [wasUsedBy](#data-service--wasUsedBy) | null or array of [Activity](./temporal-spatial-metrics.md#activity) classes | Optional | List of activities that used or tested the data service | -## `DataService > @id` +## `DataService > @id` [#](#data-service--@id) **Requirement:** Optional @@ -1417,7 +1417,7 @@ A service that provides access to data or data processing functions "https://example.gov/data-services/climate-api-001" ``` -## `DataService > @type` +## `DataService > @type` [#](#data-service--@type) **Requirement:** Optional @@ -1425,7 +1425,7 @@ A service that provides access to data or data processing functions | ----------- | --------------- | | **Default** | `"DataService"` | -## `DataService > contactPoint` +## `DataService > contactPoint` [#](#data-service--contactPoint) **Requirement:** Mandatory @@ -1439,7 +1439,7 @@ Contact information for questions about the Data Service. Include an email addre | ------------------------------- | ----------------------------------------------- | | [Kind](./agents.md#kind) | Contact information for an individual or entity | -## `DataService > endpointDescription` +## `DataService > endpointDescription` [#](#data-service--endpointDescription) **Requirement:** Recommended @@ -1466,12 +1466,12 @@ List of endpoint descriptions with operations and parameters (for example, OpenA | ------------------------------------------------------- | ----------- | | [endpointDescription items](#data-service--endpointDescription_items) | - | -### Array Item +### Array Item [#](#data-service--endpointDescription_items) | **Type** | `string` | | -------- | -------- | -## `DataService > endpointURL` +## `DataService > endpointURL` [#](#data-service--endpointURL) **Requirement:** Mandatory @@ -1500,7 +1500,7 @@ A list of root locations or primary endpoints of the service (a Web-resolvable I | ------------------------------- | --------------------------------------------------------------------------- | | [URLs](#data-service--endpointURL_items) | The root location or primary endpoint of the service (a Web-resolvable IRI) | -### URLs +### URLs [#](#data-service--endpointURL_items) The root location or primary endpoint of the service (a Web-resolvable IRI) @@ -1508,7 +1508,7 @@ The root location or primary endpoint of the service (a Web-resolvable IRI) | ---------- | -------- | | **Format** | `iri` | -## `DataService > keyword` +## `DataService > keyword` [#](#data-service--keyword) **Title:** keyword/tag @@ -1543,7 +1543,7 @@ List of keywords or tags describing the data service | ----------------------------------- | ----------- | | [Non-empty strings](#data-service--keyword_items) | - | -### Non-empty strings +### Non-empty strings [#](#data-service--keyword_items) | **Type** | `string` | | -------- | -------- | @@ -1552,7 +1552,7 @@ List of keywords or tags describing the data service | -------------- | - | | **Min length** | 1 | -## `DataService > servesDataset` +## `DataService > servesDataset` [#](#data-service--servesDataset) **Requirement:** Recommended @@ -1565,7 +1565,7 @@ List of datasets this service provides access to | ------------------------------- | --------------------------------------------------------- | | [Dataset](./dataset.md#root) | A collection of data published or curated by one provider | -## `DataService > spatialResolutionInMeters` +## `DataService > spatialResolutionInMeters` [#](#data-service--spatialResolutionInMeters) **Requirement:** Optional @@ -1580,7 +1580,7 @@ The minimum spatial separation resolvable in a Data Service, measured in meters "1000" ``` -## `DataService > temporalResolution` +## `DataService > temporalResolution` [#](#data-service--temporalResolution) **Requirement:** Optional @@ -1595,7 +1595,7 @@ The minimum time period resolvable by the Data Service "P1D" ``` -## `DataService > theme` +## `DataService > theme` [#](#data-service--theme) **Title:** theme/category @@ -1610,7 +1610,7 @@ List of themes or categories for the data service | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `DataService > accessRights` +## `DataService > accessRights` [#](#data-service--accessRights) **Requirement:** Optional @@ -1631,19 +1631,19 @@ Information about whether the data service is publicly accessible, restricted, o | [item 0](#data-service--accessRights_anyOf_i0) | | [item 1](#data-service--accessRights_anyOf_i1) | -### `DataService > accessRights > anyOf > item 0` +### `DataService > accessRights > anyOf > item 0` [#](#data-service--accessRights_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DataService > accessRights > anyOf > item 1` +### `DataService > accessRights > anyOf > item 1` [#](#data-service--accessRights_anyOf_i1) Text description of the access rights | **Type** | `string` | | -------- | -------- | -## `DataService > conformsTo` +## `DataService > conformsTo` [#](#data-service--conformsTo) **Requirement:** Optional @@ -1656,7 +1656,7 @@ List of general standards or specifications that the Data Service endpoints impl | -------------------------------------------- | ------------------------------------------------------------- | | [Standard](./quality-governance.md#standard) | A standard or specification that another resource conforms to | -## `DataService > created` +## `DataService > created` [#](#data-service--created) **Title:** creation date @@ -1691,12 +1691,12 @@ The date on which the Data Service was first created | [item 0](#data-service--created_anyOf_i0) | | [Date string](#data-service--created_anyOf_i1) | -### `DataService > created > anyOf > item 0` +### `DataService > created > anyOf > item 0` [#](#data-service--created_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DataService > created > anyOf > Date string` +### `DataService > created > anyOf > Date string` [#](#data-service--created_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -1709,19 +1709,19 @@ The date on which the Data Service was first created | [item 2](#data-service--created_anyOf_i1_anyOf_i2) | | [item 3](#data-service--created_anyOf_i1_anyOf_i3) | -#### `DataService > created > anyOf > Date string > anyOf > item 0` +#### `DataService > created > anyOf > Date string > anyOf > item 0` [#](#data-service--created_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `DataService > created > anyOf > Date string > anyOf > item 1` +#### `DataService > created > anyOf > Date string > anyOf > item 1` [#](#data-service--created_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `DataService > created > anyOf > Date string > anyOf > item 2` +#### `DataService > created > anyOf > Date string > anyOf > item 2` [#](#data-service--created_anyOf_i1_anyOf_i2) A year in YYYY format @@ -1732,7 +1732,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `DataService > created > anyOf > Date string > anyOf > item 3` +#### `DataService > created > anyOf > Date string > anyOf > item 3` [#](#data-service--created_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -1743,7 +1743,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `DataService > creator` +## `DataService > creator` [#](#data-service--creator) **Requirement:** Optional @@ -1756,7 +1756,7 @@ List of agents primarily responsible for producing the Data Service | ------------------------------- | -------------------------------------------------------------------------------- | | [Agent](./agents.md#agent) | A person, organization, software agent, or other entity involved with a resource | -## `DataService > description` +## `DataService > description` [#](#data-service--description) **Requirement:** Optional @@ -1771,7 +1771,7 @@ Plain-language summary of the data service "A RESTful API providing access to historical and real-time climate data including temperature, precipitation, and atmospheric conditions." ``` -## `DataService > identifier` +## `DataService > identifier` [#](#data-service--identifier) **Requirement:** Optional @@ -1786,12 +1786,12 @@ The unique identifier for the Data Service, e.g. the URI or other unique identif | [item 0](#data-service--identifier_anyOf_i0) | | [Identifier](#data-service--identifier_anyOf_i1) | -### `DataService > identifier > anyOf > item 0` +### `DataService > identifier > anyOf > item 0` [#](#data-service--identifier_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DataService > identifier > anyOf > Identifier` +### `DataService > identifier > anyOf > Identifier` [#](#data-service--identifier_anyOf_i1) inline description of Identifier @@ -1800,7 +1800,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Same definition as** | [Identifier](./identifiers-and-relationships.md#identifier) | -## `DataService > otherIdentifier` +## `DataService > otherIdentifier` [#](#data-service--otherIdentifier) **Requirement:** Optional @@ -1813,7 +1813,7 @@ A list of identifiers for the Data Service besides the main identifier, e.g. the | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## `DataService > language` +## `DataService > language` [#](#data-service--language) **Requirement:** Optional @@ -1842,12 +1842,12 @@ ISO 639-1 language code values supported by the data service, such as en or es, | [Language code](#data-service--language_anyOf_i1) | | [List of lanuages](#data-service--language_anyOf_i2) | -### `DataService > language > anyOf > Null allowed when not required` +### `DataService > language > anyOf > Null allowed when not required` [#](#data-service--language_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DataService > language > anyOf > Language code` +### `DataService > language > anyOf > Language code` [#](#data-service--language_anyOf_i1) | **Type** | `string` | | -------- | -------- | @@ -1856,7 +1856,7 @@ ISO 639-1 language code values supported by the data service, such as en or es, | -------------- | - | | **Max length** | 2 | -### `DataService > language > anyOf > List of lanuages` +### `DataService > language > anyOf > List of lanuages` [#](#data-service--language_anyOf_i2) | **Type** | array of string | | -------- | --------------- | @@ -1865,7 +1865,7 @@ ISO 639-1 language code values supported by the data service, such as en or es, | ----------------------------------------- | ----------- | | [Language code](#data-service--language_anyOf_i2_items) | - | -#### Language code +#### Language code [#](#data-service--language_anyOf_i2_items) | **Type** | `string` | | -------- | -------- | @@ -1874,7 +1874,7 @@ ISO 639-1 language code values supported by the data service, such as en or es, | -------------- | - | | **Max length** | 2 | -## `DataService > license` +## `DataService > license` [#](#data-service--license) **Requirement:** Recommended @@ -1895,19 +1895,19 @@ License that governs how the data service can be used or reused | [Null allowed when not required](#data-service--license_anyOf_i0) | | [item 1](#data-service--license_anyOf_i1) | -### `DataService > license > anyOf > Null allowed when not required` +### `DataService > license > anyOf > Null allowed when not required` [#](#data-service--license_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DataService > license > anyOf > item 1` +### `DataService > license > anyOf > item 1` [#](#data-service--license_anyOf_i1) Full text of the license | **Type** | `string` | | -------- | -------- | -## `DataService > modified` +## `DataService > modified` [#](#data-service--modified) **Title:** update/modification date @@ -1942,12 +1942,12 @@ The most recent date on which the Data Service was changed or modified | [Null allowed when not required](#data-service--modified_anyOf_i0) | | [Date string](#data-service--modified_anyOf_i1) | -### `DataService > modified > anyOf > Null allowed when not required` +### `DataService > modified > anyOf > Null allowed when not required` [#](#data-service--modified_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `DataService > modified > anyOf > Date string` +### `DataService > modified > anyOf > Date string` [#](#data-service--modified_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -1960,19 +1960,19 @@ The most recent date on which the Data Service was changed or modified | [item 2](#data-service--modified_anyOf_i1_anyOf_i2) | | [item 3](#data-service--modified_anyOf_i1_anyOf_i3) | -#### `DataService > modified > anyOf > Date string > anyOf > item 0` +#### `DataService > modified > anyOf > Date string > anyOf > item 0` [#](#data-service--modified_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `DataService > modified > anyOf > Date string > anyOf > item 1` +#### `DataService > modified > anyOf > Date string > anyOf > item 1` [#](#data-service--modified_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `DataService > modified > anyOf > Date string > anyOf > item 2` +#### `DataService > modified > anyOf > Date string > anyOf > item 2` [#](#data-service--modified_anyOf_i1_anyOf_i2) A year in YYYY format @@ -1983,7 +1983,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `DataService > modified > anyOf > Date string > anyOf > item 3` +#### `DataService > modified > anyOf > Date string > anyOf > item 3` [#](#data-service--modified_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -1994,7 +1994,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `DataService > publisher` +## `DataService > publisher` [#](#data-service--publisher) **Requirement:** Mandatory @@ -2006,7 +2006,7 @@ Person or organization responsible for publishing and making the data service av | **Additional properties** | Any type allowed | | **Defined in** | [Agent](./agents.md#agent) | -## `DataService > rights` +## `DataService > rights` [#](#data-service--rights) **Requirement:** Optional @@ -2027,12 +2027,12 @@ Rights statements not already covered by license or accessRights, such as copyri | ------------------------------- | ----------- | | [rights items](#data-service--rights_items) | - | -### Array Item +### Array Item [#](#data-service--rights_items) | **Type** | `string` | | -------- | -------- | -## `DataService > rightsHolder` +## `DataService > rightsHolder` [#](#data-service--rightsHolder) **Requirement:** Optional @@ -2045,7 +2045,7 @@ A list of Agents (organizations) holding rights on the Data Service | ---------------------------------------- | --------------------------------------------------------------------------------- | | [Organization](./agents.md#organization) | An organization involved with a resource, including parent or child organizations | -## `DataService > spatial` +## `DataService > spatial` [#](#data-service--spatial) **Title:** spatial/geographic coverage @@ -2060,7 +2060,7 @@ A geographic region that is covered by the Data Service | -------------------------------------------------- | -------------------------------- | | [Location](./temporal-spatial-metrics.md#location) | A named place or geographic area | -## `DataService > temporal` +## `DataService > temporal` [#](#data-service--temporal) **Title:** temporal coverage @@ -2075,7 +2075,7 @@ Time periods covered by the data service | ------------------------------------------------------------ | ---------------------------------------------------------------------- | | [PeriodOfTime](./temporal-spatial-metrics.md#period-of-time) | Information about a specific time period with a start- and/or end-time | -## `DataService > title` +## `DataService > title` [#](#data-service--title) **Requirement:** Mandatory @@ -2091,7 +2091,7 @@ Human-readable title of the data service "Climate Data REST API" ``` -## `DataService > category` +## `DataService > category` [#](#data-service--category) **Requirement:** Optional @@ -2104,7 +2104,7 @@ List of high-level categories for the data service | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `DataService > hasQualityMeasurement` +## `DataService > hasQualityMeasurement` [#](#data-service--hasQualityMeasurement) **Title:** quality measurement @@ -2119,7 +2119,7 @@ Quality measurements for the data service (for example, availability, response t | ----------------------------------------------------------------------- | ------------------------------------------------------------- | | [QualityMeasurement](./temporal-spatial-metrics.md#quality-measurement) | A measurement of a resource against a specific quality metric | -## `DataService > qualifiedAttribution` +## `DataService > qualifiedAttribution` [#](#data-service--qualifiedAttribution) **Requirement:** Optional @@ -2132,7 +2132,7 @@ List of agents with specific responsibilities for the data service | -------------------------------------------------- | ------------------------------------------------- | | [Attribution](./quality-governance.md#attribution) | A responsibility that an agent has for a resource | -## `DataService > wasUsedBy` +## `DataService > wasUsedBy` [#](#data-service--wasUsedBy) **Requirement:** Optional @@ -2176,7 +2176,7 @@ A responsibility that an agent has for a resource | [hadRole](#attribution--hadRole) | string | Mandatory | The function of an entity or agent with respect to another entity or resource | | [agent](#attribution--agent) | object | Mandatory | The agent that plays a role in the resource | -## `Attribution > @id` +## `Attribution > @id` [#](#attribution--@id) **Requirement:** Optional @@ -2190,7 +2190,7 @@ A responsibility that an agent has for a resource "https://example.gov/attributions/dataset-steward-001" ``` -## `Attribution > @type` +## `Attribution > @type` [#](#attribution--@type) **Requirement:** Optional @@ -2198,7 +2198,7 @@ A responsibility that an agent has for a resource | ----------- | --------------- | | **Default** | `"Attribution"` | -## `Attribution > hadRole` +## `Attribution > hadRole` [#](#attribution--hadRole) **Title:** role @@ -2216,7 +2216,7 @@ The function of an entity or agent with respect to another entity or resource "Data Steward" ``` -## `Attribution > agent` +## `Attribution > agent` [#](#attribution--agent) **Requirement:** Mandatory diff --git a/jsonschema/docs/temporal-spatial-metrics.md b/jsonschema/docs/temporal-spatial-metrics.md index 969b954f..579c70c7 100644 --- a/jsonschema/docs/temporal-spatial-metrics.md +++ b/jsonschema/docs/temporal-spatial-metrics.md @@ -34,25 +34,25 @@ Information about a specific time period with a start- and/or end-time | [item 0](#period-of-time--anyOf_i0) | | [item 1](#period-of-time--anyOf_i1) | -## `PeriodOfTime > anyOf > item 0` +## `PeriodOfTime > anyOf > item 0` [#](#period-of-time--anyOf_i0) | **Type** | `object` | | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | -### The following properties are required +### The following properties are required [#](#period-of-time--autogenerated_heading_2) * startDate -## `PeriodOfTime > anyOf > item 1` +## `PeriodOfTime > anyOf > item 1` [#](#period-of-time--anyOf_i1) | **Type** | `object` | | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | -### The following properties are required +### The following properties are required [#](#period-of-time--autogenerated_heading_3) * endDate -## `PeriodOfTime > @id` +## `PeriodOfTime > @id` [#](#period-of-time--@id) **Requirement:** Optional @@ -66,7 +66,7 @@ Information about a specific time period with a start- and/or end-time "https://example.gov/periods/fiscal-year-2024" ``` -## `PeriodOfTime > @type` +## `PeriodOfTime > @type` [#](#period-of-time--@type) **Requirement:** Optional @@ -74,7 +74,7 @@ Information about a specific time period with a start- and/or end-time | ----------- | ---------------- | | **Default** | `"PeriodOfTime"` | -## `PeriodOfTime > endDate` +## `PeriodOfTime > endDate` [#](#period-of-time--endDate) **Requirement:** Recommended @@ -107,12 +107,12 @@ The end date of the period of time | [Null allowed when not required](#period-of-time--endDate_anyOf_i0) | | [item 1](#period-of-time--endDate_anyOf_i1) | -### `PeriodOfTime > endDate > anyOf > Null allowed when not required` +### `PeriodOfTime > endDate > anyOf > Null allowed when not required` [#](#period-of-time--endDate_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `PeriodOfTime > endDate > anyOf > item 1` +### `PeriodOfTime > endDate > anyOf > item 1` [#](#period-of-time--endDate_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -125,19 +125,19 @@ The end date of the period of time | [item 2](#period-of-time--endDate_anyOf_i1_anyOf_i2) | | [item 3](#period-of-time--endDate_anyOf_i1_anyOf_i3) | -#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 0` +#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 0` [#](#period-of-time--endDate_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 1` +#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 1` [#](#period-of-time--endDate_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 2` +#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 2` [#](#period-of-time--endDate_anyOf_i1_anyOf_i2) A year in YYYY format @@ -148,7 +148,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 3` +#### `PeriodOfTime > endDate > anyOf > item 1 > anyOf > item 3` [#](#period-of-time--endDate_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -159,7 +159,7 @@ A year and month in YYYY-MM format | --------------------------------- | ----------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}-[0-9]{2}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D-%5B0-9%5D%7B2%7D%24) | -## `PeriodOfTime > startDate` +## `PeriodOfTime > startDate` [#](#period-of-time--startDate) **Requirement:** Recommended @@ -192,12 +192,12 @@ The start date of the period of time | [Null allowed when not required](#period-of-time--startDate_anyOf_i0) | | [item 1](#period-of-time--startDate_anyOf_i1) | -### `PeriodOfTime > startDate > anyOf > Null allowed when not required` +### `PeriodOfTime > startDate > anyOf > Null allowed when not required` [#](#period-of-time--startDate_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `PeriodOfTime > startDate > anyOf > item 1` +### `PeriodOfTime > startDate > anyOf > item 1` [#](#period-of-time--startDate_anyOf_i1) | **Type** | `combining` | | ------------------------- | ---------------- | @@ -210,19 +210,19 @@ The start date of the period of time | [item 2](#period-of-time--startDate_anyOf_i1_anyOf_i2) | | [item 3](#period-of-time--startDate_anyOf_i1_anyOf_i3) | -#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 0` +#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 0` [#](#period-of-time--startDate_anyOf_i1_anyOf_i0) | **Type** | `string` | | ---------- | ----------- | | **Format** | `date-time` | -#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 1` +#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 1` [#](#period-of-time--startDate_anyOf_i1_anyOf_i1) | **Type** | `string` | | ---------- | -------- | | **Format** | `date` | -#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 2` +#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 2` [#](#period-of-time--startDate_anyOf_i1_anyOf_i2) A year in YYYY format @@ -233,7 +233,7 @@ A year in YYYY format | --------------------------------- | --------------------------------------------------------------------------- | | **Must match regular expression** | ```^[0-9]{4}$``` [Test](https://regex101.com/?regex=%5E%5B0-9%5D%7B4%7D%24) | -#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 3` +#### `PeriodOfTime > startDate > anyOf > item 1 > anyOf > item 3` [#](#period-of-time--startDate_anyOf_i1_anyOf_i3) A year and month in YYYY-MM format @@ -379,7 +379,7 @@ A named place or geographic area | [altLabel](#location--altLabel) | null or string | Optional | An alternative label or name for a location | | [prefLabel](#location--prefLabel) | null or string | Recommended | Preferred label or name of the Location | -## `Location > @id` +## `Location > @id` [#](#location--@id) **Requirement:** Optional @@ -393,7 +393,7 @@ A named place or geographic area "https://example.gov/locations/washington-dc" ``` -## `Location > @type` +## `Location > @type` [#](#location--@type) **Requirement:** Optional @@ -401,7 +401,7 @@ A named place or geographic area | ----------- | ------------ | | **Default** | `"Location"` | -## `Location > bbox` +## `Location > bbox` [#](#location--bbox) **Title:** bounding box @@ -455,19 +455,19 @@ Bounding box for the location, described in WKT, GeoJSON, or GML format | [item 1](#location--bbox_anyOf_i1) | | [item 2](#location--bbox_anyOf_i2) | -### `Location > bbox > anyOf > item 0` +### `Location > bbox > anyOf > item 0` [#](#location--bbox_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Location > bbox > anyOf > item 1` +### `Location > bbox > anyOf > item 1` [#](#location--bbox_anyOf_i1) Bounding box represented in WKT, GeoJSON (stringified), or GML format | **Type** | `string` | | -------- | -------- | -### `Location > bbox > anyOf > item 2` +### `Location > bbox > anyOf > item 2` [#](#location--bbox_anyOf_i2) Bounding box represented in GeoJSON format, either as a Polygon or in bbox array format @@ -480,7 +480,7 @@ Bounding box represented in GeoJSON format, either as a Polygon or in bbox array | [coordinates](#location--bbox_anyOf_i2_coordinates) | array | Optional | | | [type](#location--bbox_anyOf_i2_type) | const | Optional | | -#### `Location > bbox > anyOf > item 2 > coordinates` +#### `Location > bbox > anyOf > item 2 > coordinates` [#](#location--bbox_anyOf_i2_coordinates) **Requirement:** Optional @@ -488,7 +488,7 @@ Bounding box represented in GeoJSON format, either as a Polygon or in bbox array | ------------ | ------- | | **Required** | Yes | -#### `Location > bbox > anyOf > item 2 > type` +#### `Location > bbox > anyOf > item 2 > type` [#](#location--bbox_anyOf_i2_type) **Requirement:** Optional @@ -498,7 +498,7 @@ Bounding box represented in GeoJSON format, either as a Polygon or in bbox array Specific value: `"Polygon"` -## `Location > centroid` +## `Location > centroid` [#](#location--centroid) **Requirement:** Optional @@ -526,19 +526,19 @@ The geographic center (centroid) of a location described in WKT, GeoJSON, or GML | [item 1](#location--centroid_anyOf_i1) | | [item 2](#location--centroid_anyOf_i2) | -### `Location > centroid > anyOf > item 0` +### `Location > centroid > anyOf > item 0` [#](#location--centroid_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Location > centroid > anyOf > item 1` +### `Location > centroid > anyOf > item 1` [#](#location--centroid_anyOf_i1) Center point represented in WKT, GeoJSON (stringified), or GML format | **Type** | `string` | | -------- | -------- | -### `Location > centroid > anyOf > item 2` +### `Location > centroid > anyOf > item 2` [#](#location--centroid_anyOf_i2) Centroid represented in GeoJSON format; force point usage with coordinates of longitude and latitude @@ -551,7 +551,7 @@ Centroid represented in GeoJSON format; force point usage with coordinates of lo | [coordinates](#location--centroid_anyOf_i2_coordinates) | array of number | Optional | | | [type](#location--centroid_anyOf_i2_type) | const | Optional | | -#### `Location > centroid > anyOf > item 2 > coordinates` +#### `Location > centroid > anyOf > item 2 > coordinates` [#](#location--centroid_anyOf_i2_coordinates) **Requirement:** Optional @@ -563,12 +563,12 @@ Centroid represented in GeoJSON format; force point usage with coordinates of lo | --------------------------------------------------------- | ----------- | | [coordinates items](#location--centroid_anyOf_i2_coordinates_items) | - | -##### Array Item +##### Array Item [#](#location--centroid_anyOf_i2_coordinates_items) | **Type** | `number` | | -------- | -------- | -#### `Location > centroid > anyOf > item 2 > type` +#### `Location > centroid > anyOf > item 2 > type` [#](#location--centroid_anyOf_i2_type) **Requirement:** Optional @@ -578,7 +578,7 @@ Centroid represented in GeoJSON format; force point usage with coordinates of lo Specific value: `"Point"` -## `Location > identifier` +## `Location > identifier` [#](#location--identifier) **Requirement:** Optional @@ -593,12 +593,12 @@ The unique geographic identifier for the Location, e.g., the URI or other unique | [item 0](#location--identifier_anyOf_i0) | | [Identifier](#location--identifier_anyOf_i1) | -### `Location > identifier > anyOf > item 0` +### `Location > identifier > anyOf > item 0` [#](#location--identifier_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Location > identifier > anyOf > Identifier` +### `Location > identifier > anyOf > Identifier` [#](#location--identifier_anyOf_i1) inline description of Identifier @@ -607,7 +607,7 @@ inline description of Identifier | **Additional properties** | Any type allowed | | **Defined in** | [Identifier](./identifiers-and-relationships.md#identifier) | -## `Location > otherIdentifier` +## `Location > otherIdentifier` [#](#location--otherIdentifier) **Requirement:** Optional @@ -620,7 +620,7 @@ A list of geographic identifiers for the Location besides the main identifier, e | ----------------------------------------------------------- | ----------------------------------------------------------------------------- | | [Identifier](./identifiers-and-relationships.md#identifier) | A unique identifier and optionally it's scheme and other relevant information | -## `Location > geometry` +## `Location > geometry` [#](#location--geometry) **Requirement:** Optional @@ -692,19 +692,19 @@ Associates a location with a corresponding geometry described in WKT, GeoJSON, o | [item 1](#location--geometry_anyOf_i1) | | [item 2](#location--geometry_anyOf_i2) | -### `Location > geometry > anyOf > item 0` +### `Location > geometry > anyOf > item 0` [#](#location--geometry_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Location > geometry > anyOf > item 1` +### `Location > geometry > anyOf > item 1` [#](#location--geometry_anyOf_i1) String format of the full geometry of the location in WKT, GeoJSON, or GML format | **Type** | `string` | | -------- | -------- | -### `Location > geometry > anyOf > item 2` +### `Location > geometry > anyOf > item 2` [#](#location--geometry_anyOf_i2) Geometry represented in GeoJSON format @@ -712,11 +712,11 @@ Geometry represented in GeoJSON format | ------------------------- | ---------------- | | **Additional properties** | Any type allowed | -#### The following properties are required +#### The following properties are required [#](#location--autogenerated_heading_1) * type * coordinates -## `Location > inScheme` +## `Location > inScheme` [#](#location--inScheme) **Title:** gazetteer @@ -733,12 +733,12 @@ The gazetteer to which the location belongs | [item 0](#location--inScheme_anyOf_i0) | | [ConceptScheme](#location--inScheme_anyOf_i1) | -### `Location > inScheme > anyOf > item 0` +### `Location > inScheme > anyOf > item 0` [#](#location--inScheme_anyOf_i0) | **Type** | `null` | | -------- | ------ | -### `Location > inScheme > anyOf > ConceptScheme` +### `Location > inScheme > anyOf > ConceptScheme` [#](#location--inScheme_anyOf_i1) inline description of the gazetteer @@ -747,7 +747,7 @@ inline description of the gazetteer | **Additional properties** | Any type allowed | | **Defined in** | [ConceptScheme](./identifiers-and-relationships.md#concept-scheme) | -## `Location > altLabel` +## `Location > altLabel` [#](#location--altLabel) **Title:** alternative name @@ -764,7 +764,7 @@ An alternative label or name for a location "DC" ``` -## `Location > prefLabel` +## `Location > prefLabel` [#](#location--prefLabel) **Title:** geographic name @@ -816,7 +816,7 @@ A standard used to measure one aspect of data quality | [inDimension](#metric--inDimension) | string | Mandatory | Represents the dimensions a quality metric, certificate and annotation allow a measurement of. | | [definition](#metric--definition) | null or string | Recommended | Definition of the metric. | -## `Metric > @id` +## `Metric > @id` [#](#metric--@id) **Requirement:** Optional @@ -830,7 +830,7 @@ A standard used to measure one aspect of data quality "https://example.gov/metrics/record-completeness" ``` -## `Metric > @type` +## `Metric > @type` [#](#metric--@type) **Requirement:** Optional @@ -838,7 +838,7 @@ A standard used to measure one aspect of data quality | ----------- | ---------- | | **Default** | `"Metric"` | -## `Metric > expectedDataType` +## `Metric > expectedDataType` [#](#metric--expectedDataType) **Requirement:** Mandatory @@ -858,7 +858,7 @@ Represents the expected data type for the metric's observed value (e.g., xsd:boo "xsd:double" ``` -## `Metric > inDimension` +## `Metric > inDimension` [#](#metric--inDimension) **Requirement:** Mandatory @@ -878,7 +878,7 @@ Represents the dimensions a quality metric, certificate and annotation allow a m "https://www.w3.org/TR/vocab-dqv/#dqv:completeness" ``` -## `Metric > definition` +## `Metric > definition` [#](#metric--definition) **Requirement:** Recommended @@ -931,7 +931,7 @@ A measurement of a resource against a specific quality metric | [value](#quality-measurement--value) | string | Mandatory | The value computed by metric | | [unitMeasure](#quality-measurement--unitMeasure) | null or string | Optional | Unit of measure associated with the value | -## `QualityMeasurement > @id` +## `QualityMeasurement > @id` [#](#quality-measurement--@id) **Requirement:** Optional @@ -945,7 +945,7 @@ A measurement of a resource against a specific quality metric "https://example.gov/quality-measurements/completeness-001" ``` -## `QualityMeasurement > @type` +## `QualityMeasurement > @type` [#](#quality-measurement--@type) **Requirement:** Optional @@ -953,7 +953,7 @@ A measurement of a resource against a specific quality metric | ----------- | ---------------------- | | **Default** | `"QualityMeasurement"` | -## `QualityMeasurement > isMeasurementOf` +## `QualityMeasurement > isMeasurementOf` [#](#quality-measurement--isMeasurementOf) **Requirement:** Mandatory @@ -965,7 +965,7 @@ The metric being observed | **Additional properties** | Any type allowed | | **Defined in** | [Metric](./temporal-spatial-metrics.md#metric) | -## `QualityMeasurement > value` +## `QualityMeasurement > value` [#](#quality-measurement--value) **Requirement:** Mandatory @@ -981,7 +981,7 @@ The value computed by metric "98.5" ``` -## `QualityMeasurement > unitMeasure` +## `QualityMeasurement > unitMeasure` [#](#quality-measurement--unitMeasure) **Title:** unit of measure @@ -1029,7 +1029,7 @@ An activity related to creating, changing, or using a resource | [category](#activity--category) | null or array of [Concept](./identifiers-and-relationships.md#concept) classes | Optional | List of categories for the Activity | | [label](#activity--label) | string | Mandatory | A human-readable label for the activity | -## `Activity > @id` +## `Activity > @id` [#](#activity--@id) **Requirement:** Optional @@ -1043,7 +1043,7 @@ An activity related to creating, changing, or using a resource "https://example.gov/activities/data-processing-001" ``` -## `Activity > @type` +## `Activity > @type` [#](#activity--@type) **Requirement:** Optional @@ -1051,7 +1051,7 @@ An activity related to creating, changing, or using a resource | ----------- | ------------ | | **Default** | `"Activity"` | -## `Activity > category` +## `Activity > category` [#](#activity--category) **Requirement:** Optional @@ -1064,7 +1064,7 @@ List of categories for the Activity | ----------------------------------------------------- | ------------------------------------------------------------------ | | [Concept](./identifiers-and-relationships.md#concept) | A controlled term or label, optionally drawn from a concept scheme | -## `Activity > label` +## `Activity > label` [#](#activity--label) **Requirement:** Mandatory @@ -1119,7 +1119,7 @@ A single physical address | [region](#address--region) | null or string | Recommended | The administrative area of the Address. Depending on the country, this corresponds to a province, a county, a region, or a state | | [street-address](#address--street-address) | null or string | Recommended | The street name and civic number of an Address | -## `Address > @id` +## `Address > @id` [#](#address--@id) **Requirement:** Optional @@ -1133,7 +1133,7 @@ A single physical address "https://example.gov/addresses/hq-001" ``` -## `Address > @type` +## `Address > @type` [#](#address--@type) **Requirement:** Optional @@ -1141,7 +1141,7 @@ A single physical address | ----------- | ----------- | | **Default** | `"Address"` | -## `Address > country-name` +## `Address > country-name` [#](#address--country-name) **Title:** country @@ -1158,7 +1158,7 @@ The country of the Address "United States" ``` -## `Address > locality` +## `Address > locality` [#](#address--locality) **Requirement:** Recommended @@ -1177,7 +1177,7 @@ The city of the Address "Washington" ``` -## `Address > postal-code` +## `Address > postal-code` [#](#address--postal-code) **Requirement:** Recommended @@ -1196,7 +1196,7 @@ The postal code of the Address "20230" ``` -## `Address > region` +## `Address > region` [#](#address--region) **Title:** administrative area @@ -1217,7 +1217,7 @@ The administrative area of the Address. Depending on the country, this correspon "DC" ``` -## `Address > street-address` +## `Address > street-address` [#](#address--street-address) **Requirement:** Recommended diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index 1b4f2b53..99516ebf 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -260,6 +260,40 @@ def _replace_fragment(match): return re.sub(r"\]\(#([^\)]+?)\s*\)", _replace_fragment, content) +def _add_heading_anchor_links(content): + lines = content.splitlines() + + for index, line in enumerate(lines): + inline_match = re.match(r'^(#{1,6}) (.+)$', line) + if inline_match: + heading_marks, anchor_name, heading_text = inline_match.groups() + if f'](#{anchor_name})' not in heading_text: + lines[index] = ( + f'{heading_marks} ' + f'{heading_text} [#](#{anchor_name})' + ) + continue + + anchor_match = re.match(r'^$', line) + if not anchor_match: + continue + + anchor_name = anchor_match.group(1) + next_index = index + 1 + while next_index < len(lines) and not lines[next_index].strip(): + next_index += 1 + + if next_index >= len(lines): + continue + + heading_match = re.match(r'^(#{1,6}) (.+)$', lines[next_index]) + if heading_match and f'](#{anchor_name})' not in lines[next_index]: + heading_marks, heading_text = heading_match.groups() + lines[next_index] = f'{heading_marks} {heading_text} [#](#{anchor_name})' + + return "\n".join(lines) + + def _normalize_doc_content(content, anchor_prefix="", root_anchor="root"): content = content.strip() content = _rewrite_class_doc_links(content) @@ -268,7 +302,7 @@ def _normalize_doc_content(content, anchor_prefix="", root_anchor="root"): anchor_prefix=anchor_prefix, root_anchor=root_anchor, ) - return content + return _add_heading_anchor_links(content) def _write_text(output_path, content): From 521f7f4eafdf5f7e1cb6aa44ae9936d8fe6a9bc7 Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Mon, 27 Apr 2026 23:53:59 -0600 Subject: [PATCH 12/13] Add anchor links to classes Co-authored-by: Copilot --- jsonschema/docs/agents.md | 6 +++--- jsonschema/docs/constraints-and-restrictions.md | 6 +++--- jsonschema/docs/identifiers-and-relationships.md | 10 +++++----- jsonschema/docs/quality-governance.md | 10 +++++----- jsonschema/docs/temporal-spatial-metrics.md | 12 ++++++------ jsonschema/generate_schema_docs.py | 2 +- 6 files changed, 23 insertions(+), 23 deletions(-) diff --git a/jsonschema/docs/agents.md b/jsonschema/docs/agents.md index 5d6d6c13..bfbe6bdd 100644 --- a/jsonschema/docs/agents.md +++ b/jsonschema/docs/agents.md @@ -4,7 +4,7 @@ Data information classes including Agent, Organization, and Kind, which describe -## Class Agent +## Class Agent [#](#agent) A person, organization, software agent, or other entity involved with a resource @@ -90,7 +90,7 @@ The name of the agent -## Class Organization +## Class Organization [#](#organization) An organization involved with a resource, including parent or child organizations @@ -263,7 +263,7 @@ Preferred or legal name of the organization -## Class Kind +## Class Kind [#](#kind) Contact information for an individual or entity diff --git a/jsonschema/docs/constraints-and-restrictions.md b/jsonschema/docs/constraints-and-restrictions.md index 0680670d..b89866f9 100644 --- a/jsonschema/docs/constraints-and-restrictions.md +++ b/jsonschema/docs/constraints-and-restrictions.md @@ -4,7 +4,7 @@ Restriction classes describing access limits, controlled unclassified informatio -## Class AccessRestriction +## Class AccessRestriction [#](#access-restriction) Rules or indicators that describe who can access a resource @@ -127,7 +127,7 @@ inline description of the specific restriction -## Class CUIRestriction +## Class CUIRestriction [#](#cui-restriction) Information describing Controlled Unclassified Information (CUI) restrictions for a resource @@ -248,7 +248,7 @@ List of free-text required indicators from the applicable authority (for example -## Class UseRestriction +## Class UseRestriction [#](#use-restriction) Rules or legal limits on how a resource may be used diff --git a/jsonschema/docs/identifiers-and-relationships.md b/jsonschema/docs/identifiers-and-relationships.md index 766af041..6fc13bc1 100644 --- a/jsonschema/docs/identifiers-and-relationships.md +++ b/jsonschema/docs/identifiers-and-relationships.md @@ -4,7 +4,7 @@ Supporting classes for identifiers, relationships, checksums, and controlled con -## Class Identifier +## Class Identifier [#](#identifier) A unique identifier and optionally it's scheme and other relevant information @@ -181,7 +181,7 @@ abbreviation or code from code lists for an identifier -## Class Relationship +## Class Relationship [#](#relationship) Additional information about how one resource is related to another @@ -274,7 +274,7 @@ The entity related to the dataset. This string should unambiguously identify the -## Class Checksum +## Class Checksum [#](#checksum) A mechanism that can be used to verify that the contents of a distribution have not changed @@ -361,7 +361,7 @@ A lower case hexadecimal encoded digest value produced using a specific algorith -## Class Concept +## Class Concept [#](#concept) A controlled term or label, optionally drawn from a concept scheme @@ -640,7 +640,7 @@ Preferred label for the term -## Class ConceptScheme +## Class ConceptScheme [#](#concept-scheme) A controlled vocabulary or other list of approved terms for a concept diff --git a/jsonschema/docs/quality-governance.md b/jsonschema/docs/quality-governance.md index 2dda8dae..983cc9ff 100644 --- a/jsonschema/docs/quality-governance.md +++ b/jsonschema/docs/quality-governance.md @@ -4,7 +4,7 @@ Supporting classes for standards, documents, catalog records, data services, and -## Class Standard +## Class Standard [#](#standard) A standard or specification that another resource conforms to @@ -454,7 +454,7 @@ inline description of ConceptScheme -## Class Document +## Class Document [#](#document) A publication or other document related to a resource @@ -879,7 +879,7 @@ List of categories/genres for the Document -## Class CatalogRecord +## Class CatalogRecord [#](#catalog-record) A record in a catalog, describing the registration of a single resource @@ -1314,7 +1314,7 @@ A link to the Dataset, Data service or Catalog described in the Catalog Record -## Class DataService +## Class DataService [#](#data-service) A service that provides access to data or data processing functions @@ -2149,7 +2149,7 @@ List of activities that used or tested the data service -## Class Attribution +## Class Attribution [#](#attribution) A responsibility that an agent has for a resource diff --git a/jsonschema/docs/temporal-spatial-metrics.md b/jsonschema/docs/temporal-spatial-metrics.md index 579c70c7..5fde2a41 100644 --- a/jsonschema/docs/temporal-spatial-metrics.md +++ b/jsonschema/docs/temporal-spatial-metrics.md @@ -4,7 +4,7 @@ Supporting classes for time periods, locations, quality metrics, measurements, a -## Class PeriodOfTime +## Class PeriodOfTime [#](#period-of-time) Information about a specific time period with a start- and/or end-time @@ -248,7 +248,7 @@ A year and month in YYYY-MM format -## Class Location +## Class Location [#](#location) A named place or geographic area @@ -789,7 +789,7 @@ Preferred label or name of the Location -## Class Metric +## Class Metric [#](#metric) A standard used to measure one aspect of data quality @@ -901,7 +901,7 @@ Definition of the metric. -## Class QualityMeasurement +## Class QualityMeasurement [#](#quality-measurement) A measurement of a resource against a specific quality metric @@ -1002,7 +1002,7 @@ Unit of measure associated with the value -## Class Activity +## Class Activity [#](#activity) An activity related to creating, changing, or using a resource @@ -1088,7 +1088,7 @@ A human-readable label for the activity -## Class Address +## Class Address [#](#address) A single physical address diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index 99516ebf..c6269b07 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -344,7 +344,7 @@ def _build_public_docs(rendered_docs_dir, output_dir): root_anchor=section_anchor, ) sections.append( - f'\n\n## Class {class_name}\n\n{section_content}' + f'\n\n## Class {class_name} [#](#{section_anchor})\n\n{section_content}' ) page_content = "\n\n---\n\n".join(sections) From 438d0caac165cafdf9afa6f38d360d53bf8431c4 Mon Sep 17 00:00:00 2001 From: jbrown-xentity Date: Tue, 28 Apr 2026 00:35:06 -0600 Subject: [PATCH 13/13] Update documentation links Co-authored-by: Copilot --- jsonschema/docs/catalog.md | 4 ++-- jsonschema/generate_schema_docs.py | 23 +++++++++++++++++++++++ 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/jsonschema/docs/catalog.md b/jsonschema/docs/catalog.md index 005df777..e92a33f8 100644 --- a/jsonschema/docs/catalog.md +++ b/jsonschema/docs/catalog.md @@ -136,7 +136,7 @@ List of related catalogs that are useful in the context of this catalog | Each item of this array must be | Description | | ----------------------------------- | ---------------------------------------------------------------------------------- | -| [DCAT-US 3 Catalog](#catalog_items) | A curated collection of metadata about datasets, data services, or other resources | +| [DCAT-US 3 Catalog](#root) | A curated collection of metadata about datasets, data services, or other resources | ## `DCAT-US 3 Catalog > contactPoint` [#](#contactPoint) @@ -367,7 +367,7 @@ List of catalogs that are contained within this catalog | Each item of this array must be | Description | | ----------------------------------- | ---------------------------------------------------------------------------------- | -| [DCAT-US 3 Catalog](#hasPart_items) | A curated collection of metadata about datasets, data services, or other resources | +| [DCAT-US 3 Catalog](#root) | A curated collection of metadata about datasets, data services, or other resources | ## `DCAT-US 3 Catalog > identifier` [#](#identifier) diff --git a/jsonschema/generate_schema_docs.py b/jsonschema/generate_schema_docs.py index c6269b07..0fe9075c 100644 --- a/jsonschema/generate_schema_docs.py +++ b/jsonschema/generate_schema_docs.py @@ -294,6 +294,22 @@ def _add_heading_anchor_links(content): return "\n".join(lines) +def _rewrite_unresolved_self_item_links(content, page_title): + anchors = set(re.findall(r'', content)) + self_labels = {page_title, f"DCAT-US 3 {page_title}"} + + def _replace(match): + label = match.group(1) + fragment = match.group(2) + if fragment in anchors: + return match.group(0) + if fragment.endswith("_items") and label in self_labels: + return f"[{label}](#root)" + return match.group(0) + + return re.sub(r'\[([^\]]+)\]\(#([^\)]+)\)', _replace, content) + + def _normalize_doc_content(content, anchor_prefix="", root_anchor="root"): content = content.strip() content = _rewrite_class_doc_links(content) @@ -329,6 +345,7 @@ def _build_public_docs(rendered_docs_dir, output_dir): for page in MAIN_CLASS_PAGES: raw_content = _read_generated_doc(rendered_docs_dir, page["source"]) page_content = _normalize_doc_content(raw_content, root_anchor="root") + page_content = _rewrite_unresolved_self_item_links(page_content, page["title"]) page_content = f'\n\n{page["intro"]}\n\n{page_content}' _write_text(output_dir / page["output"], page_content) @@ -514,6 +531,12 @@ def array_items_restrictions_wrap(items_restrictions, schema): canonical_link = _canonical_class_doc_link(item) if canonical_link: row[0] = canonical_link + continue + + item_title = getattr(item, "title", None) + schema_title = getattr(schema, "title", None) + if item_title and schema_title and item_title == schema_title: + row[0] = f"[{item_title}](#root)" return items_restrictions