Merge pull request #203 from akolson/add-channel-version

Adds the channel_version field to the embed_content_request schema

Author: bjester

js/EmbedContentRequest.js

@@ -118,14 +118,19 @@ export const SCHEMA = {
         "content_id": {
           "$ref": "#/definitions/uuid",
           "description": "The UUID of the content resource(s)"
+        },
+        "channel_version": {
+          "type": "integer",
+          "description": "The version number of the channel that the content resource belongs to"
         }
       },
       "required": [
         "id",
         "channel_id",
         "title",
         "description",
-        "content_id"
+        "content_id",
+        "channel_version"
       ]
     }
   },

js/package.json

@@ -27,5 +27,5 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "0.2.14"
+  "version": "0.2.15"
 }

le_utils/constants/embed_content_request.py

@@ -112,8 +112,19 @@
                     "$ref": "#/definitions/uuid",
                     "description": "The UUID of the content resource(s)",
                 },
+                "channel_version": {
+                    "type": "integer",
+                    "description": "The version number of the channel that the content resource belongs to",
+                },
             },
-            "required": ["id", "channel_id", "title", "description", "content_id"],
+            "required": [
+                "id",
+                "channel_id",
+                "title",
+                "description",
+                "content_id",
+                "channel_version",
+            ],
         },
     },
     "properties": {

setup.py

@@ -8,7 +8,7 @@
 setup(
     name="le-utils",
     packages=find_packages(),
-    version="0.2.14",
+    version="0.2.15",
     description="LE-Utils contains shared constants used in Kolibri, Ricecooker, and Kolibri Studio.",
     long_description=long_description,
     long_description_content_type="text/markdown",

spec/schema-embed_content_request.json

@@ -113,14 +113,19 @@
         "content_id": {
           "$ref": "#/definitions/uuid",
           "description": "The UUID of the content resource(s)"
+        },
+        "channel_version": {
+          "type": "integer",
+          "description": "The version number of the channel that the content resource belongs to"
         }
       },
       "required": [
         "id",
         "channel_id",
         "title",
         "description",
-        "content_id"
+        "content_id",
+        "channel_version"
       ]
     }
   },

tests/test_schemas.py

@@ -493,6 +493,7 @@ def test_embed__content__valid():
                         "text": "Resource text",
                         "language": "en",
                         "content_id": str(uuid.uuid4()),
+                        "channel_version": 1,
                     },
                 ],
                 "metadata": {
@@ -517,6 +518,7 @@ def test_embed__content__valid_with_files():
                         "text": "Resource text",
                         "language": "en",
                         "content_id": str(uuid.uuid4()),
+                        "channel_version": 1,
                         "files": [
                             {
                                 "url": "http://localhost:8000/media/1234.jpg",
@@ -616,6 +618,31 @@ def test_embed__content__invalid_content_id():
         )
 
 
+@skip_if_jsonschema_unavailable
+def test_embed__content__invalid_channel_version():
+    with pytest.raises(jsonschema.ValidationError):
+        _validate_embed_content_request(
+            {
+                "resources": [
+                    {
+                        "id": str(uuid.uuid4()),
+                        "channel_id": str(uuid.uuid4()),
+                        "title": "Resource title",
+                        "description": "Resource description",
+                        "text": "Resource text",
+                        "language": "en",
+                        "content_id": str(uuid.uuid4()),
+                        "channel_version": "v1",
+                    },
+                ],
+                "metadata": {
+                    "channel_title": "Channel title",
+                    "some_additional_field": "some_random_value",
+                },
+            }
+        )
+
+
 @skip_if_jsonschema_unavailable
 def test_embed__content__invalid_url_files():
     with pytest.raises(jsonschema.ValidationError):