From a6ae8b05214f0444cbda5ddd4e38fd70412b83c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cristi=20V=C3=AEjdea?= Date: Mon, 10 Sep 2018 14:02:37 +0300 Subject: [PATCH] Add ReDoc settings descriptions --- docs/settings.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/settings.rst b/docs/settings.rst index 989cc63..7d30bb1 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -364,6 +364,10 @@ URL which serves the UI; see :ref:`note on URL settings ` above. LAZY_RENDERING -------------- +If set, enables lazy rendering mode in ReDoc. This mode is useful for APIs with big number of operations (e.g. > 50). +In this mode ReDoc shows initial screen ASAP and then renders the rest operations asynchronously while showing +progress bar on the top. + **NOTE:** this feature might be removed in future versions of ReDoc (see https://github.com/Rebilly/ReDoc/issues/475) **Default**: :python:`False` |br| @@ -372,30 +376,42 @@ LAZY_RENDERING HIDE_HOSTNAME ------------- +If set, the protocol and hostname is not shown in the operation definition. + **Default**: :python:`False` |br| *Maps to attribute*: ``hideHostname`` EXPAND_RESPONSES ---------------- +Specify which responses to expand by default by response codes. Values should be passed as comma-separated list without +spaces e.g. expandResponses="200,201". Special value "all" expands all responses by default. +Be careful: this option can slow-down documentation rendering time. + **Default**: :python:`'all'` |br| *Maps to attribute*: ``expandResponses`` PATH_IN_MIDDLE -------------- +Show path link and HTTP verb in the middle panel instead of the right one. + **Default**: :python:`False` |br| *Maps to attribute*: ``pathInMiddlePanel`` NATIVE_SCROLLBARS ----------------- +Use native scrollbar for sidemenu instead of perfect-scroll (scrolling performance optimization for big specs). + **Default**: :python:`False` |br| *Maps to attribute*: ``nativeScrollbars`` REQUIRED_PROPS_FIRST -------------------- +Show required properties first ordered in the same order as in required array. + **Default**: :python:`False` |br| *Maps to attribute*: ``requiredPropsFirst``