Merge pull request #170 from OpenEnergyPlatform/feature-169-topic

Add key topics to general #169
OpenEnergyPlatform · Oct 18, 2024 · abf8bea · abf8bea
2 parents 0ea4f79 + 83dfe0a
commit abf8bea
Show file tree

Hide file tree

Showing 3 changed files with 130 additions and 123 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -59,6 +59,8 @@ Here is a template for new release sections
 
 - Add explicit json types [(#166)](https://github.com/OpenEnergyPlatform/oemetadata/pull/166)
 
+- Add key topics to general [(#170)](https://github.com/OpenEnergyPlatform/oemetadata/pull/170)
+
 ### 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/v20/build_source/schemas/general.json b/metadata/v20/build_source/schemas/general.json
@@ -5,17 +5,34 @@
     "properties": {
         "name": {
             "description": "A filename or database conform table name.",
-            "example": "model_draft.oemetadata_table_example_v20",
+            "example": "oemetadata_table_example",
             "type": [
                 "string",
                 "null"
             ],
             "badge": "Iron",
             "title": "Name"
         },
+        "topic": {
+            "description": "A list predefined topics that correspond to the database schemas.",
+            "example": "[model_draft, reference]",
+            "type": "array",
+            "items": {
+                "description": "The topics are used to group the data in the database.",
+                "example": "model_draft",
+                "type": [
+                    "string",
+                    "null"
+                ],
+                "badge": "Bronze",
+                "title": "Keyword"
+            },
+            "badge": "Bronze",
+            "title": "Keywords"
+        },
         "title": {
             "description": "A human readable table name.",
-            "example": "OEMetadata example table - Version 2.0",
+            "example": "OEMetadata example table",
             "type": [
                 "string",
                 "null"
@@ -25,15 +42,15 @@
         },
         "path": {
             "description": "A unique identifier (URI/UUID/DOI) for the table or file.",
-            "example": "http://openenergyplatform.org/dataedit/view/model_draft/oemetadata_table_example_v20",
+            "example": "http://openenergyplatform.org/dataedit/view/model_draft/oemetadata_table_example",
             "type": [
                 "string",
                 "null"
             ],
             "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.",
             "example": "Example table used to illustrate the oemetadata structure and meaning.",