Adds level property to the ancestors schema definition

learningequality · Feb 1, 2024 · 258e663 · 258e663
1 parent 415210b
commit 258e663
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/js/EmbedTopicsRequest.js b/js/EmbedTopicsRequest.js
@@ -14,7 +14,14 @@ export const SCHEMA = {
       "type": "array",
       "description": "The ancestors of the topic, in order, from the parent to the root",
       "items": {
-        "$ref": "#/definitions/topic"
+        "$ref": "#/definitions/topic",
+        "properties": {
+          "level": {
+            "type": "integer",
+            "description": "The level of the ancestor, where the parent is 1 and the root is the highest level"
+          }
+        },
+        "required": ["level"]
       }
     },
     "language": {

diff --git a/le_utils/constants/embed_topics_request.py b/le_utils/constants/embed_topics_request.py
@@ -19,7 +19,16 @@
         "ancestors": {
             "type": "array",
             "description": "The ancestors of the topic, in order, from the parent to the root",
-            "items": {"$ref": "#/definitions/topic"},
+            "items": {
+                "$ref": "#/definitions/topic",
+                "properties": {
+                    "level": {
+                        "type": "integer",
+                        "description": "The level of the ancestor, where the parent is 1 and the root is the highest level",
+                    }
+                },
+                "required": ["level"],
+            },
         },
         "language": {
             "type": "string",

diff --git a/spec/schema-embed_topics_request.json b/spec/schema-embed_topics_request.json
@@ -9,7 +9,14 @@
       "type": "array",
       "description": "The ancestors of the topic, in order, from the parent to the root",
       "items": {
-        "$ref": "#/definitions/topic"
+        "$ref": "#/definitions/topic",
+        "properties": {
+          "level": {
+            "type": "integer",
+            "description": "The level of the ancestor, where the parent is 1 and the root is the highest level"
+          }
+        },
+        "required": ["level"]
       }
     },
     "language": {