Update latest folder #226

OpenEnergyPlatform · Jan 24, 2025 · 1461882 · 1461882
1 parent 03c24db
commit 1461882
Show file tree

Hide file tree

Showing 46 changed files with 2,697 additions and 595 deletions.
diff --git a/metadata/latest/README.md b/metadata/latest/README.md
@@ -9,7 +9,7 @@ SPDX-License-Identifier: MIT
 <a href="https://openenergyplatform.org/"><img align="right" width="100" height="100" src="https://avatars2.githubusercontent.com/u/37101913?s=400&u=9b593cfdb6048a05ea6e72d333169a65e7c922be&v=4" alt="OpenEnergyPlatform"></a>
 
 
-# OEMetadata - Version 2.0 (Latest)
+# OEMetadata - Version 2.0
 
 This version of the OEMetadata represents the latest released version. 
 This release is fully integrated into the OEP.

diff --git a/metadata/latest/build_source/schema_structure.json b/metadata/latest/build_source/schema_structure.json
@@ -5,14 +5,13 @@
     "type": "object",
     "required": ["resources"],
     "properties": {
-        "collection": {"$ref": "collection.json#"},
+        "collection": {"$ref": "dataset.json#"},
         "resources": {
             "description": "A collection of related resources.",
             "type": "array",
             "items": {
                 "type": "object",
                 "properties": {
-                    "linkedData": {"$ref": "linked_data.json#"},
                     "general": {"$ref": "general.json#"},
                     "context": {"$ref": "context.json#"},
                     "spatial": {"$ref": "spatial.json#"},

diff --git a/metadata/latest/build_source/schemas/context.json b/metadata/latest/build_source/schemas/context.json
@@ -41,7 +41,7 @@
                     "description": "The publishing agency of the data. This can be the OEP.",
                     "type": ["string", "null"],
                     "examples": ["Open Energy Platform (OEP)"],
-                    "badge": "Gold",
+                    "badge": "Bronze",
                     "title": "Publisher"
                 },"publisherLogo": {
                     "description": "A URL to the logo of the publishing agency of data.",

diff --git a/...test/build_source/schemas/collection.json → .../latest/build_source/schemas/dataset.json b/...test/build_source/schemas/collection.json → .../latest/build_source/schemas/dataset.json
@@ -3,6 +3,14 @@
     "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/build_source/schemas/collection.json",
     "type": "object",
     "properties": {
+        "@context": {
+            "description": "Explanation of metadata keys in ontology terms.",
+            "examples": ["https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/context.json"],
+            "type": ["string", "null"],
+            "badge": "Platinum",
+            "title": "@context",
+            "readOnly": true
+        },
         "name": {
             "description": "A filename or database conform dataset name.",
             "type": ["string", "null"],
@@ -25,7 +33,7 @@
             "title": "Dataset Description"
         },
         "id": {
-            "description": "A unique identifier (UUID/DOI) for the dataset.",
+            "description": "A unique identifier (UUID/DOI) for the collection.",
             "type": ["string", "null"],
             "examples": ["https://databus.openenergyplatform.org/oeplatform/reference"],
             "badge": "Silver",

diff --git a/metadata/latest/build_source/schemas/fields.json b/metadata/latest/build_source/schemas/fields.json
@@ -120,7 +120,7 @@
                                                 "type": ["string", "null"],
                                                 "examples": ["onshore"],
                                                 "badge": "Platinum",
-                                                "title": "Value"
+                                                "title": "Value Reference"
                                             },
                                             "name": {
                                                 "description": "The class label of the ontology term in the column.",

diff --git a/metadata/latest/build_source/schemas/general.json b/metadata/latest/build_source/schemas/general.json
@@ -3,10 +3,18 @@
     "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/production/metadata/latest/build_source/schemas/general.json",
     "type": "object",
     "properties": {
+        "@id": {
+            "description": "A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus).",
+            "type": ["string", "null"],
+            "examples": ["https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07"],
+            "badge": "Platinum",
+            "title": "@Id",
+            "readOnly": true
+        },
         "name": {
             "description": "A filename or database conform table name.",
             "type": ["string", "null"],
-            "examples": ["oep_oemetadata_table_example"],
+            "examples": ["oemetadata_table_template"],
             "badge": "Iron",
             "title": "Name"
         },
@@ -16,32 +24,32 @@
             "items": {
                 "description": "The topics are used to group the data in the database.",
                 "type": ["string", "null"],
-                "examples": ["model_draft","reference"],
+                "examples": ["model_draft"],
                 "badge": "Bronze",
-                "title": "Keyword"
+                "title": "Topic"
             },
             "badge": "Bronze",
-            "title": "Keywords"
+            "title": "Topics"
         },
         "title": {
-            "description": "A human readable table name.",
+            "description": "A human readable resource or table name.",
             "type": ["string", "null"],
-            "examples": ["OEP OEMetadata Example Table"],
+            "examples": ["OEMetadata Table Template"],
             "badge": "Silver",
             "title": "Title"
         },
         "path": {
             "description": "A unique identifier (URI/UUID/DOI) for the table or file.",
             "type": ["string", "null"],
-            "examples": ["http://openenergyplatform.org/dataedit/view/model_draft/oep_oemetadata_table_example"],
+            "examples": ["http://openenergyplatform.org/dataedit/view/model_draft/oemetadata_table_template"],
             "badge": "Bronze",
             "title": "Path",
             "readOnly": true
                 },
         "description": {
             "description": "A description of the table. It should be usable as summary information for the table that is described by the metadata.",
             "type": ["string", "null"],
-            "examples": ["Example table used to illustrate the OEMetadata structure and meaning."],
+            "examples": ["Example table used to illustrate the OEMetadata structure and features."],
             "badge": "Silver",
             "title": "Description"
         },

diff --git a/metadata/latest/build_source/schemas/licenses.json b/metadata/latest/build_source/schemas/licenses.json
@@ -12,38 +12,45 @@
                     "name": {
                         "description": "The SPDX identifier.",
                         "type": ["string", "null"],
-                        "example": "ODbL-1.0",
+                        "examples": ["ODbL-1.0"],
                         "badge": "Bronze",
                         "title": "Name"
                     },
                     "title": {
                         "description": "The official (human readable) title of the license.",
                         "type": ["string", "null"],
-                        "example": "Open Data Commons Open Database License 1.0",
+                        "examples": ["Open Data Commons Open Database License 1.0"],
                         "badge": "Bronze",
                         "title": "Title"
                     },
                     "path": {
                         "description": "A link or path to the license text.",
                         "type": ["string", "null"],
-                        "example": "https://opendatacommons.org/licenses/odbl/1-0/index.html",
+                        "examples": ["https://opendatacommons.org/licenses/odbl/1-0/index.html"],
                         "badge": "Bronze",
                         "title": "Path",
                         "format": "uri"
                     },
                     "instruction": {
                         "description": "A short description of rights and obligations. The use of tl;drLegal is recommended.",
                         "type": ["string", "null"],
-                        "example": "You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information.",
+                        "examples": ["You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information."],
                         "badge": "Bronze",
                         "title": "Instruction"
                     },
                     "attribution": {
                         "description": "A copyright holder of the data. Must be provided if attribution licenses are used.",
                         "type": ["string", "null"],
-                        "example": "© Reiner Lemoine Institut",
+                        "examples": ["© Reiner Lemoine Institut"],
                         "badge": "Bronze",
                         "title": "Attribution"
+                    },
+                    "copyrightStatement": {
+                        "description": "A link or path that proves that the source or data has the appropriate license. This can be a page number or website imprint.",
+                        "type": ["string", "null"],
+                        "examples": ["https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/LICENSE.txt"],
+                        "badge": "Bronze",
+                        "title": "Copyright Statement"
                     }
                 },
                 "badge": "Bronze",

diff --git a/metadata/latest/build_source/schemas/linked_data.json b/metadata/latest/build_source/schemas/linked_data.json
diff --git a/metadata/latest/build_source/schemas/provenance.json b/metadata/latest/build_source/schemas/provenance.json
@@ -34,17 +34,17 @@
                         "description": "An array describing the roles of the contributor.",
                         "type": "array",
                         "items": {
-                            "description": "A role is recommended to follow an established vocabulary, such as DataCite Metadata Schema’s contributorRole or CreDIT. Useful roles to indicate are: creator, contact, and dataCurator.",
+                            "description": "A role is recommended to follow an established vocabulary: DataCite Metadata Schema’s contributorRole. Useful roles to indicate are: DataCollector, ContactPerson, and DataCurator.",
                             "type": ["string", "null"],
-                            "examples": ["creator", "dataCurator"],
+                            "examples": ["DataCollector", "DataCurator"],
                             "badge": "Bronze",
                             "title": "Role"
                         },
                         "badge": "Bronze",
                         "title": "Roles"
                     },
                     "date": {
-                        "description": "The date of the final contribution. Date Format is ISO 8601.",
+                        "description": "The date of the contribution. Date Format is ISO 8601.",
                         "type": ["string", "null"],
                         "examples": ["2024-10-21"],
                         "badge": "Bronze",

diff --git a/metadata/latest/build_source/schemas/review.json b/metadata/latest/build_source/schemas/review.json
@@ -10,7 +10,7 @@
                 "path": {
                     "description": "A link or path to the documented open peer review.",
                     "type": ["string", "null"],
-                    "examples": ["https://www.example.com"],
+                    "examples": ["https://openenergyplatform.org/dataedit/view/model_draft/oep_table_example/open_peer_review/"],
                     "badge": null,
                     "title": "Path",
                     "format": "uri"

diff --git a/metadata/latest/build_source/schemas/sources.json b/metadata/latest/build_source/schemas/sources.json
@@ -24,10 +24,10 @@
                             "type": ["string", "null"],
                             "examples": ["Hoesung Lee","José Romero", "The Core Writing Team"],
                             "badge": "Bronze",
-                            "title": "Keyword"
+                            "title": "Author"
                         },
                         "badge": "Bronze",
-                        "title": "Keywords"
+                        "title": "Authors"
                     },
                     "description": {
                         "description": "A free text description of the source.",
@@ -43,12 +43,12 @@
                         "badge": "Bronze",
                         "title": "Publication Year"
                     },
-                    "@id": {
-                        "description": "A URL to the original source.",
+                    "path": {
+                        "description": "A DOI or link to the original source.",
                         "type": ["string", "null"],
                         "examples": ["https://www.ipcc.ch/report/ar6/syr/downloads/report/IPCC_AR6_SYR_FullVolume.pdf"],
                         "badge": "Bronze",
-                        "title": "Source Identifier",
+                        "title": "DOI",
                         "format": "uri"
                     },
                     "sourceLicenses": {
@@ -60,29 +60,29 @@
                                 "name": {
                                     "description": "The SPDX identifier.",
                                     "type": ["string", "null"],
-                                    "examples": ["ODbL-1.0"],
+                                    "examples": ["CC-BY-4.0"],
                                     "badge": "Bronze",
                                     "title": "Name"
                                 },
                                 "title": {
                                     "description": "The official (human readable) title of the license.",
                                     "type": ["string", "null"],
-                                    "examples": ["Open Data Commons Open Database License 1.0"],
+                                    "examples": ["Creative Commons Attribution 4.0 International"],
                                     "badge": "Bronze",
                                     "title": "Title"
                                 },
                                 "path": {
                                     "description": "A link or path to the license text.",
                                     "type": ["string", "null"],
-                                    "examples": ["https://opendatacommons.org/licenses/odbl/1-0/index.html"],
+                                    "examples": ["https://creativecommons.org/licenses/by/4.0/legalcode"],
                                     "badge": "Bronze",
                                     "title": "License Identifier",
                                     "format": "uri"
                                 },
                                 "instruction": {
                                     "description": "A short description of rights and obligations. The use of tl;drLegal is recommended.",
                                     "type": ["string", "null"],
-                                    "examples": ["You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-odbl for further information."],
+                                    "examples": ["You are free to share and change, but you must attribute. See https://tldrlegal.com/license/odc-open-database-license-odbl for further information."],
                                     "badge": "Bronze",
                                     "title": "Instruction"
                                 },

diff --git a/metadata/latest/build_source/schemas/spatial.json b/metadata/latest/build_source/schemas/spatial.json
@@ -41,7 +41,7 @@
                         }
                     },
                     "badge": "Silver",
-                    "title": "Extent"
+                    "title": "Location"
                 },
                 "extent": {
                     "description": "An object that describes a covered area or region.",
@@ -63,18 +63,18 @@
                             "title": "Extent Identifier"
                         },
                         "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].",