From 941ec8fdaf35a6fa068f2579377f63bbb309bfb7 Mon Sep 17 00:00:00 2001 From: shahha Date: Mon, 26 Mar 2018 19:15:28 +1100 Subject: [PATCH] Added SUPPORTED_SUBMIT_METHODS swagger ui setting (#91) --- docs/settings.rst | 9 +++++++++ src/drf_yasg/app_settings.py | 10 ++++++++++ src/drf_yasg/renderers.py | 1 + 3 files changed, 20 insertions(+) diff --git a/docs/settings.rst b/docs/settings.rst index e8b81d8..2444f1f 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -276,6 +276,15 @@ to the ``SwaggerUIBundle#initOAuth`` method, and must be a dictionary. See **Default**: :python:`{}` +SUPPORTED_SUBMIT_METHODS +------------------------ + +List of HTTP methods that have the Try it out feature enabled. An empty array disables Try it out for all operations. +This does not filter the operations from the display. + +**Default**: :python:`['get','put','post','delete','options','head','patch','trace']` |br| +*Maps to parameter*: ``supportedSubmitMethods`` + ****************** ``REDOC_SETTINGS`` ****************** diff --git a/src/drf_yasg/app_settings.py b/src/drf_yasg/app_settings.py index dd7b1cd..e3c1a64 100644 --- a/src/drf_yasg/app_settings.py +++ b/src/drf_yasg/app_settings.py @@ -46,6 +46,16 @@ SWAGGER_DEFAULTS = { 'DEFAULT_MODEL_DEPTH': 3, 'OAUTH2_REDIRECT_URL': None, 'OAUTH2_CONFIG': {}, + 'SUPPORTED_SUBMIT_METHODS': [ + 'get', + 'put', + 'post', + 'delete', + 'options', + 'head', + 'patch', + 'trace' + ], } REDOC_DEFAULTS = { diff --git a/src/drf_yasg/renderers.py b/src/drf_yasg/renderers.py index bb086bb..6fe83ed 100644 --- a/src/drf_yasg/renderers.py +++ b/src/drf_yasg/renderers.py @@ -94,6 +94,7 @@ class _UIRenderer(BaseRenderer): 'defaultModelExpandDepth': swagger_settings.DEFAULT_MODEL_DEPTH, 'defaultModelsExpandDepth': swagger_settings.DEFAULT_MODEL_DEPTH, 'oauth2RedirectUrl': swagger_settings.OAUTH2_REDIRECT_URL, + 'supportedSubmitMethods': swagger_settings.SUPPORTED_SUBMIT_METHODS, } data = {k: v for k, v in data.items() if v is not None} if swagger_settings.VALIDATOR_URL != '':