Skip to content

key_documentation: fixed typo & aligned with schema #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jh-RLI merged 1 commit into from
Sep 10, 2025
Merged

key_documentation: fixed typo & aligned with schema #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/oemetadata/metadata_key_description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</ div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|------------------------------------|------------------------------------|
| 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] |
Expand Down Expand Up @@ -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] |

Expand Down
2 changes: 1 addition & 1 deletion oemetadata/latest/metadata_key_description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</ div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|------------------------------------|------------------------------------|
| 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] |
Expand Down
8 changes: 4 additions & 4 deletions oemetadata/v2/v20/metadata_key_description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ If a value is not yet available, use: `ToDo`.
## Overview

### Dataset Keys
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example<div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
|--------------------------------|----------------------------------|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|------------------------------------|------------------------------------|
| 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] |
Expand All @@ -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
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</ div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
| <div style="width:1em">#</div> | <div style="width:6em">Key</div> | <div style="width:20em">Description</div> | <div style="width:20em">Example</div> | <div style="width:20em">Ontology Class</div> | <div style="width:4em">Badge</div> | <div style="width:3em">Card.</div> |
|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|------------------------------------|------------------------------------|
| 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] |
Expand Down Expand Up @@ -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] |

Expand Down