Merge branch 'develop' into feature-189-year

OpenEnergyPlatform · Oct 29, 2024 · 5d2d7c3 · 5d2d7c3
2 parents 91ac142 + 1578fb0
commit 5d2d7c3
Show file tree

Hide file tree

Showing 7 changed files with 99 additions and 56 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -49,8 +49,11 @@ Here is a template for new release sections
 - Add key topics to general [(#170)](https://github.com/OpenEnergyPlatform/oemetadata/pull/170)
 - Add badge labels to documentation [(#175)](https://github.com/OpenEnergyPlatform/oemetadata/pull/175)
 - Implement schema build system v1: Enhance the resolve and generation module [(#180)](https://github.com/OpenEnergyPlatform/oemetadata/pull/180)
-- Add basic documentation with MkDocs [(#184)](https://github.com/OpenEnergyPlatform/oemetadata/pull/184)
+- Add basic documentation with MKdocs [(#184)](https://github.com/OpenEnergyPlatform/oemetadata/pull/184)
+- Add key 'publisher' to section 'context' [(#191)](https://github.com/OpenEnergyPlatform/oemetadata/pull/191)
+- Add an array 'authors' in section 'sources'. [(#193)](https://github.com/OpenEnergyPlatform/oemetadata/pull/193)
 - Add year to section sources [(#194)](https://github.com/OpenEnergyPlatform/oemetadata/pull/194)
+- Add a key description to collection and update badges [(#195)](https://github.com/OpenEnergyPlatform/oemetadata/pull/195)
 
 ### Changed
 - Remove comment field as it holds information on how to fill out the metadata and therefore should not be part of the actual oemetadata but the documentation. [#105](https://github.com/OpenEnergyPlatform/oemetadata/pull/105)
@@ -63,6 +66,7 @@ Here is a template for new release sections
 - Build scripts use a settings file to share variables [(#177)](https://github.com/OpenEnergyPlatform/oemetadata/pull/177)
 - Refactor the spatial section and add new keys for location: 'address', '@id', 'latitude', 'longitude' and for extent: 'name', '@id', 'resolutionValue', 'resolutionUnit', 'boundingBox', 'crs' [(#179)](https://github.com/OpenEnergyPlatform/oemetadata/pull/179)
 - Move linkedData keys to the top of the resource [(#183)](https://github.com/OpenEnergyPlatform/oemetadata/pull/183)
+- Update order of keys in section 'context' [(#191)](https://github.com/OpenEnergyPlatform/oemetadata/pull/191)
 
 ### Removed
 - Remove email from contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)

diff --git a/metadata/v20/build_source/schemas/collection.json b/metadata/v20/build_source/schemas/collection.json
@@ -20,9 +20,19 @@
                 "string",
                 "null"
             ],
-            "badge": "Silver",
+            "badge": "Bronze",
             "title": "Collection Title"
         },
+        "description": {
+            "description": "A free text description of the collection.",
+            "example": "A collection of tables for the OEMetadata examples.",
+            "type": [
+                "string",
+                "null"
+            ],
+            "badge": "Bronze",
+            "title": "Collection Description"
+        },
         "id": {
             "description": "A unique identifier (UUID/DOI) for the collection.",
             "example": "https://databus.openenergyplatform.org/oeplatform/reference",

diff --git a/metadata/v20/build_source/schemas/context.json b/metadata/v20/build_source/schemas/context.json
@@ -47,26 +47,36 @@
                     "badge": "Gold",
                     "title": "Source Code"
                 },
-                "contact": {
-                    "description": "A reference to the creator or maintainer of the data set. This can be an email address or a GitHub handle.",
-                    "example": "[email protected]",
+                "publisher": {
+                    "description": "The publishing agency of the data. This can be the OEP.",
+                    "example": "Open Energy Platform (OEP)",
                     "type": [
                         "string",
                         "null"
                     ],
                     "badge": "Gold",
-                    "title": "E-Mail Contact",
-                    "format": "email"
+                    "title": "Publisher"
+                },"publisherLogo": {
+                    "description": "A URL to the logo of the publishing agency of data.",
+                    "example": "https://github.com/OpenEnergyPlatform/organisation/blob/production/logo/OpenEnergyFamily_Logo_OpenEnergyPlatform.svg",
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "badge": "Gold",
+                    "title": "Publisher Logo",
+                    "format": "uri"
                 },
-                "grantNo": {
-                    "description": "An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency.",
-                    "example": "501865131",
+                "contact": {
+                    "description": "A reference to the creator or maintainer of the data set. This can be an email address or a GitHub handle.",
+                    "example": "[email protected]",
                     "type": [
                         "string",
                         "null"
                     ],
                     "badge": "Gold",
-                    "title": "Grant Number"
+                    "title": "E-Mail Contact",
+                    "format": "email"
                 },
                 "fundingAgency": {
                     "description": "A name of the entity providing the funding. This can be a government agency or a company.",
@@ -89,16 +99,15 @@
                     "title": "Funding Agency Logo",
                     "format": "uri"
                 },
-                "publisherLogo": {
-                    "description": "A URL to the logo of the publishing agency of data.",
-                    "example": "https://reiner-lemoine-institut.de//wp-content/uploads/2015/09/rlilogo.png",
+                "grantNo": {
+                    "description": "An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency.",
+                    "example": "501865131",
                     "type": [
                         "string",
                         "null"
                     ],
                     "badge": "Gold",
-                    "title": "Publisher Logo",
-                    "format": "uri"
+                    "title": "Grant Number"
                 }
             },
             "badge": "Gold",

diff --git a/metadata/v20/build_source/schemas/sources.json b/metadata/v20/build_source/schemas/sources.json
@@ -19,6 +19,22 @@
                         "badge": "Bronze",
                         "title": "Source Title"
                     },
+                    "authors": {
+                        "description": "An array of the full names of the authors of the source material.",
+                        "type": "array",
+                        "items": {
+                            "description": "The authors of the source.",
+                            "example": ["Hoesung Lee","José Romero", "The Core Writing Team"],
+                            "type": [
+                                "string",
+                                "null"
+                            ],
+                            "badge": "Bronze",
+                            "title": "Keyword"
+                        },
+                        "badge": "Bronze",
+                        "title": "Keywords"
+                    },
                     "description": {
                         "description": "A free text description of the source.",
                         "example": "A Report of the Intergovernmental Panel on Climate Change.",

diff --git a/metadata/v20/build_source/schemas/spatial.json b/metadata/v20/build_source/schemas/spatial.json
@@ -32,7 +32,7 @@
                             "title": "Address"
                         },
                         "latitude": {
-                            "description": "The latitude (lat) information of the location.",
+                            "description": "The latitude (lat) information of the location. Specifies the north / south position of the geometry.",
                             "example": "52.432822",
                             "type": [
                                 "string",
@@ -42,7 +42,7 @@
                             "title": "Latitude"
                         },
                         "longitude": {
-                            "description": "The longitude (lon) information of the location.",
+                            "description": "The longitude (lon) information of the location. Specifies the east / west position of the geometry.",
                             "example": "13.5351004",
                             "type": [
                                 "string",

diff --git a/metadata/v20/build_source/schemas/temporal.json b/metadata/v20/build_source/schemas/temporal.json
@@ -63,7 +63,7 @@
                                     "string",
                                     "null"
                                 ],
-                                "badge": "Silver",
+                                "badge": "Gold",
                                 "title": "Timeseries Alignment"
                             },
                             "aggregationType": {
@@ -73,7 +73,7 @@
                                     "string",
                                     "null"
                                 ],
-                                "badge": "Silver",
+                                "badge": "Gold",
                                 "title": "Timeseries Aggregation Type"
                             }
                         },