Merge pull request #32 from oarepo/scoped_schemas

Scope field names in data model
oarepo · Aug 30, 2021 · 004e693 · 004e693
2 parents 21c959f + 01c2c96
commit 004e693
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 1 deletion.
diff --git a/oarepo_communities/datamodels/communities-v2.0.0.json5 b/oarepo_communities/datamodels/communities-v2.0.0.json5
@@ -0,0 +1,17 @@
+{
+  "definitions": {
+    "oarepo:secondaryCommunities": {
+      "type": "array",
+      "items": {
+        "type": "string",
+      },
+      "description": "List of secondary community IDs where the record is also available",
+      "minItems": 1,
+      "uniqueItems": true
+    },
+    "oarepo:primaryCommunity": {
+      "type": "string",
+      "description": "Primary community ID of the record"
+    }
+  }
+}
diff --git a/oarepo_communities/included_mappings/v7/communities-v2.0.0.json b/oarepo_communities/included_mappings/v7/communities-v2.0.0.json
@@ -0,0 +1,12 @@
+{
+  "Communities": {
+    "properties": {
+      "oarepo:secondaryCommunities": {
+        "type": "keyword"
+      },
+      "oarepo:primaryCommunity": {
+        "type": "keyword"
+      }
+    }
+  }
+}
diff --git a/oarepo_communities/jsonschemas/communities-v2.0.0.json b/oarepo_communities/jsonschemas/communities-v2.0.0.json
@@ -0,0 +1,24 @@
+{
+  "definitions": {
+    "Communities": {
+      "title": "OARepo Communities fields v1.0.0",
+      "type": "object",
+      "properties": {
+        "oarepo:primaryCommunity": {
+          "type": "string",
+          "description": "Primary community ID of the record"
+        },
+        "oarepo:secondaryCommunities": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "description": "List of secondary community IDs where the record is also published"
+          }
+        }
+      },
+      "required": [
+        "oarepo:primaryCommunity"
+      ]
+    }
+  }
+}
diff --git a/oarepo_communities/marshmallow/__init__.py b/oarepo_communities/marshmallow/__init__.py
@@ -14,3 +14,12 @@
 class OARepoCommunitiesMixin(Schema):
     _primary_community = SanitizedUnicode(required=True)
     _communities = List(SanitizedUnicode, default=list)
+
+
+class OARepoCommunitiesMixinV2(Schema):
+    _primary_community = SanitizedUnicode(required=True,
+                                          data_key='oarepo:primaryCommunity',
+                                          attribute='oarepo:primaryCommunity')
+    _secondary_communities = List(SanitizedUnicode, default=list,
+                                  data_key='oarepo:secondaryCommunities',
+                                  attribute='oarepo:secondaryCommunities')
diff --git a/oarepo_communities/version.py b/oarepo_communities/version.py
@@ -11,4 +11,4 @@
 and parsed by ``setup.py``.
 """
 
-__version__ = '2.3.1'
+__version__ = '2.4.0'