From 5ff60274039de16eb8872397cf3eabdf415c67c6 Mon Sep 17 00:00:00 2001 From: Sirko Schindler Date: Thu, 4 Sep 2025 17:19:12 +0200 Subject: [PATCH] key_documentation: fixed typo & aligned with schema --- docs/oemetadata/metadata_key_description.md | 6 +++--- oemetadata/latest/metadata_key_description.md | 2 +- oemetadata/v2/v20/metadata_key_description.md | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/oemetadata/metadata_key_description.md b/docs/oemetadata/metadata_key_description.md index b7ea9582..3b141cec 100644 --- a/docs/oemetadata/metadata_key_description.md +++ b/docs/oemetadata/metadata_key_description.md @@ -68,7 +68,7 @@ If a value is not yet available, use: `ToDo`. | 6 | **resources** | An array of objects of the resources. The dataset can contain several (database) tables. | | [dcat:Dataset](https://www.w3.org/ns/dcat#dataset) | | [*] | ### Resource - General Keys -|
#
|
Key
|
Description
|
Example |
Ontology Class
|
Badge
|
Card.
| +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| |--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|------------------------------------|------------------------------------| | 1 | @id | A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus). | [wri_global_power_plant_database](https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] | | 2 | name | A filename or database conform table name. | oemetadata_table_template | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] | @@ -127,8 +127,8 @@ If a value is not yet available, use: `ToDo`. | 1.2 | **timeseries** | An array that describes the timeseries. | | [dct:PeriodOfTime](http://purl.org/dc/terms/PeriodOfTime) | | [*] | | 1.2.1 | start | The start time of a time series. | 2020-01-01T00:00:00+00:00 | [dbo:startDateTime](https://dbpedia.org/ontology/startDateTime) | Silver | [0..1] | | 1.2.2 | end | The temporal end point of a time series. | 2020-01-01T23:59:30+00:00 | [dbo:endDateTime](https://dbpedia.org/ontology/endDateTime) | Silver | [0..1] | -| 1.2.3 | resolutionValue | The time span between individual information points in a time series. The value of the resolution. | 30 s | [dcat:spatialResolutionInMeters](http://www.w3.org/ns/dcat#spatialResolutionInMeters) | Silver | [0..1] | -| 1.2.4 | resolutionUnit | The unit of the temporal resolution. | 30 s | [oeo:unit](http://openenergyplatform.org/ontology/oeo/OEO_00010489) | Silver | [0..1] | +| 1.2.3 | resolutionValue | The time span between individual information points in a time series. The value of the resolution. | 15 | [dcat:spatialResolutionInMeters](http://www.w3.org/ns/dcat#spatialResolutionInMeters) | Silver | [0..1] | +| 1.2.4 | resolutionUnit | The unit of the temporal resolution. | min | [oeo:unit](http://openenergyplatform.org/ontology/oeo/OEO_00010489) | Silver | [0..1] | | 1.2.5 | alignment | An indicator of whether timestamps in a time series are to the left, right or in the centre. | left | [oeo:time stamp alignment](http://openenergyplatform.org/ontology/oeo/OEO_00140044) | Silver | [0..1] | | 1.2.6 | aggregationType | An indicator of whether the values are a sum, an average or a current value. | current | [oeo:aggregation type](https://openenergyplatform.org/ontology/oeo/OEO_00140068/) | Silver | [0..1] | diff --git a/oemetadata/latest/metadata_key_description.md b/oemetadata/latest/metadata_key_description.md index b7ea9582..bce7a019 100644 --- a/oemetadata/latest/metadata_key_description.md +++ b/oemetadata/latest/metadata_key_description.md @@ -68,7 +68,7 @@ If a value is not yet available, use: `ToDo`. | 6 | **resources** | An array of objects of the resources. The dataset can contain several (database) tables. | | [dcat:Dataset](https://www.w3.org/ns/dcat#dataset) | | [*] | ### Resource - General Keys -|
#
|
Key
|
Description
|
Example |
Ontology Class
|
Badge
|
Card.
| +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| |--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|------------------------------------|------------------------------------| | 1 | @id | A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus). | [wri_global_power_plant_database](https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] | | 2 | name | A filename or database conform table name. | oemetadata_table_template | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] | diff --git a/oemetadata/v2/v20/metadata_key_description.md b/oemetadata/v2/v20/metadata_key_description.md index b7ea9582..673921bf 100644 --- a/oemetadata/v2/v20/metadata_key_description.md +++ b/oemetadata/v2/v20/metadata_key_description.md @@ -58,7 +58,7 @@ If a value is not yet available, use: `ToDo`. ## Overview ### Dataset Keys -|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| |--------------------------------|----------------------------------|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|------------------------------------|------------------------------------| | 1 | @context | Explanation of metadata keys in ontology terms. | [context.json](https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/latest/context.json) | | Platinum | [0..1] | | 2 | name | A filename or database conform dataset name. | oep_oemetadata | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] | @@ -68,7 +68,7 @@ If a value is not yet available, use: `ToDo`. | 6 | **resources** | An array of objects of the resources. The dataset can contain several (database) tables. | | [dcat:Dataset](https://www.w3.org/ns/dcat#dataset) | | [*] | ### Resource - General Keys -|
#
|
Key
|
Description
|
Example |
Ontology Class
|
Badge
|
Card.
| +|
#
|
Key
|
Description
|
Example
|
Ontology Class
|
Badge
|
Card.
| |--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|------------------------------------|------------------------------------| | 1 | @id | A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus). | [wri_global_power_plant_database](https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07) | [dct:identifier](http://purl.org/dc/terms/identifier) | Platinum | [0..1] | | 2 | name | A filename or database conform table name. | oemetadata_table_template | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) | Iron | [1] | @@ -127,8 +127,8 @@ If a value is not yet available, use: `ToDo`. | 1.2 | **timeseries** | An array that describes the timeseries. | | [dct:PeriodOfTime](http://purl.org/dc/terms/PeriodOfTime) | | [*] | | 1.2.1 | start | The start time of a time series. | 2020-01-01T00:00:00+00:00 | [dbo:startDateTime](https://dbpedia.org/ontology/startDateTime) | Silver | [0..1] | | 1.2.2 | end | The temporal end point of a time series. | 2020-01-01T23:59:30+00:00 | [dbo:endDateTime](https://dbpedia.org/ontology/endDateTime) | Silver | [0..1] | -| 1.2.3 | resolutionValue | The time span between individual information points in a time series. The value of the resolution. | 30 s | [dcat:spatialResolutionInMeters](http://www.w3.org/ns/dcat#spatialResolutionInMeters) | Silver | [0..1] | -| 1.2.4 | resolutionUnit | The unit of the temporal resolution. | 30 s | [oeo:unit](http://openenergyplatform.org/ontology/oeo/OEO_00010489) | Silver | [0..1] | +| 1.2.3 | resolutionValue | The time span between individual information points in a time series. The value of the resolution. | 15 | [dcat:spatialResolutionInMeters](http://www.w3.org/ns/dcat#spatialResolutionInMeters) | Silver | [0..1] | +| 1.2.4 | resolutionUnit | The unit of the temporal resolution. | min | [oeo:unit](http://openenergyplatform.org/ontology/oeo/OEO_00010489) | Silver | [0..1] | | 1.2.5 | alignment | An indicator of whether timestamps in a time series are to the left, right or in the centre. | left | [oeo:time stamp alignment](http://openenergyplatform.org/ontology/oeo/OEO_00140044) | Silver | [0..1] | | 1.2.6 | aggregationType | An indicator of whether the values are a sum, an average or a current value. | current | [oeo:aggregation type](https://openenergyplatform.org/ontology/oeo/OEO_00140068/) | Silver | [0..1] |