From 91530b64c6f0c72f786e348269ba40e3bd15d130 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cristi=20V=C3=AEjdea?= Date: Mon, 10 Sep 2018 14:02:25 +0300 Subject: [PATCH] Add DISPLAY_OPERATION_ID setting for swagger-ui Closes #206. --- docs/settings.rst | 8 ++++++++ src/drf_yasg/app_settings.py | 1 + src/drf_yasg/renderers.py | 1 + src/drf_yasg/static/drf-yasg/swagger-ui-init.js | 1 - 4 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/settings.rst b/docs/settings.rst index a4000da..989cc63 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -332,6 +332,14 @@ This does not filter the operations from the display. **Default**: :python:`['get','put','post','delete','options','head','patch','trace']` |br| *Maps to parameter*: ``supportedSubmitMethods`` +DISPLAY_OPERATION_ID +-------------------- + +Controls the display of operationId in operations list. + +**Default**: :python:`True` +*Maps to parameter*: ``displayOperationId`` + ************** REDOC_SETTINGS ************** diff --git a/src/drf_yasg/app_settings.py b/src/drf_yasg/app_settings.py index 901f46c..04a2e64 100644 --- a/src/drf_yasg/app_settings.py +++ b/src/drf_yasg/app_settings.py @@ -63,6 +63,7 @@ SWAGGER_DEFAULTS = { 'patch', 'trace' ], + 'DISPLAY_OPERATION_ID': True, } REDOC_DEFAULTS = { diff --git a/src/drf_yasg/renderers.py b/src/drf_yasg/renderers.py index 04c0c6a..c8c9de3 100644 --- a/src/drf_yasg/renderers.py +++ b/src/drf_yasg/renderers.py @@ -133,6 +133,7 @@ class SwaggerUIRenderer(_UIRenderer): 'showCommonExtensions': swagger_settings.SHOW_COMMON_EXTENSIONS, 'oauth2RedirectUrl': swagger_settings.OAUTH2_REDIRECT_URL, 'supportedSubmitMethods': swagger_settings.SUPPORTED_SUBMIT_METHODS, + 'displayOperationId': swagger_settings.DISPLAY_OPERATION_ID, } data = filter_none(data) diff --git a/src/drf_yasg/static/drf-yasg/swagger-ui-init.js b/src/drf_yasg/static/drf-yasg/swagger-ui-init.js index fc26231..3a24e65 100644 --- a/src/drf_yasg/static/drf-yasg/swagger-ui-init.js +++ b/src/drf_yasg/static/drf-yasg/swagger-ui-init.js @@ -32,7 +32,6 @@ function initSwaggerUi() { var swaggerConfig = { url: specURL, dom_id: '#swagger-ui', - displayOperationId: true, displayRequestDuration: true, presets: [ SwaggerUIBundle.presets.apis,