From 9cabe1a5038d5ea371bb4b05fd506050b4641f51 Mon Sep 17 00:00:00 2001 From: Denis Chernosov Date: Tue, 22 Sep 2020 13:07:00 +0400 Subject: [PATCH 1/3] add new swagger-ui display config options --- core/configuration.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/core/configuration.md b/core/configuration.md index 1d6f59523db..dbe8f3eaf37 100644 --- a/core/configuration.md +++ b/core/configuration.md @@ -224,7 +224,14 @@ api_platform: name: # URL to the license used for the API. MUST be in the format of a URL. url: - + + # Display resources config + display: + # Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). + doc_expansion: list + # If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. + filter: false + http_cache: # To make all responses public by default. public: ~ From 7e723cb62f3097e21b4b4b9bf6036ad01a8e8b58 Mon Sep 17 00:00:00 2001 From: Chernosov Denis Date: Wed, 30 Sep 2020 12:54:47 +0400 Subject: [PATCH 2/3] rename swagger.display to swagger.ui --- core/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/core/configuration.md b/core/configuration.md index dbe8f3eaf37..d86da036087 100644 --- a/core/configuration.md +++ b/core/configuration.md @@ -225,8 +225,8 @@ api_platform: # URL to the license used for the API. MUST be in the format of a URL. url: - # Display resources config - display: + # Swagger UI resources config + ui: # Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). doc_expansion: list # If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. From cef58aecbe585684939ad2769e666a3f71004300 Mon Sep 17 00:00:00 2001 From: Alan Poulain Date: Tue, 23 Feb 2021 10:27:27 +0100 Subject: [PATCH 3/3] use swagger_ui_extra_configuration --- core/configuration.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/core/configuration.md b/core/configuration.md index d86da036087..a8e1fa45989 100644 --- a/core/configuration.md +++ b/core/configuration.md @@ -207,6 +207,13 @@ api_platform: # Whether the API key should be a query parameter or a header. # type: 'query' or 'header' + swagger_ui_extra_configuration: + # Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). + docExpansion: list + # If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. + filter: false + # You can use any other configuration parameters too. + openapi: # The contact information for the exposed API. contact: @@ -223,14 +230,14 @@ api_platform: # The license name used for the API. name: # URL to the license used for the API. MUST be in the format of a URL. - url: + url: - # Swagger UI resources config - ui: + swagger_ui_extra_configuration: # Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). - doc_expansion: list + docExpansion: list # If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. filter: false + # You can use any other configuration parameters too. http_cache: # To make all responses public by default.