docs: Correct list of values for api/v3/texts return_format #2

Sefaria · Mar 28, 2024 · 713b15e · 713b15e
1 parent 26f195b
commit 713b15e
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/docs/openAPI.json b/docs/openAPI.json
@@ -994,7 +994,14 @@
                     "name": "return_format",
                     "description": "This query parameter formats the text that will be returned",
                     "schema": {
-                        "$ref": "#/components/schemas/return_format"
+                        "description": "This parameter formats the text that will be returned from the `v3` `texts/` API. It can have one of four values:\n1. `text_only` - This strips footnotes, inline references and all html tags from the returned text\n2. `strip_only_footnotes` - This only strips the footnotes and commentator <i> tags without stripping the other HTML tags.This is useful for the native app, where we do not display footnotes.\n3. `wrap_all_entities` - This wraps the HTML for links and topic links\n4. `default` - This returns the basic text as it’s saved in Sefaria’s DB\n",
+                        "type": "string",
+                        "enum": [
+                            'default', 
+                            'wrap_all_entities', 
+                            'strip_only_footnotes', 
+                            'text_only'
+                        ]
                     },
                     "in": "query"
                 }
@@ -9007,11 +9014,6 @@
                     }
                 }
             },
-            "return_format": {
-                "description": "This parameter formats the text that will be returned from the `v3` `texts/` API. It can have one of four values:\n1. `text_only` - This strips footnotes, inline references and all html tags from the returned text\n2. `strip_only_footnotes` - This only strips the footnotes and commentator <i> tags without stripping the other HTML tags.This is useful for the native app, where we do not display footnotes.\n3. `wrap_all_entities` - This wraps the HTML for links and topic links\n4. `default` - This returns the basic text as it’s saved in Sefaria’s DB\n",
-                "type": "string",
-                "enum": ['default', 'wrap_all_entities', 'strip_only_footnotes', 'text_only']
-            },
             "v3TextsJson": {
                 "title": "Root Type for v3TextsJson",
                 "description": "The JSON returned from the `v3` `texts/` endpoint. ",