From 74a635590c30262e08b409c22ca544feaf5052ad Mon Sep 17 00:00:00 2001 From: saengel Date: Wed, 3 Apr 2024 13:25:18 +0300 Subject: [PATCH] fix(Docs): Adjust schema of v3 for optimal Readme rendering --- docs/openAPI.json | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/openAPI.json b/docs/openAPI.json index f2536ba133..f2f360f1f4 100644 --- a/docs/openAPI.json +++ b/docs/openAPI.json @@ -992,16 +992,16 @@ } }, "name": "return_format", - "description": "This query parameter formats the text that will be returned", + "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 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", "schema": { - "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 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' - ] + "default", + "wrap_all_entities", + "strip_only_footnotes", + "text_only" + ], + "type": "string", + "default": "default" }, "in": "query" }