Update embed schemas for newly required fields, channel_id and language

Author: bjester

js/EmbedContentRequest.js

@@ -84,6 +84,10 @@ export const SCHEMA = {
           "$ref": "/schemas/common_embed_definitions#/definitions/uuid",
           "description": "The UUID of the content resource"
         },
+        "channel_id": {
+          "$ref": "/schemas/common_embed_definitions#/definitions/uuid",
+          "description": "The UUID of the channel that the content resource belongs to"
+        },
         "title": {
           "type": "string",
           "description": "The title of the content resource"
@@ -94,7 +98,7 @@ export const SCHEMA = {
         },
         "text": {
           "type": "string",
-          "description": "The cleaned up text extracted from the content resource (in markdown or plaintext format)"
+          "description": "Optional textual content to include in the embedding"
         },
         "language": {
           "$ref": "#/definitions/language"
@@ -113,9 +117,9 @@ export const SCHEMA = {
       },
       "required": [
         "id",
+        "channel_id",
         "title",
         "description",
-        "text",
         "content_id"
       ]
     }

js/EmbedTopicsRequest.js

@@ -11,7 +11,7 @@ export const SCHEMA = {
   "additionalProperties": false,
   "definitions": {
      "id": {
-      "type": "string",
+       "$ref": "/schemas/common_embed_definitions#/definitions/uuid",
       "description": "The ID of the topic content node on Studio"
     },
     "title": {
@@ -90,7 +90,8 @@ export const SCHEMA = {
       "required": [
         "id",
         "title",
-        "description"
+        "description",
+        "language"
       ]
     }
   },

le_utils/constants/embed_content_request.py

@@ -81,6 +81,10 @@
                     "$ref": "/schemas/common_embed_definitions#/definitions/uuid",
                     "description": "The UUID of the content resource",
                 },
+                "channel_id": {
+                    "$ref": "/schemas/common_embed_definitions#/definitions/uuid",
+                    "description": "The UUID of the channel that the content resource belongs to",
+                },
                 "title": {
                     "type": "string",
                     "description": "The title of the content resource",
@@ -91,7 +95,7 @@
                 },
                 "text": {
                     "type": "string",
-                    "description": "The cleaned up text extracted from the content resource (in markdown or plaintext format)",
+                    "description": "Optional textual content to include in the embedding",
                 },
                 "language": {"$ref": "#/definitions/language"},
                 "files": {
@@ -104,7 +108,7 @@
                     "description": "The UUID of the content resource(s)",
                 },
             },
-            "required": ["id", "title", "description", "text", "content_id"],
+            "required": ["id", "channel_id", "title", "description", "content_id"],
         },
     },
     "properties": {

le_utils/constants/embed_topics_request.py

@@ -17,7 +17,7 @@
     "additionalProperties": False,
     "definitions": {
         "id": {
-            "type": "string",
+            "$ref": "/schemas/common_embed_definitions#/definitions/uuid",
             "description": "The ID of the topic content node on Studio",
         },
         "title": {"type": "string", "description": "The title of the topic"},
@@ -63,7 +63,7 @@
                 "language": {"$ref": "#/definitions/language"},
                 "ancestors": {"$ref": "#/definitions/ancestors"},
             },
-            "required": ["id", "title", "description"],
+            "required": ["id", "title", "description", "language"],
         },
     },
     "properties": {

spec/schema-embed_content_request.json

@@ -79,6 +79,10 @@
           "$ref": "/schemas/common_embed_definitions#/definitions/uuid",
           "description": "The UUID of the content resource"
         },
+        "channel_id": {
+          "$ref": "/schemas/common_embed_definitions#/definitions/uuid",
+          "description": "The UUID of the channel that the content resource belongs to"
+        },
         "title": {
           "type": "string",
           "description": "The title of the content resource"
@@ -89,7 +93,7 @@
         },
         "text": {
           "type": "string",
-          "description": "The cleaned up text extracted from the content resource (in markdown or plaintext format)"
+          "description": "Optional textual content to include in the embedding"
         },
         "language": {
           "$ref": "#/definitions/language"
@@ -108,9 +112,9 @@
       },
       "required": [
         "id",
+        "channel_id",
         "title",
         "description",
-        "text",
         "content_id"
       ]
     }

spec/schema-embed_topics_request.json

@@ -6,7 +6,7 @@
   "additionalProperties": false,
   "definitions": {
      "id": {
-      "type": "string",
+       "$ref": "/schemas/common_embed_definitions#/definitions/uuid",
       "description": "The ID of the topic content node on Studio"
     },
     "title": {
@@ -85,7 +85,8 @@
       "required": [
         "id",
         "title",
-        "description"
+        "description",
+        "language"
       ]
     }
   },