Skip to content

Commit a59f0e2

Browse files
jh-RLIjh-RLI
authored
Merge pull request #288 from SirkoS/bug-287-documentation-issues
key_documentation: fixed typo & aligned with schema
2 parents d7457d4 + 5ff6027 commit a59f0e2

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

‎docs/oemetadata/metadata_key_description.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ If a value is not yet available, use: `ToDo`.
6868
| 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) | | [*] |
6969

7070
### Resource - General Keys
71-
| <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> |
71+
| <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> |
7272
|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|------------------------------------|------------------------------------|
7373
| 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] |
7474
| 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`.
127127
| 1.2 | **timeseries** | An array that describes the timeseries. | | [dct:PeriodOfTime](http://purl.org/dc/terms/PeriodOfTime) | | [*] |
128128
| 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] |
129129
| 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] |
130-
| 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] |
131-
| 1.2.4 | resolutionUnit | The unit of the temporal resolution. | 30 s | [oeo:unit](http://openenergyplatform.org/ontology/oeo/OEO_00010489) | Silver | [0..1] |
130+
| 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] |
131+
| 1.2.4 | resolutionUnit | The unit of the temporal resolution. | min | [oeo:unit](http://openenergyplatform.org/ontology/oeo/OEO_00010489) | Silver | [0..1] |
132132
| 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] |
133133
| 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] |
134134

‎oemetadata/latest/metadata_key_description.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ If a value is not yet available, use: `ToDo`.
6868
| 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) | | [*] |
6969

7070
### Resource - General Keys
71-
| <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> |
71+
| <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> |
7272
|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|------------------------------------|------------------------------------|
7373
| 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] |
7474
| 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] |

‎oemetadata/v2/v20/metadata_key_description.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ If a value is not yet available, use: `ToDo`.
5858
## Overview
5959

6060
### Dataset Keys
61-
| <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> |
61+
| <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> |
6262
|--------------------------------|----------------------------------|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|------------------------------------|------------------------------------|
6363
| 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] |
6464
| 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`.
6868
| 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) | | [*] |
6969

7070
### Resource - General Keys
71-
| <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> |
71+
| <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> |
7272
|--------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|------------------------------------|------------------------------------|
7373
| 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] |
7474
| 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`.
127127
| 1.2 | **timeseries** | An array that describes the timeseries. | | [dct:PeriodOfTime](http://purl.org/dc/terms/PeriodOfTime) | | [*] |
128128
| 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] |
129129
| 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] |
130-
| 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] |
131-
| 1.2.4 | resolutionUnit | The unit of the temporal resolution. | 30 s | [oeo:unit](http://openenergyplatform.org/ontology/oeo/OEO_00010489) | Silver | [0..1] |
130+
| 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] |
131+
| 1.2.4 | resolutionUnit | The unit of the temporal resolution. | min | [oeo:unit](http://openenergyplatform.org/ontology/oeo/OEO_00010489) | Silver | [0..1] |
132132
| 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] |
133133
| 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] |
134134

0 commit comments

Comments
 (0)