Swagger UI 5.4.2 (#1179)

Redoc 2.1.1 Allow null values for extensions properties in openapi object Added Swagger UI property persistAuthorization Fixed #1178
micronaut-projects · Sep 13, 2023 · 10869e4 · 10869e4
1 parent 08bb0b7
commit 10869e4
Show file tree

Hide file tree

Showing 7 changed files with 278 additions and 259 deletions.
diff --git a/openapi/src/main/java/io/micronaut/openapi/swagger/core/jackson/mixin/OpenAPIMixin.java b/openapi/src/main/java/io/micronaut/openapi/swagger/core/jackson/mixin/OpenAPIMixin.java
@@ -25,6 +25,7 @@
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 
 /**
@@ -36,6 +37,7 @@
 public abstract class OpenAPIMixin {
 
     @JsonAnyGetter
+    @JsonInclude
     public abstract Map<String, Object> getExtensions();
 
     @JsonAnySetter

diff --git a/openapi/src/main/java/io/micronaut/openapi/view/SwaggerUIConfig.java b/openapi/src/main/java/io/micronaut/openapi/view/SwaggerUIConfig.java
@@ -63,7 +63,7 @@ final class SwaggerUIConfig extends AbstractViewConfig {
     private static final String COMMNA_NEW_LINE = ",\n";
 
     // https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md
-    private static final Map<String, Function<String, Object>> VALID_OPTIONS = new HashMap<>(29);
+    private static final Map<String, Function<String, Object>> VALID_OPTIONS = new HashMap<>(30);
     // https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/oauth2.md
     private static final Map<String, Function<String, Object>> VALID_OAUTH2_OPTIONS = new HashMap<>(9);
 
@@ -98,6 +98,7 @@ final class SwaggerUIConfig extends AbstractViewConfig {
         VALID_OPTIONS.put("supportedSubmitMethods", AbstractViewConfig::asString);
         VALID_OPTIONS.put("validatorUrl", AbstractViewConfig::asQuotedString);
         VALID_OPTIONS.put("withCredentials", AbstractViewConfig::asBoolean);
+        VALID_OPTIONS.put("persistAuthorization", AbstractViewConfig::asBoolean);
 
         VALID_OAUTH2_OPTIONS.put(OPTION_OAUTH2 + ".clientId", AbstractViewConfig::asQuotedString);
         VALID_OAUTH2_OPTIONS.put(OPTION_OAUTH2 + ".clientSecret", AbstractViewConfig::asQuotedString);

diff --git a/openapi/src/main/resources/templates/redoc/res/redoc.standalone.js b/openapi/src/main/resources/templates/redoc/res/redoc.standalone.js
diff --git a/openapi/src/main/resources/templates/swagger-ui/res/swagger-ui-bundle.js b/openapi/src/main/resources/templates/swagger-ui/res/swagger-ui-bundle.js
diff --git a/openapi/src/main/resources/templates/swagger-ui/res/swagger-ui-standalone-preset.js b/openapi/src/main/resources/templates/swagger-ui/res/swagger-ui-standalone-preset.js
diff --git a/openapi/src/test/groovy/io/micronaut/openapi/view/OpenApiOperationViewParseSpec.groovy b/openapi/src/test/groovy/io/micronaut/openapi/view/OpenApiOperationViewParseSpec.groovy
@@ -60,7 +60,7 @@ class OpenApiOperationViewParseSpec extends Specification {
 
     void "test parse OpenApiView specification, swagger-ui enabled"() {
         given:
-        String spec = "swagger-ui.enabled=true,swagger-ui.js.url=version123,swagger-ui.spec.url=/my/spec/file.yml,swagger-ui.theme=flattop,swagger-ui.deepLinking=false"
+        String spec = "swagger-ui.enabled=true,swagger-ui.js.url=version123,swagger-ui.spec.url=/my/spec/file.yml,swagger-ui.theme=flattop,swagger-ui.deepLinking=false,swagger-ui.persistAuthorization=true"
         OpenApiViewConfig cfg = OpenApiViewConfig.fromSpecification(spec, null, new Properties(), null)
 
         expect:
@@ -73,5 +73,6 @@ class OpenApiOperationViewParseSpec extends Specification {
         cfg.swaggerUIConfig.specUrl == "/my/spec/file.yml"
         cfg.swaggerUIConfig.theme == SwaggerUIConfig.Theme.FLATTOP
         cfg.swaggerUIConfig.options['deepLinking'] == false
+        cfg.swaggerUIConfig.options['persistAuthorization'] == true
     }
 }
diff --git a/src/main/docs/guide/openApiViews/swaggerui.adoc b/src/main/docs/guide/openApiViews/swaggerui.adoc
@@ -28,6 +28,7 @@ The views will be generated to the `META-INF/swagger/views/swagger-ui` directory
 | `swagger-ui.showExtensions` |
 | `swagger-ui.operationsSorter` |
 | `swagger-ui.tagsSorter` |
+| `swagger-ui.persistAuthorization` |
 |===
 
 See https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md[Swagger UI Configuration] for a description.