Skip to content

Feature 320 atid #322

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

Open
Ludee wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

Feature 320 atid #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4c9d0c1
Update dataset path #320
Ludee Sep 25, 2026
a7f828c
Update dataset extent id #320
Ludee Sep 25, 2026
60881d2
Update subject id #320
Ludee Sep 25, 2026
f7470cb
Update subject id docs #320
Ludee Sep 25, 2026
22ad746
Update spatial id #320
Ludee Sep 25, 2026
64a0bcd
Update ressource id #320
Ludee Sep 25, 2026
83d8d72
Update fields id #320
Ludee Sep 25, 2026
e93f6b6
Update fields id #320
Ludee Sep 25, 2026
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
16 changes: 14 additions & 2 deletions oemetadata/v2/v21/build_source/schemas/dataset.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"readOnly": true
},
"@id": {

@Cpprentice Cpprentice Oct 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we also modify this id field?

"description": "A unique identifier (UUID/DOI) for the collection.",
"description": "A unique identifier (UUID/DOI) for the dataset. This is the Databus Artifact.",
"type": [
"string",
"null"
Expand All @@ -30,6 +30,18 @@
"format": "uri",
"readOnly": true
},
"path": {

@Cpprentice Cpprentice Oct 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This compares to the previous @id field in the sense that it is meant for the OEP table while the other relates to the databus?

How would this be filled for datasets that are neither on the databus nor the OEP?

@Cpprentice Cpprentice Oct 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we need to modify the context.json as well if we add the new path property here.

Path currently has several definitions depending on the nested context:

# review context (alias)
"path": "@id"      # this means whatever contains the path keyword gets the value as its iri


# global context (property declaration)
"path": {        # in comparison to the above comment, this defines a property whose value becomes an iri
      "@id": "dcat:accessURL",
      "@type": "@id"
    }


# resource context
"path": {
          "@id": "dct:identifier",
          "@type": "xsd:string"
}

# context of sources, sourceLicenses, and resourceLicenses
"path": {
          "@id": "dcat:accessURL",
          "@type": "xsd:anyURI"
        }

If we have at least one @id alias in the top level the entire metadata descriptor would get an IRI otherwise it is a blank node. Both are fine we should just properly think about how we handle both

"id" and "path" in that regard. I am not 100% sure what happens if we identify one of them as alias for @id and the value is not filled.

"description": "A unique identifier for the dataset.",
"type": [
"string",
"null"
],
"examples": [
"https://openenergyplatform.org/database/tables/oemetadata_table_template"
],
"badge": "Bronze",
"title": "Dataset Name"
},
"name": {
"description": "A filename or database conform dataset name.",
"type": [
Expand Down Expand Up @@ -82,7 +94,7 @@
"badge": "Silver",
"title": "Dataset Extent Name"
},
"@id": {
"id": {

@Cpprentice Cpprentice Oct 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The context.json currently only has this definition for "id" (it is in the global scope):

 "id": {
      "@id": "dct:identifier",
      "@type": "xsd:anyURI"
    }

I assume we rather need to alias it now:

"id": "@id"

Also I did not found any occurrence of a mere "id" field (without the @) in the previous schema.json so maybe the above can simply be replaced without further issues.

"description": "A URI reference for the region of the dataset.",
"type": [
"string",
Expand Down
4 changes: 2 additions & 2 deletions oemetadata/v2/v21/build_source/schemas/fields.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@
"badge": "Platinum",
"title": "Is About Name"
},
"@id": {
"id": {
"description": "The path of the ontology term (IRI).",
"type": [
"string",
Expand Down Expand Up @@ -201,7 +201,7 @@
"badge": "Platinum",
"title": "Value Reference Name"
},
"@id": {
"id": {
"description": "The path of the ontology term (IRI) in the column.",
"type": [
"string",
Expand Down
6 changes: 3 additions & 3 deletions oemetadata/v2/v21/build_source/schemas/general.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/oemetadata/v2/v21/build_source/schemas/general.json",
"type": "object",
"properties": {
"@id": {
"id": {
"description": "A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus).",
"type": [
"string",
Expand All @@ -13,7 +13,7 @@
"https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07/wri_global_power_plant_database_variant=data.csv"
],
"badge": "Platinum",
"title": "@Id",
"title": "Id",
"readOnly": true
},
"path": {
Expand All @@ -26,7 +26,7 @@
"example.csv"
],
"badge": "Bronze",
"title": "Path",
"title": "Dataset Path",
"readOnly": true
},
"name": {
Expand Down
4 changes: 2 additions & 2 deletions oemetadata/v2/v21/build_source/schemas/spatial.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"badge": "Silver",
"title": "Address"
},
"@id": {
"id": {
"description": "A path or URI to a specific location. It can use Wikidata or OpenStreetMap.",
"type": [
"string",
Expand Down Expand Up @@ -79,7 +79,7 @@
"badge": "Silver",
"title": "Extent Name"
},
"@id": {
"id": {
"description": "A URI reference for the region.",
"type": [
"string",
Expand Down
2 changes: 1 addition & 1 deletion oemetadata/v2/v21/build_source/schemas/subject.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"badge": "Platinum",
"title": "Subject Name"
},
"@id": {
"id": {
"description": "A unique identifier (URI/IRI) of the ontology class.",
"type": [
"string",
Expand Down
50 changes: 25 additions & 25 deletions oemetadata/v2/v21/metadata_key_description.md
View file
Open in desktop

Large diffs are not rendered by default.

70 changes: 50 additions & 20 deletions oemetadata/v2/v21/metadata_key_details.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,16 @@ If a value is not yet available, use: `ToDo`.
| **Badge** | Platinum |
| **Card.** | [0..1] |

### Dataset - path
| | |
|--------------------|--------------------------------------------------------------------------|
| **Key** | path |
| **Description** | A unique identifier for the dataset. |
| **Example** | https://openenergyplatform.org/database/tables/oemetadata_table_template |
| **Ontology Class** | [dcat:accessURL](https://www.w3.org/ns/dcat#accessURL) |
| **Badge** | Bronze |
| **Card.** | [0..1] |

### Dataset - name
| | |
|--------------------|------------------------------------------------------------|
Expand Down Expand Up @@ -108,6 +118,26 @@ If a value is not yet available, use: `ToDo`.
| **Badge** | Bronze |
| **Card.** | [0..1] |

### Dataset - extent (name)
| | |
|--------------------|-------------------------------------------------------------|
| **Key** | name |
| **Description** | The name of the spatial region of the dataset. |
| **Example** | Berlin |
| **Ontology Class** | [rdfs:label](https://www.w3.org/2000/01/rdf-schema#/label) |
| **Badge** | Silver |
| **Card.** | [0..1] |

### Dataset - extent (id)
| | |
|--------------------|----------------------------------------------------------------|
| **Key** | id |
| **Description** | A URI reference for the region of the dataset. |
| **Example** | [www.wikidata.org/wiki/Q64](https://www.wikidata.org/wiki/Q64) |
| **Ontology Class** | [dct:identifier](http://purl.org/dc/terms/identifier) |
| **Badge** | Platinum |
| **Card.** | [0..1] |

### Dataset - languages
| | |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down Expand Up @@ -158,10 +188,10 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |

### Dataset - subject (@id)
### Dataset - subject (id)
| | |
|----------------|--------------------------------------------------------------------------------------------------------------|
| Key | @id |
| Key | id |
| Description | A unique identifier (URI/IRI) of the ontology class. |
| Example | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) |
| Ontology Class | [dct:subject](http://purl.org/dc/terms/subject) |
Expand Down Expand Up @@ -484,10 +514,10 @@ If a value is not yet available, use: `ToDo`.
| **Badge** | |
| **Card.** | [*] |

### Resources - General - @id
### Resources - General - id
| | |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Key | @id |
| Key | id |
| Description | A Uniform Resources Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus). |
| Example | [wri_global_power_plant_database](https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07/wri_global_power_plant_database_variant=data.csv) |
| Ontology Class | [dct:identifier](http://purl.org/dc/terms/identifier) |
Expand Down Expand Up @@ -574,10 +604,10 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |

### Resources - General - subject (@id)
### Resources - General - subject (id)
| | |
|----------------|--------------------------------------------------------------------------------------------------------------|
| Key | @id |
| Key | id |
| Description | A unique identifier (URI/IRI) of the ontology class. |
| Example | [openenergyplatform.org/ontology/oeo/OEO_00000150](https://openenergyplatform.org/ontology/oeo/OEO_00000150) |
| Ontology Class | [dct:subject](http://purl.org/dc/terms/subject) |
Expand Down Expand Up @@ -664,10 +694,10 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |

### Resources - Spatial - location (@id)
### Resources - Spatial - location (id)
| | |
|----------------|-----------------------------------------------------------------------------|
| Key | @id |
| Key | id |
| Description | A path or URI to a specific location. It can use Wikidata or OpenStreetMap. |
| Example | [www.wikidata.org/wiki/Q77077223](https://www.wikidata.org/wiki/Q77077223) |
| Ontology Class | [dct:identifier](http://purl.org/dc/terms/identifier) |
Expand Down Expand Up @@ -714,10 +744,10 @@ If a value is not yet available, use: `ToDo`.
| Badge | Silver |
| Card. | [0..1] |

### Resources - Spatial - extent (@id)
### Resources - Spatial - extent (id)
| | |
|----------------|----------------------------------------------------------------|
| Key | @id |
| Key | id |
| Description | A URI reference for the region. |
| Example | [www.wikidata.org/wiki/Q64](https://www.wikidata.org/wiki/Q64) |
| Ontology Class | [dct:identifier](http://purl.org/dc/terms/identifier) |
Expand Down Expand Up @@ -1175,15 +1205,15 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |

### Resources - Fields Keys - @id (isAbout)
| | |
|----------------|--------------------------------------------------------------------------|
| Key | **@id** |
| Description | The path of the ontology term (IRI). |
### Resources - Fields Keys - id (isAbout)
| | |
|----------------|-------------------------------------------------------------------------|
| Key | **id** |
| Description | The path of the ontology term (IRI). |
| Example | [OEO_00000044](https://openenergyplatform.org/ontology/oeo/OEO_00000044) |
| Ontology Class | [dct:identifier](http://purl.org/dc/terms/identifier) |
| Badge | Platinum |
| Card. | [0..1] |
| Ontology Class | [dct:identifier](http://purl.org/dc/terms/identifier) |
| Badge | Platinum |
| Card. | [0..1] |

### Resources - Fields Keys - valueReference
| | |
Expand Down Expand Up @@ -1215,10 +1245,10 @@ If a value is not yet available, use: `ToDo`.
| Badge | Platinum |
| Card. | [0..1] |

### Resources - Fields Keys - @id (valueReference)
### Resources - Fields Keys - id (valueReference)
| | |
|----------------|--------------------------------------------------------------------------|
| Key | **@id** |
| Key | **id** |
| Description | The path of the ontology term (IRI) in the column. |
| Example | [OEO_00000311](https://openenergyplatform.org/ontology/oeo/OEO_00000311) |
| Ontology Class | [dct:identifier](http://purl.org/dc/terms/identifier) |
Expand Down
Loading