From d1ee510e28e48ca0366e9b631e1b95612bad1174 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Thu, 7 May 2026 23:14:42 +0200 Subject: [PATCH 1/8] Add spatial extent to dataset #309 --- .../v2/v21/build_source/schemas/dataset.json | 31 +++++++++++++++++++ oemetadata/v2/v21/metadata_key_description.md | 3 ++ 2 files changed, 34 insertions(+) diff --git a/oemetadata/v2/v21/build_source/schemas/dataset.json b/oemetadata/v2/v21/build_source/schemas/dataset.json index 5ffa26c8..35df0577 100644 --- a/oemetadata/v2/v21/build_source/schemas/dataset.json +++ b/oemetadata/v2/v21/build_source/schemas/dataset.json @@ -66,6 +66,37 @@ "badge": "Bronze", "title": "Dataset Description" }, + "extent": { + "description": "An object that describes a covered area or region of the dataset.", + "type": "object", + "properties": { + "name": { + "description": "The name of the spatial region of the dataset.", + "type": [ + "string", + "null" + ], + "examples": [ + "Europe" + ], + "badge": "Silver", + "title": "Dataset Extent Name" + }, + "@id": { + "description": "A URI reference for the region of the dataset.", + "type": [ + "string", + "null" + ], + "examples": [ + "https://www.wikidata.org/wiki/Q458" + ], + "format": "uri", + "badge": "Platinum", + "title": "Dataset Extent Identifier" + } + } + }, "topics": { "description": "An array of predefined topics that correspond to the database schemas of the OEP.", "type": "array", diff --git a/oemetadata/v2/v21/metadata_key_description.md b/oemetadata/v2/v21/metadata_key_description.md index 0df4d1b7..5ced9330 100644 --- a/oemetadata/v2/v21/metadata_key_description.md +++ b/oemetadata/v2/v21/metadata_key_description.md @@ -39,6 +39,9 @@ If a value is not yet available, use: `ToDo`. | 3 | name | A filename or database conform dataset name. | oep_oemetadata | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] | | 4 | title | A human readable dataset name. | OEP OEMetadata | [dct:title](http://purl.org/dc/terms/title) | Bronze | [0..1] | | 5 | description | A free text description of the dataset. | A collection of tables for the OEMetadata examples. | [dct:description](http://purl.org/dc/terms/description) | Bronze | [0..1] | +| 6 | **spatial** | An object that describes a covered area or region of the dataset. | | [oeo:spatial region](http://purl.obolibrary.org/obo/BFO_0000006) | | [0..1] | +| 6.1 | region | The name of the spatial region of the dataset. | Berlin | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Silver | [0..1] | +| 6.2 | @id | A URI reference for the region of the dataset. | [www.wikidata.org/wiki/Q64](https://www.wikidata.org/wiki/Q64) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] | | 6 | languages | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE | [dct:language](http://purl.org/dc/terms/language) | Gold | [*] | | 7 | version | A version string identifying the version of the package. | 0.1.0 | [dcat:version](https://www.w3.org/ns/dcat#version) | Silver | [0..1] | | 8 | image | An image to use for this data package. | https://openenergyplatform.org/static/img/about/OpenEnergyFamily_GroupPhoto2.png | [schema.org:image](https://schema.org/image) | Gold | [0..1] | From 251bdfbeb58f88907e0741fc18d2f4485328559d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Thu, 7 May 2026 23:16:40 +0200 Subject: [PATCH 2/8] Update schema #309 --- oemetadata/v2/v21/example.json | 4 ++++ oemetadata/v2/v21/schema.json | 31 +++++++++++++++++++++++++++++++ oemetadata/v2/v21/template.json | 4 ++++ 3 files changed, 39 insertions(+) diff --git a/oemetadata/v2/v21/example.json b/oemetadata/v2/v21/example.json index 5c80deb9..4c936ee3 100644 --- a/oemetadata/v2/v21/example.json +++ b/oemetadata/v2/v21/example.json @@ -4,6 +4,10 @@ "name": "oep_oemetadata", "title": "OEP OEMetadata Dataset", "description": "A dataset for the OEMetadata examples.", + "extent": { + "name": "Europe", + "@id": "https://www.wikidata.org/wiki/Q458" + }, "topics": [ "model_draft" ], diff --git a/oemetadata/v2/v21/schema.json b/oemetadata/v2/v21/schema.json index 239b1a9a..c7638ea5 100644 --- a/oemetadata/v2/v21/schema.json +++ b/oemetadata/v2/v21/schema.json @@ -70,6 +70,37 @@ "badge": "Bronze", "title": "Dataset Description" }, + "extent": { + "description": "An object that describes a covered area or region of the dataset.", + "type": "object", + "properties": { + "name": { + "description": "The name of the spatial region of the dataset.", + "type": [ + "string", + "null" + ], + "examples": [ + "Europe" + ], + "badge": "Silver", + "title": "Dataset Extent Name" + }, + "@id": { + "description": "A URI reference for the region of the dataset.", + "type": [ + "string", + "null" + ], + "examples": [ + "https://www.wikidata.org/wiki/Q458" + ], + "format": "uri", + "badge": "Platinum", + "title": "Dataset Extent Identifier" + } + } + }, "topics": { "description": "An array of predefined topics that correspond to the database schemas of the OEP.", "type": "array", diff --git a/oemetadata/v2/v21/template.json b/oemetadata/v2/v21/template.json index 1bb82c22..16fe39da 100644 --- a/oemetadata/v2/v21/template.json +++ b/oemetadata/v2/v21/template.json @@ -4,6 +4,10 @@ "name": "", "title": "", "description": "", + "extent": { + "name": "", + "@id": "" + }, "topics": [ "" ], From e283717813f33cf36ffbe917f6597855a57b557c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Thu, 7 May 2026 23:29:10 +0200 Subject: [PATCH 3/8] Remove topics #309 --- .../v2/v21/build_source/schemas/dataset.json | 18 ------------------ oemetadata/v2/v21/example.json | 3 --- oemetadata/v2/v21/schema.json | 18 ------------------ oemetadata/v2/v21/template.json | 3 --- 4 files changed, 42 deletions(-) diff --git a/oemetadata/v2/v21/build_source/schemas/dataset.json b/oemetadata/v2/v21/build_source/schemas/dataset.json index 35df0577..7dd7e56b 100644 --- a/oemetadata/v2/v21/build_source/schemas/dataset.json +++ b/oemetadata/v2/v21/build_source/schemas/dataset.json @@ -97,24 +97,6 @@ } } }, - "topics": { - "description": "An array of predefined topics that correspond to the database schemas of the OEP.", - "type": "array", - "items": { - "description": "The topics are used to group the data in the database.", - "type": [ - "string", - "null" - ], - "examples": [ - "model_draft" - ], - "badge": "Bronze", - "title": "Topic" - }, - "badge": "Bronze", - "title": "Topics" - }, "languages": { "description": "An array of languages used within the described data structures (e.g. titles, descriptions) or metadata.", "type": "array", diff --git a/oemetadata/v2/v21/example.json b/oemetadata/v2/v21/example.json index 4c936ee3..db4ef260 100644 --- a/oemetadata/v2/v21/example.json +++ b/oemetadata/v2/v21/example.json @@ -8,9 +8,6 @@ "name": "Europe", "@id": "https://www.wikidata.org/wiki/Q458" }, - "topics": [ - "model_draft" - ], "languages": [ "en-GB", "de-DE" diff --git a/oemetadata/v2/v21/schema.json b/oemetadata/v2/v21/schema.json index c7638ea5..9abb86d8 100644 --- a/oemetadata/v2/v21/schema.json +++ b/oemetadata/v2/v21/schema.json @@ -101,24 +101,6 @@ } } }, - "topics": { - "description": "An array of predefined topics that correspond to the database schemas of the OEP.", - "type": "array", - "items": { - "description": "The topics are used to group the data in the database.", - "type": [ - "string", - "null" - ], - "examples": [ - "model_draft" - ], - "badge": "Bronze", - "title": "Topic" - }, - "badge": "Bronze", - "title": "Topics" - }, "languages": { "description": "An array of languages used within the described data structures (e.g. titles, descriptions) or metadata.", "type": "array", diff --git a/oemetadata/v2/v21/template.json b/oemetadata/v2/v21/template.json index 16fe39da..58322c71 100644 --- a/oemetadata/v2/v21/template.json +++ b/oemetadata/v2/v21/template.json @@ -8,9 +8,6 @@ "name": "", "@id": "" }, - "topics": [ - "" - ], "languages": [ "" ], From e8c9db86617ed2fffae8fe8d90d4cb2a39660ec3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Thu, 7 May 2026 23:32:19 +0200 Subject: [PATCH 4/8] Add Readme to core files #309 --- oemetadata/v2/v21/build_source/schemas/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 oemetadata/v2/v21/build_source/schemas/README.md diff --git a/oemetadata/v2/v21/build_source/schemas/README.md b/oemetadata/v2/v21/build_source/schemas/README.md new file mode 100644 index 00000000..75d3a8f6 --- /dev/null +++ b/oemetadata/v2/v21/build_source/schemas/README.md @@ -0,0 +1,10 @@ + + +# OEMetadata Core Files + +The schemas are the core of the OEMetadata specification.
+They are separated by category and follow the logic of OEMetadata structure. From 247d11178a2e527398d681075e57714a6762956e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Thu, 7 May 2026 23:37:36 +0200 Subject: [PATCH 5/8] Add reference date for dataset #309 --- .../v2/v21/build_source/schemas/dataset.json | 13 +++++++++++++ oemetadata/v2/v21/example.json | 1 + oemetadata/v2/v21/metadata_key_description.md | 17 +++++++++-------- oemetadata/v2/v21/schema.json | 13 +++++++++++++ oemetadata/v2/v21/template.json | 1 + 5 files changed, 37 insertions(+), 8 deletions(-) diff --git a/oemetadata/v2/v21/build_source/schemas/dataset.json b/oemetadata/v2/v21/build_source/schemas/dataset.json index 7dd7e56b..91fb14e3 100644 --- a/oemetadata/v2/v21/build_source/schemas/dataset.json +++ b/oemetadata/v2/v21/build_source/schemas/dataset.json @@ -97,6 +97,19 @@ } } }, + "referenceDate": { + "description": "A base year, month or day. The time for which the dataset should be accurate. Date Format is ISO 8601.", + "type": [ + "string", + "null" + ], + "examples": [ + "2020-01-01" + ], + "badge": "Silver", + "title": "Dataset Reference Date", + "format": "date" + }, "languages": { "description": "An array of languages used within the described data structures (e.g. titles, descriptions) or metadata.", "type": "array", diff --git a/oemetadata/v2/v21/example.json b/oemetadata/v2/v21/example.json index db4ef260..7934d386 100644 --- a/oemetadata/v2/v21/example.json +++ b/oemetadata/v2/v21/example.json @@ -8,6 +8,7 @@ "name": "Europe", "@id": "https://www.wikidata.org/wiki/Q458" }, + "referenceDate": "2020-01-01", "languages": [ "en-GB", "de-DE" diff --git a/oemetadata/v2/v21/metadata_key_description.md b/oemetadata/v2/v21/metadata_key_description.md index 5ced9330..2eb750ea 100644 --- a/oemetadata/v2/v21/metadata_key_description.md +++ b/oemetadata/v2/v21/metadata_key_description.md @@ -41,14 +41,15 @@ If a value is not yet available, use: `ToDo`. | 5 | description | A free text description of the dataset. | A collection of tables for the OEMetadata examples. | [dct:description](http://purl.org/dc/terms/description) | Bronze | [0..1] | | 6 | **spatial** | An object that describes a covered area or region of the dataset. | | [oeo:spatial region](http://purl.obolibrary.org/obo/BFO_0000006) | | [0..1] | | 6.1 | region | The name of the spatial region of the dataset. | Berlin | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Silver | [0..1] | -| 6.2 | @id | A URI reference for the region of the dataset. | [www.wikidata.org/wiki/Q64](https://www.wikidata.org/wiki/Q64) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] | -| 6 | languages | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE | [dct:language](http://purl.org/dc/terms/language) | Gold | [*] | -| 7 | version | A version string identifying the version of the package. | 0.1.0 | [dcat:version](https://www.w3.org/ns/dcat#version) | Silver | [0..1] | -| 8 | image | An image to use for this data package. | https://openenergyplatform.org/static/img/about/OpenEnergyFamily_GroupPhoto2.png | [schema.org:image](https://schema.org/image) | Gold | [0..1] | -| 9 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | - | [*] | -| 9.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] | -| 9.2 | @id | A unique identifier (URI/IRI) of the ontology class. | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) | [dct:subject](http://purl.org/dc/terms/subject) | Platinum | [0..1] | -| 10 | keywords | An array of freely selectable keywords that help with searching and structuring. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] | +| 6.2 | @id | A URI reference for the region of the dataset. | [www.wikidata.org/wiki/Q64](https://www.wikidata.org/wiki/Q64) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] | +| 7 | referenceDate | A base year, month or day. The time for which the dataset should be accurate. Date Format is ISO 8601. | 2020-01-01 | [dct:date](http://purl.org/dc/terms/date) | Silver | [0..1] | +| 8 | languages | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE | [dct:language](http://purl.org/dc/terms/language) | Gold | [*] | +| 9 | version | A version string identifying the version of the package. | 0.1.0 | [dcat:version](https://www.w3.org/ns/dcat#version) | Silver | [0..1] | +| 10 | image | An image to use for this data package. | https://openenergyplatform.org/static/img/about/OpenEnergyFamily_GroupPhoto2.png | [schema.org:image](https://schema.org/image) | Gold | [0..1] | +| 11 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | - | [*] | +| 11.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] | +| 11.2 | @id | A unique identifier (URI/IRI) of the ontology class. | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) | [dct:subject](http://purl.org/dc/terms/subject) | Platinum | [0..1] | +| 12 | keywords | An array of freely selectable keywords that help with searching and structuring. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] | ### Dataset - Project Context Keys |
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| diff --git a/oemetadata/v2/v21/schema.json b/oemetadata/v2/v21/schema.json index 9abb86d8..e4eed2b9 100644 --- a/oemetadata/v2/v21/schema.json +++ b/oemetadata/v2/v21/schema.json @@ -101,6 +101,19 @@ } } }, + "referenceDate": { + "description": "A base year, month or day. The time for which the dataset should be accurate. Date Format is ISO 8601.", + "type": [ + "string", + "null" + ], + "examples": [ + "2020-01-01" + ], + "badge": "Silver", + "title": "Dataset Reference Date", + "format": "date" + }, "languages": { "description": "An array of languages used within the described data structures (e.g. titles, descriptions) or metadata.", "type": "array", diff --git a/oemetadata/v2/v21/template.json b/oemetadata/v2/v21/template.json index 58322c71..398d6e30 100644 --- a/oemetadata/v2/v21/template.json +++ b/oemetadata/v2/v21/template.json @@ -8,6 +8,7 @@ "name": "", "@id": "" }, + "referenceDate": "", "languages": [ "" ], From 9d795847b2489b719f7bdf48d5ea06119b2c24f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Thu, 7 May 2026 23:55:15 +0200 Subject: [PATCH 6/8] Update review link #309 --- oemetadata/v2/v21/build_source/schemas/review.json | 2 +- oemetadata/v2/v21/example.json | 4 ++-- oemetadata/v2/v21/schema.json | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/oemetadata/v2/v21/build_source/schemas/review.json b/oemetadata/v2/v21/build_source/schemas/review.json index 9c87e1ef..fc089009 100644 --- a/oemetadata/v2/v21/build_source/schemas/review.json +++ b/oemetadata/v2/v21/build_source/schemas/review.json @@ -14,7 +14,7 @@ "null" ], "examples": [ - "https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/" + "https://openenergyplatform.org/database/" ], "badge": null, "title": "Path", diff --git a/oemetadata/v2/v21/example.json b/oemetadata/v2/v21/example.json index 7934d386..c671937d 100644 --- a/oemetadata/v2/v21/example.json +++ b/oemetadata/v2/v21/example.json @@ -84,7 +84,7 @@ } ], "review": { - "path": "https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/", + "path": "https://openenergyplatform.org/database/", "badge": "Platinum" }, "resources": [ @@ -388,7 +388,7 @@ "decimalSeparator": "." }, "review": { - "path": "https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/", + "path": "https://openenergyplatform.org/database/", "badge": "Platinum" } } diff --git a/oemetadata/v2/v21/schema.json b/oemetadata/v2/v21/schema.json index e4eed2b9..13b66d31 100644 --- a/oemetadata/v2/v21/schema.json +++ b/oemetadata/v2/v21/schema.json @@ -550,7 +550,7 @@ "null" ], "examples": [ - "https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/" + "https://openenergyplatform.org/database/" ], "badge": null, "title": "Path", @@ -1657,7 +1657,7 @@ "null" ], "examples": [ - "https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/" + "https://openenergyplatform.org/database/" ], "badge": null, "title": "Path", From ccb873fe6fecbcd774f2090af5a1c1eb2c61a623 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Fri, 8 May 2026 00:00:09 +0200 Subject: [PATCH 7/8] Update changelog #309 --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 00f14c0c..5901de67 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Add `mappingRelation` to `isAbout` [(#307)](https://github.com/OpenEnergyPlatform/oemetadata/pull/307) - Add `mappingRelation` to `valueReference` [(#307)](https://github.com/OpenEnergyPlatform/oemetadata/pull/307) - Tests for example and template to be valid frictionless datapackage [(#305)](https://github.com/OpenEnergyPlatform/oemetadata/pull/305) +- Add spatial information to dataset [(#310)](https://github.com/OpenEnergyPlatform/oemetadata/pull/310) +- Add temporal information to dataset [(#310)](https://github.com/OpenEnergyPlatform/oemetadata/pull/310) ### Changed - Update TLDR URL in example sourceLicenses [(#275)](https://github.com/OpenEnergyPlatform/oemetadata/pull/275) @@ -30,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Update python env instructions to latest version [(#284)](https://github.com/OpenEnergyPlatform/oemetadata/pull/284) ### Removed +- Remove topics from dataset [(#310)](https://github.com/OpenEnergyPlatform/oemetadata/pull/310) ## [2.0.4] - Patch Release - Patch Dataset Id - 2025-03-11 From 99cd198db622f88ffbf579c37cf0413086b925e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ludwig=20H=C3=BClk?= Date: Fri, 8 May 2026 20:45:20 +0200 Subject: [PATCH 8/8] Reload topics for resources #309 --- CHANGELOG.md | 1 - .../v2/v21/build_source/schemas/general.json | 18 +++ oemetadata/v2/v21/example.json | 3 + oemetadata/v2/v21/metadata_key_description.md | 21 ++-- oemetadata/v2/v21/metadata_key_details.md | 104 ++++++++++-------- oemetadata/v2/v21/schema.json | 18 +++ oemetadata/v2/v21/template.json | 3 + 7 files changed, 110 insertions(+), 58 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5901de67..3c02aca9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -32,7 +32,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Update python env instructions to latest version [(#284)](https://github.com/OpenEnergyPlatform/oemetadata/pull/284) ### Removed -- Remove topics from dataset [(#310)](https://github.com/OpenEnergyPlatform/oemetadata/pull/310) ## [2.0.4] - Patch Release - Patch Dataset Id - 2025-03-11 diff --git a/oemetadata/v2/v21/build_source/schemas/general.json b/oemetadata/v2/v21/build_source/schemas/general.json index 8b28ebf3..0ffc751b 100644 --- a/oemetadata/v2/v21/build_source/schemas/general.json +++ b/oemetadata/v2/v21/build_source/schemas/general.json @@ -53,6 +53,24 @@ "badge": "Silver", "title": "Title" }, + "topics": { + "description": "An array of predefined topics that correspond to the database schemas of the OEP.", + "type": "array", + "items": { + "description": "The topics are used to group the data in the database.", + "type": [ + "string", + "null" + ], + "examples": [ + "model_draft" + ], + "badge": "Bronze", + "title": "Topic" + }, + "badge": "Bronze", + "title": "Topics" + }, "description": { "description": "A description of the table. It should be usable as summary information for the table that is described by the metadata.", "type": [ diff --git a/oemetadata/v2/v21/example.json b/oemetadata/v2/v21/example.json index c671937d..2f693135 100644 --- a/oemetadata/v2/v21/example.json +++ b/oemetadata/v2/v21/example.json @@ -93,6 +93,9 @@ "path": "example.csv", "name": "example.csv", "title": "OEMetadata Table Example", + "topics": [ + "model_draft" + ], "description": "Example metadata and table used to illustrate the OEMetadata structure and features.", "publicationDate": "2024-10-15", "subject": [ diff --git a/oemetadata/v2/v21/metadata_key_description.md b/oemetadata/v2/v21/metadata_key_description.md index 2eb750ea..aeecb16a 100644 --- a/oemetadata/v2/v21/metadata_key_description.md +++ b/oemetadata/v2/v21/metadata_key_description.md @@ -108,16 +108,17 @@ If a value is not yet available, use: `ToDo`. | 2 | path | A unique identifier (URI/UUID/DOI) for the table or file. | [oemetadata_table_template](https://openenergyplatform.org/database/tables/oemetadata_table_template) | [dcat:accessURL](https://www.w3.org/ns/dcat#accessURL) | Bronze | [0..1] | | 3 | name | A filename or database conform table name. | oemetadata_table_template | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] | | 4 | title | A human readable resource or table name. | OEMetadata Table | [dct:title](http://purl.org/dc/terms/title) | Silver | [0..1] | -| 5 | description | A description of the table. It should be usable as summary information for the table that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Silver | [0..1] | -| 6 | publicationDate | A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD). | 2024-10-15 | [dct:issued](http://purl.org/dc/terms/issued) | Bronze | [0..1] | -| 7 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | | [*] | -| 7.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] | -| 7.2 | @id | A unique identifier (URI/IRI) of the ontology class. | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) | [dct:subject](http://purl.org/dc/terms/subject) | Platinum | [0..1] | -| 8 | keywords | An array of freely selectable keywords that help with searching and structuring. The keyword are used and managed in the OEP as table tags. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] | -| 9 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. | | | | [0..1] | -| 9.1 | start | The start date of the embargo period. The date of the data (metadata) upload. | 2024-10-11 | [dbo:startDateTime](https://dbpedia.org/ontology/startDateTime) | Bronze | [0..1] | -| 9.2 | end | The end date of the embargo period. This is the envisioned publication date. | 2025-01-01 | [dbo:endDateTime](https://dbpedia.org/ontology/endDateTime) | Bronze | [0..1] | -| 9.3 | isActive | A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. | True | [adms:status](http://www.w3.org/ns/adms#status) | Bronze | [0..1] | +| 5 | topics | An array of predefined topics that correspond to the database schemas of the OEP. | model_draft | [foaf:topic](http://xmlns.com/foaf/spec/#term_topic) | Bronze | [*] | +| 6 | description | A description of the table. It should be usable as summary information for the table that is described by the metadata. | Example table used to illustrate the OEMetadata structure and features. | [dct:description](http://purl.org/dc/terms/description) | Silver | [0..1] | +| 7 | publicationDate | A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD). | 2024-10-15 | [dct:issued](http://purl.org/dc/terms/issued) | Bronze | [0..1] | +| 8 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | | | | [*] | +| 8.1 | name | A class label of the ontology term. | energy | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Platinum | [0..1] | +| 8.2 | @id | A unique identifier (URI/IRI) of the ontology class. | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) | [dct:subject](http://purl.org/dc/terms/subject) | Platinum | [0..1] | +| 9 | keywords | An array of freely selectable keywords that help with searching and structuring. The keyword are used and managed in the OEP as table tags. | example, ODbL-1.0, NFDI4Energy | [dcat:keyword](http://www.w3.org/ns/dcat#keyword) | Silver | [*] | +| 10 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. | | | | [0..1] | +| 10.1 | start | The start date of the embargo period. The date of the data (metadata) upload. | 2024-10-11 | [dbo:startDateTime](https://dbpedia.org/ontology/startDateTime) | Bronze | [0..1] | +| 10.2 | end | The end date of the embargo period. This is the envisioned publication date. | 2025-01-01 | [dbo:endDateTime](https://dbpedia.org/ontology/endDateTime) | Bronze | [0..1] | +| 10.3 | isActive | A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. | True | [adms:status](http://www.w3.org/ns/adms#status) | Bronze | [0..1] | ### Resources - Spatial Keys |
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| diff --git a/oemetadata/v2/v21/metadata_key_details.md b/oemetadata/v2/v21/metadata_key_details.md index 5ccd905b..bb2ef8a9 100644 --- a/oemetadata/v2/v21/metadata_key_details.md +++ b/oemetadata/v2/v21/metadata_key_details.md @@ -484,7 +484,7 @@ If a value is not yet available, use: `ToDo`. | **Badge** | | | **Card.** | [*] | -### Resources - @id +### Resources - General - @id | | | |----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Key | @id | @@ -494,7 +494,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Platinum | | Card. | [0..1] | -### Resources - path +### Resources - General - path | | | |----------------|----------------------------------------------------------------------------------------------------------------------------| | Key | path | @@ -504,7 +504,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - name +### Resources - General - name | | | |----------------|------------------------------------------------------------| | Key | name | @@ -514,7 +514,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Iron | | Card. | [1] | -### Resources - title +### Resources - General - title | | | |----------------|---------------------------------------------| | Key | title | @@ -524,7 +524,17 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - description +### Resource - General - topics +| | | +|----------------|-----------------------------------------------------------------------------------| +| Key | topics | +| Description | An array of predefined topics that correspond to the database schemas of the OEP. | +| Example | model_draft | +| Ontology Class | [foaf:topic](http://xmlns.com/foaf/spec/#term_topic) | +| Badge | Bronze | +| Card. | [*] | + +### Resources - General - description | | | |----------------|-------------------------------------------------------------------------------------------------------------------------| | Key | description | @@ -534,7 +544,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - publicationDate +### Resources - General - publicationDate | | | |----------------|------------------------------------------------------------------------------------------| | Key | publicationDate | @@ -544,7 +554,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - subject +### Resources - General - subject | | | |----------------|-------------------------------------------------------------------------------------| | Key | subject | @@ -554,7 +564,7 @@ If a value is not yet available, use: `ToDo`. | Badge | | | Card. | [*] | -### Resources - subject (name) +### Resources - General - subject (name) | | | |----------------|------------------------------------------------------------| | Key | name | @@ -564,7 +574,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Platinum | | Card. | [0..1] | -### Resources - subject (@id) +### Resources - General - subject (@id) | | | |----------------|--------------------------------------------------------------------------------------------------------------| | Key | @id | @@ -574,7 +584,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Platinum | | Card. | [0..1] | -### Resources - keywords +### Resources - General - keywords | | | |----------------|----------------------------------------------------------------------------------| | Key | keywords | @@ -584,7 +594,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [*] | -### Resources - embargoPeriod +### Resources - General - embargoPeriod | | | |----------------|----------------------------------------------------------------------------------------------------| | Key | embargoPeriod | @@ -594,7 +604,7 @@ If a value is not yet available, use: `ToDo`. | Badge | | | Card. | [0..1] | -### Resources - embargoPeriod (start) +### Resources - General - embargoPeriod (start) | | | |----------------|-------------------------------------------------------------------------------| | Key | start | @@ -604,7 +614,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - embargoPeriod (end) +### Resources - General - embargoPeriod (end) | | | |----------------|------------------------------------------------------------------------------| | Key | end | @@ -614,7 +624,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - embargoPeriod (isActive) +### Resources - General - embargoPeriod (isActive) | | | |----------------|----------------------------------------------------------------------------------------------------------------------------------| | Key | isActive | @@ -624,7 +634,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - spatial +### Resources - Spatial | | | |----------------|-----------------------------------------------------------| | Key | spatial | @@ -634,7 +644,7 @@ If a value is not yet available, use: `ToDo`. | Badge | | | Card. | [0..1] | -### Resources - spatial (location) +### Resources - Spatial - location | | | |----------------|---------------------------------------------------| | Key | location | @@ -644,7 +654,7 @@ If a value is not yet available, use: `ToDo`. | Badge | | | Card. | [0..1] | -### Resources - spatial (location - address) +### Resources - Spatial - location (address) | | | |----------------|-------------------------------------------------------------------------------------------------------------------| | Key | address | @@ -654,7 +664,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - spatial (location - @id) +### Resources - Spatial - location (@id) | | | |----------------|-----------------------------------------------------------------------------| | Key | @id | @@ -664,7 +674,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Platinum | | Card. | [0..1] | -### Resources - spatial (location - latitude) +### Resources - Spatial - location (latitude) | | | |----------------|-------------------------------------------------| | Key | latitude | @@ -674,7 +684,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Gold | | Card. | [0..1] | -### Resources - spatial (location - longitude) +### Resources - Spatial - location (longitude) | | | |----------------|--------------------------------------------------| | Key | longitude | @@ -684,7 +694,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Gold | | Card. | [0..1] | -### Resources - spatial (extent) +### Resources - Spatial - extent | | | |----------------|------------------------------------------------------------------| | Key | extent | @@ -694,7 +704,7 @@ If a value is not yet available, use: `ToDo`. | Badge | | | Card. | [0..1] | -### Resources - spatial (extent - name) +### Resources - Spatial - extent (name) | | | |----------------|------------------------------------------------------------| | Key | name | @@ -704,7 +714,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - spatial (extent - @id) +### Resources - Spatial - extent (@id) | | | |----------------|----------------------------------------------------------------| | Key | @id | @@ -714,7 +724,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Platinum | | Card. | [0..1] | -### Resources - spatial (extent - resolutionValue) +### Resources - Spatial - extent (resolutionValue) | | | |----------------|---------------------------------------------------------------------------------------| | Key | resolutionValue | @@ -724,7 +734,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - spatial (extent - resolutionUnit) +### Resources - Spatial - extent (resolutionUnit) | | | |----------------|---------------------------------------------------------------------| | Key | resolutionUnit | @@ -734,7 +744,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - spatial (extent - boundingBox) +### Resources - Spatial - extent (boundingBox) | | | |----------------|-------------------------------------------------------------------------------------------------------------------------------| | Key | boundingBox | @@ -744,7 +754,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Gold | | Card. | [*] | -### Resources - spatial (extent - crs) +### Resources - Spatial - extent (crs) | | | |----------------|------------------------------------------------------------------------------------------------------------------------------------------| | Key | crs | @@ -754,7 +764,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Gold | | Card. | [0..1] | -### Resources - temporal +### Resources - Temporal | | | |----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | Key | temporal | @@ -764,7 +774,7 @@ If a value is not yet available, use: `ToDo`. | Badge | | | Card. | [0..1] | -### Resources - temporal (referenceDate) +### Resources - Temporal - referenceDate | | | |----------------|-----------------------------------------------------------------------------------------------------| | Key | referenceDate | @@ -774,7 +784,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - temporal (timeseries) +### Resources - Temporal - timeseries | | | |----------------|-----------------------------------------------------------| | Key | timeseries | @@ -784,7 +794,7 @@ If a value is not yet available, use: `ToDo`. | Badge | | | Card. | [*] | -### Resources - temporal (timeseries - start) +### Resources - Temporal - timeseries (start) | | | |----------------|-----------------------------------------------------------------| | Key | start | @@ -794,7 +804,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - temporal (timeseries - end) +### Resources - Temporal - timeseries (end) | | | |----------------|-------------------------------------------------------------| | Key | end | @@ -804,7 +814,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - temporal (timeseries - resolutionValue) +### Resources - Temporal - timeseries (resolutionValue) | | | |----------------|----------------------------------------------------------------------------------------------------| | Key | resolutionValue | @@ -814,7 +824,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - temporal (timeseries - resolutionUnit) +### Resources - Temporal - timeseries (resolutionUnit) | | | |----------------|---------------------------------------------------------------------| | Key | resolutionUnit | @@ -824,7 +834,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - temporal (timeseries - alignment) +### Resources - Temporal - timeseries (alignment) | | | |----------------|----------------------------------------------------------------------------------------------| | Key | alignment | @@ -834,7 +844,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Silver | | Card. | [0..1] | -### Resources - temporal (timeseries - aggregationType) +### Resources - Temporal - timeseries (aggregationType) | | | |----------------|-----------------------------------------------------------------------------------| | Key | aggregationType | @@ -856,7 +866,7 @@ If a value is not yet available, use: `ToDo`. | Badge | | | Card. | [*] | -### Resources - sources (title) +### Resources - sources - title | | | |----------------|------------------------------------------------------------------------------| | Key | title | @@ -866,7 +876,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - sources (authors) +### Resources - sources - authors | | | |----------------|-------------------------------------------------------------------------| | Key | authors | @@ -876,7 +886,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [*] | -### Resources - sources (description) +### Resources - sources - description | | | |----------------|-----------------------------------------------------------| | Key | description | @@ -886,7 +896,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - sources (publicationYear) +### Resources - sources - publicationYear | | | |----------------|-------------------------------------------------| | Key | publicationYear | @@ -896,7 +906,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - sources (path) +### Resources - sources - path | | | |----------------|----------------------------------------------------------------------------------------------------------------| | Key | path | @@ -986,7 +996,7 @@ If a value is not yet available, use: `ToDo`. | Badge | | | Card. | [*] | -### Resources - resourceLicenses (name) +### Resources - resourceLicenses - name | | | |----------------|------------------------------------------------------------| | Key | name | @@ -996,7 +1006,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - resourceLicenses (title) +### Resources - resourceLicenses - title | | | |----------------|-----------------------------------------------------| | Key | title | @@ -1006,7 +1016,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - resourceLicenses (path) +### Resources - resourceLicenses - path | | | |----------------|--------------------------------------------------------------------------------------------------------------| | Key | path | @@ -1016,7 +1026,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - resourceLicenses (instruction) +### Resources - resourceLicenses - instruction | | | |----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Key | instruction | @@ -1026,7 +1036,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - resourceLicenses (attribution) +### Resources - resourceLicenses - attribution | | | |----------------|---------------------------------------------------------------------------------------| | Key | attribution | @@ -1036,7 +1046,7 @@ If a value is not yet available, use: `ToDo`. | Badge | Bronze | | Card. | [0..1] | -### Resources - resourceLicenses (copyrightStatement) +### Resources - resourceLicenses - copyrightStatement | | | |----------------|---------------------------------------------------------------------------------------------------------------------| | Key | copyrightStatement | diff --git a/oemetadata/v2/v21/schema.json b/oemetadata/v2/v21/schema.json index 13b66d31..41f45a2f 100644 --- a/oemetadata/v2/v21/schema.json +++ b/oemetadata/v2/v21/schema.json @@ -630,6 +630,24 @@ "badge": "Silver", "title": "Title" }, + "topics": { + "description": "An array of predefined topics that correspond to the database schemas of the OEP.", + "type": "array", + "items": { + "description": "The topics are used to group the data in the database.", + "type": [ + "string", + "null" + ], + "examples": [ + "model_draft" + ], + "badge": "Bronze", + "title": "Topic" + }, + "badge": "Bronze", + "title": "Topics" + }, "description": { "description": "A description of the table. It should be usable as summary information for the table that is described by the metadata.", "type": [ diff --git a/oemetadata/v2/v21/template.json b/oemetadata/v2/v21/template.json index 398d6e30..99677cdd 100644 --- a/oemetadata/v2/v21/template.json +++ b/oemetadata/v2/v21/template.json @@ -68,6 +68,9 @@ "path": "", "name": "", "title": "", + "topics": [ + "" + ], "description": "", "publicationDate": "", "subject": [