clarifies the level property

learningequality · Feb 1, 2024 · 55fe5d4 · 55fe5d4
1 parent b6c558b
commit 55fe5d4
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/js/EmbedTopicsRequest.js b/js/EmbedTopicsRequest.js
@@ -29,7 +29,7 @@ export const SCHEMA = {
     },
     "level": {
       "type": "integer",
-      "description": "The level of the ancestor, where the parent is 1 and the root is the highest level"
+      "description": "The level of the ancestor, where the root is 0 and the parent is the highest level"
     },
     "ancestor": {
       "type": "object",
@@ -61,7 +61,7 @@ export const SCHEMA = {
     },
     "ancestors": {
       "type": "array",
-      "description": "The ancestors of the topic, in order, from the parent to the root",
+      "description": "The ancestors of the topic. Please see 'level' in the ancestor schema for more information",
       "items": {
         "$ref": "#/definitions/ancestor"
       }

diff --git a/le_utils/constants/embed_topics_request.py b/le_utils/constants/embed_topics_request.py
@@ -32,7 +32,7 @@
         },
         "level": {
             "type": "integer",
-            "description": "The level of the ancestor, where the parent is 1 and the root is the highest level",
+            "description": "The level of the ancestor, where the root is 0 and the parent is the highest level",
         },
         "ancestor": {
             "type": "object",
@@ -49,7 +49,7 @@
         },
         "ancestors": {
             "type": "array",
-            "description": "The ancestors of the topic, in order, from the parent to the root",
+            "description": "The ancestors of the topic. Please see 'level' in the ancestor schema for more information",
             "items": {"$ref": "#/definitions/ancestor"},
         },
         "topic": {

diff --git a/spec/schema-embed_topics_request.json b/spec/schema-embed_topics_request.json
@@ -24,7 +24,7 @@
     },
     "level": {
       "type": "integer",
-      "description": "The level of the ancestor, where the parent is 1 and the root is the highest level"
+      "description": "The level of the ancestor, where the root is 0 and the parent is the highest level"
     },
     "ancestor": {
       "type": "object",
@@ -56,7 +56,7 @@
     },
     "ancestors": {
       "type": "array",
-      "description": "The ancestors of the topic, in order, from the parent to the root",
+      "description": "The ancestors of the topic. Please see 'level' in the ancestor schema for more information",
       "items": {
         "$ref": "#/definitions/ancestor"
       }