Skip to content

Commit

Permalink
Merge branch 'develop' into feature-206-id
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ludee
Ludee authored Nov 12, 2024
2 parents 278087e + 96abf1b commit 90ea1f5
Show file tree
Hide file tree
Showing 9 changed files with 120 additions and 94 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Update documentation and README [(#209)](https://github.com/OpenEnergyPlatform/oemetadata/pull/209)
- Move old metadata versions to folder [(#209)](https://github.com/OpenEnergyPlatform/oemetadata/pull/209)
- Update JSON schema from (draft-07) to (Draft 2020-12) [(#212)](https://github.com/OpenEnergyPlatform/oemetadata/pull/212)
- Update all tests [(#212)](https://github.com/OpenEnergyPlatform/oemetadata/pull/212)
- Separate `timeseries - resolution` into `resolutionValue` and `resolutionUnit` [(#213)](https://github.com/OpenEnergyPlatform/oemetadata/pull/213)
- Rename URI from `path` to `@id` [(#214)](https://github.com/OpenEnergyPlatform/oemetadata/pull/214)

### Removed
Expand Down
6 changes: 3 additions & 3 deletions docs/metadata/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ It is an extensive set of metadata based on the [Data Package Standard 2.0](http
It is made to facilitate findability, accessibility, interoperability, and reusability (FAIR) of data. <br>
A badge system prioritises the keys and serves as a measure of the completeness and quality of the metadata entries.

The metadata schema is defined in [JSON schema](https://json-schema.org/) version 2020-12.<br>
The metadata contains keys in a nested JSON structure.<br>
The metadata standard includes the following files

- [`schema.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/schema.json) contains the complete schema.
The metadata standard includes the following files:
- [`schema.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/schema.json) contains the complete metadata schema.
- [`metadata_key_description.md`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/metadata_key_description.md) contains a full description of each metadata key.
- [`template.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/template.json) contains an empty metadata string with all fields.
- [`example.json`](https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/example.json) contains a basic metadata example.
137 changes: 69 additions & 68 deletions docs/metadata/metadata_mappings.md
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions metadata/v20/v20/build_source/schemas/spatial.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,18 @@
"title": "Extent URI"
},
"resolutionValue": {
"description": "The value of the resolution.",
"description": "The value of the spatial resolution.",
"type": ["string", "null"],
"examples": ["100"],
"badge": "Silver",
"title": "Resolution Value"
"title": "Spatial Resolution Value"
},
"resolutionUnit": {
"description": "The unit of the resolution.",
"description": "The unit of the spatial resolution.",
"type": ["string", "null"],
"examples": ["m"],
"badge": "Silver",
"title": "Resolution Unit"
"title": "Spatial Resolution Unit"
},
"boundingBox": {
"description": "The covered area specified by the coordinates of a bounding box. The format is [minLon, minLat, maxLon, maxLat] or [W,S,E,N].",
Expand Down
15 changes: 11 additions & 4 deletions metadata/v20/v20/build_source/schemas/temporal.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,19 @@
"title": "Timeseries End",
"format": "date-time"
},
"resolution": {
"description": "The time span between individual information points in a time series.",
"resolutionValue": {
"description": "The time span between individual information points in a time series. The value of the resolution.",
"type": ["string", "null"],
"examples": ["15"],
"badge": "Silver",
"title": "Timeseries Resolution Value"
},
"resolutionUnit": {
"description": "The unit of the temporal resolution.",
"type": ["string", "null"],
"examples": ["30 s"],
"examples": ["min"],
"badge": "Silver",
"title": "Timeseries Resolution"
"title": "Timeseries Resolution Unit"
},
"alignment": {
"description": "An indicator of whether timestamps in a time series are to the left, right or in the centre.",
Expand Down
3 changes: 2 additions & 1 deletion metadata/v20/v20/example.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@
{
"start": "2020-01-01T00:00:00+00:00",
"end": "2020-01-01T23:59:30+00:00",
"resolution": "30 s",
"resolutionValue": "15",
"resolutionUnit": "min",
"alignment": "left",
"aggregationType": "current"
}
Expand Down
11 changes: 6 additions & 5 deletions metadata/v20/v20/metadata_key_description.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ If a value is not yet available, use: `ToDo`.
| 1.2 | **extent** | An object that describes a covered area or region. | | |
| 1.2.1 | name | The name of the region. | Berlin | Silver |
| 1.2.2 | @id | A URI reference for the region. | https://www.wikidata.org/wiki/Q64 | Platinum |
| 1.2.3 | resolutionValue | The value of the resolution. | 100 | Silver |
| 1.2.4 | resolutionUnit | The unit of the resolution. | m | Silver |
| 1.2.3 | resolutionValue | The value of the spatial resolution. | 100 | Silver |
| 1.2.4 | resolutionUnit | The unit of the spatial resolution. | m | Silver |
| 1.2.5 | boundingBox | The covered area specified by the coordinates of a bounding box. The format is [minLon, minLat, maxLon, maxLat] or [W,S,E,N]. | [13.08825, 52.33859, 13.76104, 52.6754] | Gold |
| 1.2.6 | crs | The Coordinate Reference System, specified as an EPSG code. | EPSG:4326 | Gold |

Expand All @@ -110,9 +110,10 @@ If a value is not yet available, use: `ToDo`.
| 1.2 | **timeseries** | An array that describes the timeseries. | | |
| 1.2.1 | start | The start time of a time series. | 2020-01-01T00:00:00+00:00 | Silver |
| 1.2.2 | end | The temporal end point of a time series. | 2020-01-01T23:59:30+00:00 | Silver |
| 1.2.3 | resolution | The time span between individual information points in a time series. | 30 s | Silver |
| 1.2.4 | alignment | An indicator of whether timestamps in a time series are to the left, right or in the centre. | left | Silver |
| 1.2.5 | aggregationType | An indicator of whether the values are a sum, an average or a current value. | current | Silver |
| 1.2.3 | resolutionValue | The time span between individual information points in a time series. The value of the resolution. | 30 s | Silver |
| 1.2.4 | resolutionUnit | The unit of the temporal resolution. | 30 s | Silver |
| 1.2.5 | alignment | An indicator of whether timestamps in a time series are to the left, right or in the centre. | left | Silver |
| 1.2.6 | aggregationType | An indicator of whether the values are a sum, an average or a current value. | current | Silver |

### Resource - Sources Keys
| # | Key | Description | Example | Badge |
Expand Down
28 changes: 20 additions & 8 deletions metadata/v20/v20/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@
"title": "Extent URI"
},
"resolutionValue": {
"description": "The value of the resolution.",
"description": "The value of the spatial resolution.",
"type": [
"string",
"null"
Expand All @@ -524,10 +524,10 @@
"100"
],
"badge": "Silver",
"title": "Resolution Value"
"title": "Spatial Resolution Value"
},
"resolutionUnit": {
"description": "The unit of the resolution.",
"description": "The unit of the spatial resolution.",
"type": [
"string",
"null"
Expand All @@ -536,7 +536,7 @@
"m"
],
"badge": "Silver",
"title": "Resolution Unit"
"title": "Spatial Resolution Unit"
},
"boundingBox": {
"description": "The covered area specified by the coordinates of a bounding box. The format is [minLon, minLat, maxLon, maxLat] or [W,S,E,N].",
Expand Down Expand Up @@ -624,17 +624,29 @@
"title": "Timeseries End",
"format": "date-time"
},
"resolution": {
"description": "The time span between individual information points in a time series.",
"resolutionValue": {
"description": "The time span between individual information points in a time series. The value of the resolution.",
"type": [
"string",
"null"
],
"examples": [
"30 s"
"15"
],
"badge": "Silver",
"title": "Timeseries Resolution"
"title": "Timeseries Resolution Value"
},
"resolutionUnit": {
"description": "The unit of the temporal resolution.",
"type": [
"string",
"null"
],
"examples": [
"min"
],
"badge": "Silver",
"title": "Timeseries Resolution Unit"
},
"alignment": {
"description": "An indicator of whether timestamps in a time series are to the left, right or in the centre.",
Expand Down
3 changes: 2 additions & 1 deletion metadata/v20/v20/template.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@
{
"start": "",
"end": "",
"resolution": "",
"resolutionValue": "",
"resolutionUnit": "",
"alignment": "",
"aggregationType": ""
}
Expand Down

0 comments on commit 90ea1f5

Please sign in to comment.