Merge pull request #155 from OpenEnergyPlatform/feature-140-embargo

Add embargo period to general keys #140
OpenEnergyPlatform · Oct 14, 2024 · 1210ff4 · 1210ff4
2 parents a06b6be + 7431514
commit 1210ff4
Show file tree

Hide file tree

Showing 3 changed files with 111 additions and 62 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -40,10 +40,16 @@ Here is a template for new release sections
   - We use json schema $ref elements to reference the schema modules and we provide code to resolve the reference´s and generate the complete schema.json.
 
 - Add code to generate a example.json based on the schema.json. We read the example values for each of the fields specified in the schema and generate the example. [#???](https://github.com/OpenEnergyPlatform/oemetadata/pull/)
+
+- Add embargoPeriod section with keys start, end, isActive [(#155)](https://github.com/OpenEnergyPlatform/oemetadata/pull/155)
+
 - Add path to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
+
 - Add organization to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
+
 - Add roles to contributors [(#157)](https://github.com/OpenEnergyPlatform/oemetadata/pull/157)
 
+
 ### 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. [#???](https://github.com/OpenEnergyPlatform/oemetadata/pull/)

diff --git a/metadata/v200_draft/build_source/schemas/general.json b/metadata/v200_draft/build_source/schemas/general.json
@@ -123,6 +123,45 @@
             "badge": "Bronze",
             "title": "Publication date",
             "format": "date"
+        },
+        "embargoPeriod": {
+            "description": "An object that describes the embargo period during which public access to the data is not allowed.",
+            "type": "object",
+            "properties": {
+                "start": {
+                    "description": "The start date of the embargo period.",
+                    "example": "2024-10-11",
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "badge": "Bronze",
+                    "title": "Embargo period start"
+                },
+                "end": {
+                    "description": "The end date of the embargo period. This is the intended release date.",
+                    "example": "2025-01-01",
+                    "type": [
+                        "string",
+                        "null"
+                    ],
+                    "badge": "Bronze",
+                    "title": "Embargo period end (Publication date)"
+                },
+                "isActive": {
+                    "description": "A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date.",
+                    "example": "True",
+                    "type": [
+                        "boolean",
+                        "null"
+                    ],
+                    "badge": "Bronze",
+                    "title": "Active embargo period"
+                }
+            },
+            "badge": "Bronze",
+            "title": "Embargo period",
+            "additionalProperties": false
         }
     }
 }