Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
10 changes: 10 additions & 0 deletions oemetadata/v2/v21/build_source/schemas/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!--
SPDX-FileCopyrightText: 2026 Ludwig Hülk <Ludee> © Reiner Lemoine Institut
SPDX-FileCopyrightText: oemetadata <https://github.com/OpenEnergyPlatform/oemetadata/>
SPDX-License-Identifier: MIT
-->

# OEMetadata Core Files

The schemas are the core of the OEMetadata specification. <br>
They are separated by category and follow the logic of OEMetadata structure.
60 changes: 43 additions & 17 deletions oemetadata/v2/v21/build_source/schemas/dataset.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,23 +66,49 @@
"badge": "Bronze",
"title": "Dataset Description"
},
"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"
"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"
}
}
},
"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.",
Expand Down
18 changes: 18 additions & 0 deletions oemetadata/v2/v21/build_source/schemas/general.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
2 changes: 1 addition & 1 deletion oemetadata/v2/v21/build_source/schemas/review.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
15 changes: 10 additions & 5 deletions oemetadata/v2/v21/example.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@
"name": "oep_oemetadata",
"title": "OEP OEMetadata Dataset",
"description": "A dataset for the OEMetadata examples.",
"topics": [
"model_draft"
],
"extent": {
"name": "Europe",
"@id": "https://www.wikidata.org/wiki/Q458"
},
"referenceDate": "2020-01-01",
"languages": [
"en-GB",
"de-DE"
Expand Down Expand Up @@ -82,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": [
Expand All @@ -91,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": [
Expand Down Expand Up @@ -386,7 +391,7 @@
"decimalSeparator": "."
},
"review": {
"path": "https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/",
"path": "https://openenergyplatform.org/database/",
"badge": "Platinum"
}
}
Expand Down
Loading
Loading