Merge pull request #168 from OpenEnergyPlatform/feature-21-semver

Refactor version to v20 (2.0) in all files #21
OpenEnergyPlatform · Oct 16, 2024 · b175751 · b175751
2 parents 2b8afae + 6778f0c
commit b175751
Show file tree

Hide file tree

Showing 42 changed files with 40 additions and 39 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -66,6 +66,7 @@ Here is a template for new release sections
 - Update broken Link in key description example [(#159)](https://github.com/OpenEnergyPlatform/oemetadata/pull/159)
 - Update resource/profile to resource/type [(#164)](https://github.com/OpenEnergyPlatform/oemetadata/pull/164)
 - Update links in context.json and example.json for all versions [(#167)](https://github.com/OpenEnergyPlatform/oemetadata/pull/167)
+- Restrict the version number to only major and minor versions since 2.0 [(#168)](https://github.com/OpenEnergyPlatform/oemetadata/pull/168)
 
 ### Removed
 

diff --git a/metadata/latest/build_source/schemas/context.json b/metadata/latest/build_source/schemas/context.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/context.json",
+    "$id": "general.json#metadata/v20/schemas/context.json",
     "type": "object",
     "properties": {
         "context": {

diff --git a/metadata/latest/build_source/schemas/contribution.json b/metadata/latest/build_source/schemas/contribution.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/contribution.json",
+    "$id": "general.json#metadata/v20/schemas/contribution.json",
     "type": "object",
     "properties": {
         "contributors": {

diff --git a/metadata/latest/build_source/schemas/general.json b/metadata/latest/build_source/schemas/general.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/general.json",
+    "$id": "general.json#metadata/v20/schemas/general.json",
     "type": "object",
     "properties": {
         "name": {

diff --git a/metadata/latest/build_source/schemas/json_ld.json b/metadata/latest/build_source/schemas/json_ld.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "json_ld.json#metadata/v200_draft/schemas/json_ld.json",
+    "$id": "json_ld.json#metadata/v20/schemas/json_ld.json",
     "type": "object",
     "properties": {
         "@id": {

diff --git a/metadata/latest/build_source/schemas/licences.json b/metadata/latest/build_source/schemas/licences.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/licences.json",
+    "$id": "general.json#metadata/v20/schemas/licences.json",
     "type": "object",
     "properties": {
         "licenses": {

diff --git a/metadata/latest/build_source/schemas/meta.json b/metadata/latest/build_source/schemas/meta.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/meta.json",
+    "$id": "general.json#metadata/v20/schemas/meta.json",
     "type": "object",
     "properties": {
         "metaMetadata": {

diff --git a/metadata/latest/build_source/schemas/resources.json b/metadata/latest/build_source/schemas/resources.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/resources.json",
+    "$id": "general.json#metadata/v20/schemas/resources.json",
     "type": "object",
     "properties": {
         "resources": {

diff --git a/metadata/latest/build_source/schemas/review.json b/metadata/latest/build_source/schemas/review.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/review.json",
+    "$id": "general.json#metadata/v20/schemas/review.json",
     "type": "object",
     "properties": {
         "review": {

diff --git a/metadata/latest/build_source/schemas/sources.json b/metadata/latest/build_source/schemas/sources.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/sources.json",
+    "$id": "general.json#metadata/v20/schemas/sources.json",
     "type": "object",
     "properties": {
         "sources": {

diff --git a/metadata/latest/build_source/schemas/spatial.json b/metadata/latest/build_source/schemas/spatial.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/spatial.json",
+    "$id": "general.json#metadata/v20/schemas/spatial.json",
     "type": "object",
     "properties": {
         "spatial": {

diff --git a/metadata/latest/build_source/schemas/temporal.json b/metadata/latest/build_source/schemas/temporal.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/temporal.json",
+    "$id": "general.json#metadata/v20/schemas/temporal.json",
     "type": "object",
     "properties": {
         "temporal": {

diff --git a/metadata/latest/build_source/scripts/resolve_schema_refs.py b/metadata/latest/build_source/scripts/resolve_schema_refs.py
@@ -36,7 +36,7 @@
 
 # Constants
 BASE_PATH = Path("metadata/")
-VERSION = "v200_draft"
+VERSION = "v20"
 VERSION_PATH = BASE_PATH / VERSION
 SCHEMA_BUILD_PATH = VERSION_PATH / "build"
 MAIN_SCHEMA_PATH = SCHEMA_BUILD_PATH / "main_schema.json"

diff --git a/metadata/v200_draft/README.md → metadata/v20/README.md b/metadata/v200_draft/README.md → metadata/v20/README.md
diff --git a/metadata/v200_draft/__init__.py → metadata/v20/__init__.py b/metadata/v200_draft/__init__.py → metadata/v20/__init__.py
diff --git a/..._draft/build_source/schema_structure.json → ...ta/v20/build_source/schema_structure.json b/..._draft/build_source/schema_structure.json → ...ta/v20/build_source/schema_structure.json
@@ -1,11 +1,11 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$id": "https://raw.githubusercontent.com/OpenEnergyPlatform/oemetadata/master/oemetadata/latest/schema.json",
-    "description": "Open Energy Plaftorm (OEP) metadata schema latest",
+    "description": "Open Energy Platform (OEP) metadata schema latest",
     "type": "object",
     "properties": {
-        "generalCollection": {
-            "$ref": "general_collection.json#"
+        "collection": {
+            "$ref": "collection.json#"
         },
         "resources": {
             "description": "A collection of related data resource descriptions and metadata. This may include relational data models which are technically related",

diff --git a/...ld_source/schemas/general_collection.json → .../v20/build_source/schemas/collection.json b/...ld_source/schemas/general_collection.json → .../v20/build_source/schemas/collection.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/general_collection.json",
+    "$id": "general.json#metadata/v20/schemas/collection.json",
     "type": "object",
     "properties": {
         "name": {

diff --git a/...0_draft/build_source/schemas/context.json → ...ata/v20/build_source/schemas/context.json b/...0_draft/build_source/schemas/context.json → ...ata/v20/build_source/schemas/context.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/context.json",
+    "$id": "general.json#metadata/v20/schemas/context.json",
     "type": "object",
     "properties": {
         "context": {

diff --git a/...0_draft/build_source/schemas/general.json → ...ata/v20/build_source/schemas/general.json b/...0_draft/build_source/schemas/general.json → ...ata/v20/build_source/schemas/general.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/general.json",
+    "$id": "general.json#metadata/v20/schemas/general.json",
     "type": "object",
     "properties": {
         "name": {

diff --git a/..._draft/build_source/schemas/licences.json → ...ta/v20/build_source/schemas/licences.json b/..._draft/build_source/schemas/licences.json → ...ta/v20/build_source/schemas/licences.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/licences.json",
+    "$id": "general.json#metadata/v20/schemas/licences.json",
     "type": "object",
     "properties": {
         "licenses": {

diff --git a/...aft/build_source/schemas/linked_data.json → ...v20/build_source/schemas/linked_data.json b/...aft/build_source/schemas/linked_data.json → ...v20/build_source/schemas/linked_data.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/linked_data.json",
+    "$id": "general.json#metadata/v20/schemas/linked_data.json",
     "type": "object",
     "properties": {
         "linkedData": {

diff --git a/...v200_draft/build_source/schemas/meta.json → metadata/v20/build_source/schemas/meta.json b/...v200_draft/build_source/schemas/meta.json → metadata/v20/build_source/schemas/meta.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/meta.json",
+    "$id": "general.json#metadata/v20/schemas/meta.json",
     "type": "object",
     "properties": {
         "metaMetadata": {

diff --git a/...raft/build_source/schemas/provenance.json → .../v20/build_source/schemas/provenance.json b/...raft/build_source/schemas/provenance.json → .../v20/build_source/schemas/provenance.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/provenance.json",
+    "$id": "general.json#metadata/v20/schemas/provenance.json",
     "type": "object",
     "properties": {
         "provenance": {

diff --git a/..._draft/build_source/schemas/resource.json → ...ta/v20/build_source/schemas/resource.json b/..._draft/build_source/schemas/resource.json → ...ta/v20/build_source/schemas/resource.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/resource.json",
+    "$id": "general.json#metadata/v20/schemas/resource.json",
     "type": "object",
     "properties": {
             "type": {

diff --git a/...00_draft/build_source/schemas/review.json → ...data/v20/build_source/schemas/review.json b/...00_draft/build_source/schemas/review.json → ...data/v20/build_source/schemas/review.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/review.json",
+    "$id": "general.json#metadata/v20/schemas/review.json",
     "type": "object",
     "properties": {
         "review": {

diff --git a/...0_draft/build_source/schemas/sources.json → ...ata/v20/build_source/schemas/sources.json b/...0_draft/build_source/schemas/sources.json → ...ata/v20/build_source/schemas/sources.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/sources.json",
+    "$id": "general.json#metadata/v20/schemas/sources.json",
     "type": "object",
     "properties": {
         "sources": {

diff --git a/...0_draft/build_source/schemas/spatial.json → ...ata/v20/build_source/schemas/spatial.json b/...0_draft/build_source/schemas/spatial.json → ...ata/v20/build_source/schemas/spatial.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/spatial.json",
+    "$id": "general.json#metadata/v20/schemas/spatial.json",
     "type": "object",
     "properties": {
         "spatial": {

diff --git a/..._draft/build_source/schemas/temporal.json → ...ta/v20/build_source/schemas/temporal.json b/..._draft/build_source/schemas/temporal.json → ...ta/v20/build_source/schemas/temporal.json
@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "general.json#metadata/v200_draft/schemas/temporal.json",
+    "$id": "general.json#metadata/v20/schemas/temporal.json",
     "type": "object",
     "properties": {
         "temporal": {

diff --git a/...e/scripts/generate_example_from_schema.py → ...e/scripts/generate_example_from_schema.py b/...e/scripts/generate_example_from_schema.py → ...e/scripts/generate_example_from_schema.py
@@ -32,7 +32,7 @@
 
 # Constants
 BASE_PATH = Path("metadata/")
-VERSION = "v200_draft"
+VERSION = "v20"
 VERSION_PATH = BASE_PATH / VERSION
 SCHEMA_BUILD_PATH = VERSION_PATH / "build_source"
 MAIN_SCHEMA_PATH = SCHEMA_BUILD_PATH / "schema_structure.json"

diff --git a/.../scripts/generate_template_from_schema.py → .../scripts/generate_template_from_schema.py b/.../scripts/generate_template_from_schema.py → .../scripts/generate_template_from_schema.py
@@ -30,7 +30,7 @@
 
 # Constants
 BASE_PATH = Path("metadata/")
-VERSION = "v200_draft"
+VERSION = "v20"
 VERSION_PATH = BASE_PATH / VERSION
 SCHEMA_BUILD_PATH = VERSION_PATH / "build_source"
 MAIN_SCHEMA_PATH = SCHEMA_BUILD_PATH / "schema_structure.json"

diff --git a/...ild_source/scripts/resolve_schema_refs.py → ...ild_source/scripts/resolve_schema_refs.py b/...ild_source/scripts/resolve_schema_refs.py → ...ild_source/scripts/resolve_schema_refs.py
@@ -36,7 +36,7 @@
 
 # Constants
 BASE_PATH = Path("metadata/")
-VERSION = "v200_draft"
+VERSION = "v20"
 VERSION_PATH = BASE_PATH / VERSION
 SCHEMA_BUILD_PATH = VERSION_PATH / "build_source"
 MAIN_SCHEMA_PATH = SCHEMA_BUILD_PATH / "schema_structure.json"

diff --git a/metadata/v200_draft/context.json → metadata/v20/context.json b/metadata/v200_draft/context.json → metadata/v20/context.json
diff --git a/metadata/v200_draft/example.json → metadata/v20/example.json b/metadata/v200_draft/example.json → metadata/v20/example.json
diff --git a/metadata/v200_draft/example.py → metadata/v20/example.py b/metadata/v200_draft/example.py → metadata/v20/example.py
diff --git a/...ta/v200_draft/metadata_key_description.md → metadata/v20/metadata_key_description.md b/...ta/v200_draft/metadata_key_description.md → metadata/v20/metadata_key_description.md
diff --git a/metadata/v200_draft/schema.json → metadata/v20/schema.json b/metadata/v200_draft/schema.json → metadata/v20/schema.json
diff --git a/metadata/v200_draft/schema.py → metadata/v20/schema.py b/metadata/v200_draft/schema.py → metadata/v20/schema.py
diff --git a/metadata/v200_draft/template.json → metadata/v20/template.json b/metadata/v200_draft/template.json → metadata/v20/template.json
diff --git a/metadata/v200_draft/template.py → metadata/v20/template.py b/metadata/v200_draft/template.py → metadata/v20/template.py
diff --git a/tests/metadata/v200/test_example.py → tests/metadata/v20/test_example.py b/tests/metadata/v200/test_example.py → tests/metadata/v20/test_example.py
@@ -1,10 +1,10 @@
 def test_if_example_json_loads_successfully():
-    from metadata.v200_draft.example import OEMETADATA_V200_EXAMPLE
+    from metadata.v20.example import OEMETADATA_V200_EXAMPLE
 
 
 def test_example_against_schema_which_should_succeed():
     import jsonschema
-    from metadata.v200_draft.example import OEMETADATA_V200_EXAMPLE
-    from metadata.v200_draft.schema import OEMETADATA_V200_SCHEMA
+    from metadata.v20.example import OEMETADATA_V200_EXAMPLE
+    from metadata.v20.schema import OEMETADATA_V200_SCHEMA
 
     assert jsonschema.validate(OEMETADATA_V200_EXAMPLE, OEMETADATA_V200_SCHEMA) == None
diff --git a/tests/metadata/v200/test_schema.py → tests/metadata/v20/test_schema.py b/tests/metadata/v200/test_schema.py → tests/metadata/v20/test_schema.py
@@ -1,12 +1,12 @@
 def test_if_schema_json_loads_successfully():
     try:
-        from metadata.v200_draft.schema import OEMETADATA_V200_SCHEMA
+        from metadata.v20.schema import OEMETADATA_V200_SCHEMA
     except Warning:
         print("Metadata Schema v2.0.0 cant load. Check if the files are missing!")
 
 
 def test_if_schema_json_has_correct_schema_and_id_set():
-    from metadata.v200_draft.schema import OEMETADATA_V200_SCHEMA
+    from metadata.v20.schema import OEMETADATA_V200_SCHEMA
     import string
 
     def get_string(s):
@@ -23,7 +23,7 @@ def get_string(s):
 
 def test_schema_against_metaschema_which_should_succeed():
     import jsonschema
-    from metadata.v200_draft.schema import OEMETADATA_V200_SCHEMA
+    from metadata.v20.schema import OEMETADATA_V200_SCHEMA
     from metadata.metaschema.draft07.schema import OEMETADATA_METASCHEMA_DRAFT07_SCHEMA
 
     assert (

diff --git a/tests/metadata/v200/test_template.py → tests/metadata/v20/test_template.py b/tests/metadata/v200/test_template.py → tests/metadata/v20/test_template.py
@@ -1,10 +1,10 @@
 def test_if_template_json_loads_successfully():
-    from metadata.v200_draft.template import OEMETADATA_V200_TEMPLATE
+    from metadata.v20.template import OEMETADATA_V200_TEMPLATE
 
 
 def test_template_against_schema_which_should_succeed():
     import jsonschema
-    from metadata.v200_draft.template import OEMETADATA_V200_TEMPLATE
-    from metadata.v200_draft.schema import OEMETADATA_V200_SCHEMA
+    from metadata.v20.template import OEMETADATA_V200_TEMPLATE
+    from metadata.v20.schema import OEMETADATA_V200_SCHEMA
 
     assert jsonschema.validate(OEMETADATA_V200_TEMPLATE, OEMETADATA_V200_SCHEMA) == None