Skip to content

Commit

Permalink
Merge pull request #214 from OpenEnergyPlatform/feature-206-id
Browse files Browse the repository at this point in the history 
Rename subject path to '@id' #206
  • Loading branch information
@Ludee
Ludee authored Nov 12, 2024
2 parents 96abf1b + 90ea1f5 commit edd5f5e
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 30 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- 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
14 changes: 7 additions & 7 deletions metadata/v20/v20/build_source/schemas/fields.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,14 @@
"type": ["string", "null"],
"examples": ["wind energy converting unit"],
"badge": "Platinum",
"title": "Name"
"title": "Is About Name"
},
"path": {
"@id": {
"description": "The path of the ontology term (IRI).",
"type": ["string", "null"],
"examples": ["https://openenergyplatform.org/ontology/oeo/OEO_00000044"],
"badge": "Platinum",
"title": "Path",
"title": "Is About URI",
"format": "uri"
}
},
Expand All @@ -120,21 +120,21 @@
"type": ["string", "null"],
"examples": ["onshore"],
"badge": "Platinum",
"title": "Value"
"title": "Value Reference"
},
"name": {
"description": "The class label of the ontology term in the column.",
"type": ["string", "null"],
"examples": ["onshore wind farm"],
"badge": "Platinum",
"title": "Name"
"title": "Value Reference Name"
},
"path": {
"@id": {
"description": "The path of the ontology term (IRI) in the column.",
"type": ["string", "null"],
"examples": ["https://openenergyplatform.org/ontology/oeo/OEO_00000311"],
"badge": "Platinum",
"title": "Path",
"title": "Value Reference URI",
"format": "uri"
}
},
Expand Down
6 changes: 3 additions & 3 deletions metadata/v20/v20/build_source/schemas/general.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,14 @@
"type": ["string", "null"],
"examples": ["energy"],
"badge": "Platinum",
"title": "Name"
"title": "Subject Name"
},
"path": {
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
"type": ["string", "null"],
"examples": ["https://openenergy-platform.org/ontology/oeo/OEO_00000150"],
"badge": "Platinum",
"title": "Path",
"title": "Subject URI",
"format": "uri"
}
},
Expand Down
6 changes: 3 additions & 3 deletions metadata/v20/v20/example.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"subject": [
{
"name": "energy",
"path": "https://openenergy-platform.org/ontology/oeo/OEO_00000150"
"@id": "https://openenergy-platform.org/ontology/oeo/OEO_00000150"
}
],
"keywords": [
Expand Down Expand Up @@ -142,14 +142,14 @@
"isAbout": [
{
"name": "wind energy converting unit",
"path": "https://openenergyplatform.org/ontology/oeo/OEO_00000044"
"@id": "https://openenergyplatform.org/ontology/oeo/OEO_00000044"
}
],
"valueReference": [
{
"value": "onshore",
"name": "onshore wind farm",
"path": "https://openenergyplatform.org/ontology/oeo/OEO_00000311"
"@id": "https://openenergyplatform.org/ontology/oeo/OEO_00000311"
}
]
}
Expand Down
6 changes: 3 additions & 3 deletions metadata/v20/v20/metadata_key_description.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ If a value is not yet available, use: `ToDo`.
| 6 | languages | An array of languages used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) | en-GB, de-DE, fr-FR | Gold |
| 7 | **subject** | An array of objects that references to the subjects of the resource in ontology terms. | |
| 7.1 | name | A class label of the ontology term. | energy | Platinum |
| 7.2 | path | A unique identifier (URI/IRI) of the ontology class. | https://openenergy-platform.org/ontology/oeo/OEO_00000150 | Platinum |
| 7.2 | @id | A unique identifier (URI/IRI) of the ontology class. | https://openenergy-platform.org/ontology/oeo/OEO_00000150 | Platinum |
| 8 | keywords | An array of freely selectable keywords that help with searching and structuring. The keyword are used and managed in the OEP as table tags. | example, ODbL-1.0, NFDI4Energy | Silver |
| 9 | publicationDate | A date of publication of the data or metadata. The date format is ISO 8601 (YYYY-MM-DD). | 2024-10-15 | Bronze |
| 10 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. |
Expand Down Expand Up @@ -174,11 +174,11 @@ If a value is not yet available, use: `ToDo`.
| 1.1.5 | unit | The unit of a field. If it does not apply, use 'null'. If the unit is given in a separate field, reference this field (e.g. 'unit'). Use a space between numbers and units (100 m). | MW | Silver |
| 1.1.6 | **isAbout** | An array of objects that describes the field in ontology terms. |
| 1.1.6.1 | name | The class label of the ontology term. | wind energy converting unit | Platinum |
| 1.1.6.2 | path | The path of the ontology term (IRI). | https://openenergy-platform.org/ontology/oeo/OEO_00000044 | Platinum |
| 1.1.6.2 | @id | The path of the ontology term (IRI). | https://openenergy-platform.org/ontology/oeo/OEO_00000044 | Platinum |
| 1.1.7 | **valueReference** | An array of objects for an extended description of the values in the column in ontology terms. | | |
| 1.1.7.1 | value | The name of the value in the column. | onshore | Platinum |
| 1.1.7.2 | name | The class label of the ontology term in the column. | onshore wind farm | Platinum |
| 1.1.7.3 | path | The path of the ontology term (IRI) in the column. | https://openenergy-platform.org/ontology/oeo/OEO_00000311 | Platinum |
| 1.1.7.3 | @id | The path of the ontology term (IRI) in the column. | https://openenergy-platform.org/ontology/oeo/OEO_00000311 | Platinum |

#### Resource - Properties Keys
| # | Key | Description | Example | Badge |
Expand Down
20 changes: 10 additions & 10 deletions metadata/v20/v20/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,9 @@
"energy"
],
"badge": "Platinum",
"title": "Name"
"title": "Subject Name"
},
"path": {
"@id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
"type": [
"string",
Expand All @@ -204,7 +204,7 @@
"https://openenergy-platform.org/ontology/oeo/OEO_00000150"
],
"badge": "Platinum",
"title": "Path",
"title": "Subject URI",
"format": "uri"
}
},
Expand Down Expand Up @@ -1154,9 +1154,9 @@
"wind energy converting unit"
],
"badge": "Platinum",
"title": "Name"
"title": "Is About Name"
},
"path": {
"@id": {
"description": "The path of the ontology term (IRI).",
"type": [
"string",
Expand All @@ -1166,7 +1166,7 @@
"https://openenergyplatform.org/ontology/oeo/OEO_00000044"
],
"badge": "Platinum",
"title": "Path",
"title": "Is About URI",
"format": "uri"
}
},
Expand All @@ -1192,7 +1192,7 @@
"onshore"
],
"badge": "Platinum",
"title": "Value"
"title": "Value Reference"
},
"name": {
"description": "The class label of the ontology term in the column.",
Expand All @@ -1204,9 +1204,9 @@
"onshore wind farm"
],
"badge": "Platinum",
"title": "Name"
"title": "Value Reference Name"
},
"path": {
"@id": {
"description": "The path of the ontology term (IRI) in the column.",
"type": [
"string",
Expand All @@ -1216,7 +1216,7 @@
"https://openenergyplatform.org/ontology/oeo/OEO_00000311"
],
"badge": "Platinum",
"title": "Path",
"title": "Value Reference URI",
"format": "uri"
}
},
Expand Down
8 changes: 4 additions & 4 deletions metadata/v20/v20/template.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"subject": [
{
"name": "",
"path": ""
"@id": ""
}
],
"keywords": [
Expand Down Expand Up @@ -132,14 +132,14 @@
"isAbout": [
{
"name": "",
"path": ""
"@id": ""
}
],
"valueReference": [
{
"value": "",
"name": "",
"path": ""
"@id": ""
}
]
}
Expand Down Expand Up @@ -171,7 +171,7 @@
}
}
],
"metaMetadata": {
"metaMetadata": {
"metadataVersion": "OEMetadata-2.0.1",
"metadataLicense": {
"name": "CC0-1.0",
Expand Down

0 comments on commit edd5f5e

Please sign in to comment.