RequestHeader=set X-Forwarded-Prefix "/custom-path"+
RequestHeader set X-Forwarded-Prefix "/custom-path"
From 8dd98cd1aa57a30e985fbaa4071c2419269332f1 Mon Sep 17 00:00:00 2001
From: Tao Sun springdoc.nullable-request-parameter-enabled springdoc.show-oauth2-endpoint springdoc.nullable-request-parameter-enabled springdoc.show-oauth2-endpoint springdoc.nullable-request-parameter-enabled springdoc.show-oauth2-endpoint springdoc.nullable-request-parameter-enabled springdoc.show-oauth2-endpoint https://github.com/springdoc/springdoc-openapi-demos.git https://github.com/springdoc/springdoc-openapi-demos/tree/2.x springdoc.nullable-request-parameter-enabled springdoc.show-oauth2-endpoint https://github.com/springdoc/springdoc-openapi-demos.git https://github.com/springdoc/springdoc-openapi-demos/tree/2.x springdoc.nullable-request-parameter-enabled springdoc.show-oauth2-endpoint All the modules have been renamed.
+ The following table describes the main modules changes: Includes foundation For Spring Data Rest support For Groovy support For Spring Hateoas support For Javadoc support For Kotlin support For Spring Native support For Spring Security support For Spring WebMvc support For Spring WebFlux support For using the Swagger-UI in a Spring WebMvc context For using the Swagger-UI in a Spring WebFlux context The following modules are not anymore needed and can be removed: In addition: Replace Replace This dependency is based on the library therapi-runtime-javadoc This dependency is based on the library therapi-runtime-javadoc
RequestHeader=set X-Forwarded-Prefix "/custom-path"
+RequestHeader set X-Forwarded-Prefix "/custom-path"
RequestHeader=set X-Forwarded-Prefix "/custom-path"
+RequestHeader set X-Forwarded-Prefix "/custom-path"
RequestHeader=set X-Forwarded-Prefix "/custom-path"
+RequestHeader set X-Forwarded-Prefix "/custom-path"
RequestHeader=set X-Forwarded-Prefix "/custom-path"
+RequestHeader set X-Forwarded-Prefix "/custom-path"
RequestHeader set X-Forwarded-Prefix "/custom-path"
+RequestHeader=set X-Forwarded-Prefix "/custom-path"
RequestHeader set X-Forwarded-Prefix "/custom-path"
+RequestHeader=set X-Forwarded-Prefix "/custom-path"
RequestHeader set X-Forwarded-Prefix "/custom-path"
+RequestHeader=set X-Forwarded-Prefix "/custom-path"
RequestHeader set X-Forwarded-Prefix "/custom-path"
+RequestHeader=set X-Forwarded-Prefix "/custom-path"
false
+Boolean. To default set parameters to form data when specifying api to accept form data.
+
+
+
+true
+Boolean. To default Enable Support for nullable request parameters in Kotlin.
+
+
+false
+Boolean. To make spring security oauth2-endpoint visible.false
+Boolean. To default set parameters to form data when specifying api to accept form data.
+
+
+
+true
+Boolean. To default Enable Support for nullable request parameters in Kotlin.
+
diff --git a/docs/properties.html b/docs/properties.html
index 9878534..961f709 100644
--- a/docs/properties.html
+++ b/docs/properties.html
@@ -271,6 +271,16 @@
+
+false
+Boolean. To make spring security oauth2-endpoint visible.false
+Boolean. To default set parameters to form data when specifying api to accept form data.
+
+
+
+true
+Boolean. To default Enable Support for nullable request parameters in Kotlin.
+
diff --git a/docs/v2/core-properties.html b/docs/v2/core-properties.html
index 896c684..b734b6d 100644
--- a/docs/v2/core-properties.html
+++ b/docs/v2/core-properties.html
@@ -293,12 +293,22 @@
+
+false
+Boolean. To make spring security oauth2-endpoint visible.false
+Boolean. To default set parameters to form data when specifying api to accept form data.
+
+
+
+true
+Boolean. To default Enable Support for nullable request parameters in Kotlin.
+
diff --git a/docs/v2/faq.html b/docs/v2/faq.html
index 9610ad0..5f779b7 100644
--- a/docs/v2/faq.html
+++ b/docs/v2/faq.html
@@ -1186,7 +1186,7 @@
+
+false
+Boolean. To make spring security oauth2-endpoint visible.
@@ -1869,7 +1869,7 @@
diff --git a/docs/v2/index.html b/docs/v2/index.html
index 6a6053d..398806b 100644
--- a/docs/v2/index.html
+++ b/docs/v2/index.html
@@ -1441,6 +1441,16 @@
false
+Boolean. To default set parameters to form data when specifying api to accept form data.
+
+
+
+true
+Boolean. To default Enable Support for nullable request parameters in Kotlin.
+
@@ -3663,7 +3673,7 @@
+
+false
+Boolean. To make spring security oauth2-endpoint visible.
diff --git a/docs/v2/properties.html b/docs/v2/properties.html
index 9878534..961f709 100644
--- a/docs/v2/properties.html
+++ b/docs/v2/properties.html
@@ -271,6 +271,16 @@ false
+Boolean. To default set parameters to form data when specifying api to accept form data.
+
+
+
+true
+Boolean. To default Enable Support for nullable request parameters in Kotlin.
+
diff --git a/src/docs/asciidoc/core-properties.adoc b/src/docs/asciidoc/core-properties.adoc
index 7a2952a..b85514d 100644
--- a/src/docs/asciidoc/core-properties.adoc
+++ b/src/docs/asciidoc/core-properties.adoc
@@ -47,4 +47,6 @@
|springdoc.api-docs.version | `openapi_3_0` | `String`. To Choose `OpenAPI 3.0` or `OpenAPI 3.1` (using the value `OPENAPI_3_1`).
|springdoc.default-flat-paramObject | `false` | `Boolean`. To default flatten parameter.
|springdoc.default-support-form-data | `false` | `Boolean`. To default set parameters to form data when specifying api to accept form data.
+|springdoc.nullable-request-parameter-enabled | `true` | `Boolean`. To default Enable Support for nullable request parameters in Kotlin.
+|springdoc.show-oauth2-endpoint | `false` | `Boolean`. To make spring security oauth2-endpoint visible.
|===
\ No newline at end of file
diff --git a/src/docs/asciidoc/v2/core-properties.adoc b/src/docs/asciidoc/v2/core-properties.adoc
index 5cce880..6d4fdf6 100644
--- a/src/docs/asciidoc/v2/core-properties.adoc
+++ b/src/docs/asciidoc/v2/core-properties.adoc
@@ -53,4 +53,6 @@
|springdoc.api-docs.version | `openapi_3_0` | `String`. To Choose `OpenAPI 3.0` or `OpenAPI 3.1` (using the value `OPENAPI_3_1`).
|springdoc.default-flat-paramObject | `false` | `Boolean`. To default flatten parameter.
|springdoc.default-support-form-data | `false` | `Boolean`. To default set parameters to form data when specifying api to accept form data.
+|springdoc.nullable-request-parameter-enabled | `true` | `Boolean`. To default Enable Support for nullable request parameters in Kotlin.
+|springdoc.show-oauth2-endpoint | `false` | `Boolean`. To make spring security oauth2-endpoint visible.
|===
\ No newline at end of file
diff --git a/src/docs/asciidoc/v2/faq.adoc b/src/docs/asciidoc/v2/faq.adoc
index 6bcc9fa..273491b 100644
--- a/src/docs/asciidoc/v2/faq.adoc
+++ b/src/docs/asciidoc/v2/faq.adoc
@@ -554,7 +554,7 @@ public OpenApiCustomizer customerGlobalHeaderOpenApiCustomizer() {
=== Where can I find the source code of the demo applications?
* The source code of the application is available at the following GitHub repository:
-** link:https://github.com/springdoc/springdoc-openapi-demos.git[https://github.com/springdoc/springdoc-openapi-demos.git, window="_blank"]
+** link:https://github.com/springdoc/springdoc-openapi-demos/tree/2.x[https://github.com/springdoc/springdoc-openapi-demos/tree/2.x, window="_blank"]
=== Does this library supports annotations from interfaces?
* Yes
From 090a012c4e9ac57a055f9d1bb5e749dc6e9286a7 Mon Sep 17 00:00:00 2001
From: "Badr.NassLahsen"
+
+false
+Boolean. To make spring security oauth2-endpoint visible.Migrating from springdoc-openapi v1
+springdoc-openapi-starter-common integrates many spring modules support in order to hide the maximum of complexity.
+It allows the support out of the box for Actuator / Spring Cloud Function / Spring Data Rest/ Spring Native/ Spring Hateoas / Spring Securtiy / Kotlin/ Javadoc.
+
+
+
+
+
+springdoc-openapi-v1
+springdoc-openapi-v2
+Description
+
+
+
+springdoc-openapi-common
+springdoc-openapi-starter-common
+springdoc-openapi features
+
+
+springdoc-openapi-data-rest
+springdoc-openapi-starter-common
+
+
+
+springdoc-openapi-groovy
+springdoc-openapi-starter-common
+
+
+
+springdoc-openapi-hateoas
+springdoc-openapi-starter-common
+
+
+
+springdoc-openapi-javadoc
+springdoc-openapi-starter-common
+
+
+
+springdoc-openapi-kotlin
+springdoc-openapi-starter-common
+
+
+
+springdoc-openapi-native
+springdoc-openapi-starter-common
+
+
+
+springdoc-openapi-security
+springdoc-openapi-starter-common
+
+
+
+springdoc-openapi-webmvc-core
+springdoc-openapi-starter-webmvc-api
+
+
+
+springdoc-openapi-webflux-core
+springdoc-openapi-starter-webflux-api
+
+
+
+springdoc-openapi-ui
+springdoc-openapi-starter-webmvc-ui
+
+
+
+
+springdoc-openapi-webflux-ui
+springdoc-openapi-starter-webflux-ui
+
+
+
+
+
+
+
+
+classes/annotations changes
+
+
+
+
+
+
+
+springdoc-openapi-v1
+springdoc-openapi-v2
+
+
+
+org.springdoc.core.SpringDocUtils
+org.springdoc.core.utils.SpringDocUtils
+
+
+org.springdoc.api.annotations.ParameterObject
+org.springdoc.core.annotations.ParameterObject
+
+
+org.springdoc.core.GroupedOpenApi
+org.springdoc.core.models.GroupedOpenApi
+
+
+org.springdoc.core.customizers.OpenApiCustomiser
+org.springdoc.core.customizers.OpenApiCustomizer
+
+
+org.springdoc.core.Constants
+org.springdoc.core.utils.Constants
+
+
+
+org.springdoc.core.SwaggerUiConfigParameters
+org.springdoc.core.properties.SwaggerUiConfigParameters
+
+
+
+
+
+
+
+Migration tips
+
+
+
+springdoc-openapi-javadocspringdoc-openapi-kotlinspringdoc-openapi-data-restspringdoc-openapi-securityspringdoc-openapi-webmvc-corespringdoc-openapi-webflux-corespringdoc-openapi-hateoasspringdoc-openapi-groovy
+
+springdoc-openapi-ui by springdoc-openapi-starter-webmvc-uispringdoc-openapi-webflux-ui by springdoc-openapi-starter-webflux-ui
RequestHeader=set X-Forwarded-Prefix "/custom-path"
+RequestHeader set X-Forwarded-Prefix "/custom-path"
RequestHeader=set X-Forwarded-Prefix "/custom-path"
+RequestHeader set X-Forwarded-Prefix "/custom-path"
RequestHeader=set X-Forwarded-Prefix "/custom-path"
+RequestHeader set X-Forwarded-Prefix "/custom-path"
3.11. Jav
-
@@ -795,14 +792,15 @@
3.11. Jav
-Make sure, you enable the annotation processor of
therapi-runtime-javadoc in order to enable javadoc support for springdoc-openapi.
+springdoc-openapi-starter-common relies on therapi-runtime-javadoc to read Javadoc comments at runtime. Ensure that you add it as well as its annotation processor to your project’s dependencies. Otherwise, the Javadoc support will fail silently.
<build>
+
+ </build>
+
+ <!-- Runtime library -->
+ <dependency>
+ <groupId>com.github.therapi</groupId>
+ <artifactId>therapi-runtime-javadoc</artifactId>
+ <version>0.15.0</version>
+ </dependency> <!--Annotation processor -->
+ <build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -818,7 +816,14 @@ 3.11. Jav
</configuration>
</plugin>
</plugins>
- </build>
RequestHeader=set X-Forwarded-Prefix "/custom-path"
+RequestHeader set X-Forwarded-Prefix "/custom-path"
Javadoc
@@ -464,14 +461,15 @@
Javadoc
-Make sure, you enable the annotation processor of
therapi-runtime-javadoc in order to enable javadoc support for springdoc-openapi.
+springdoc-openapi-starter-common relies on therapi-runtime-javadoc to read Javadoc comments at runtime. Ensure that you add it as well as its annotation processor to your project’s dependencies. Otherwise, the Javadoc support will fail silently.
<build>
+
+ </build>
+
+ <!-- Runtime library -->
+ <dependency>
+ <groupId>com.github.therapi</groupId>
+ <artifactId>therapi-runtime-javadoc</artifactId>
+ <version>0.15.0</version>
+ </dependency> <!--Annotation processor -->
+ <build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -487,7 +485,14 @@ Javadoc
</configuration>
</plugin>
</plugins>
- </build>
springdoc-openapi is compatible with spring-boot 1 and spring-boot 2.
In general, you should only pick the last stable version as per today 1.6.14.
+In general, you should only pick the last stable version as per today 1.6.15.
More precisely, this the exhaustive list of spring-boot versions against which springdoc-openapi has been built:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webmvc-core</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webflux-ui</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -511,7 +511,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-hateoas</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -527,7 +527,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-data-rest</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -543,7 +543,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-security</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -560,7 +560,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-native</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -898,7 +898,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-kotlin</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -924,7 +924,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-groovy</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -939,7 +939,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-javadoc</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -2073,7 +2073,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -4345,7 +4345,7 @@ springdoc-openapi is compatible with spring-boot 1 and spring-boot 2.
In general, you should only pick the last stable version as per today 1.6.14.
+In general, you should only pick the last stable version as per today 1.6.15.
More precisely, this the exhaustive list of spring-boot versions against which springdoc-openapi has been built:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webmvc-core</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -125,7 +125,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-webflux-ui</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -142,7 +142,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-hateoas</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -158,7 +158,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-data-rest</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -174,7 +174,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-security</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -191,7 +191,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-native</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -529,7 +529,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-kotlin</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -555,7 +555,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-groovy</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
@@ -570,7 +570,7 @@ <dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-javadoc</artifactId>
- <version>1.6.14</version>
+ <version>1.6.15</version>
</dependency>
diff --git a/docs/v2/faq.html b/docs/v2/faq.html
index cbc484b..2f7ade7 100644
--- a/docs/v2/faq.html
+++ b/docs/v2/faq.html
@@ -1812,7 +1812,7 @@ springdoc-openapi 2.x is compatible with spring-boot 3.
In general, you should only pick the last stable version as per today 2.0.2.
+In general, you should only pick the last stable version as per today 2.0.3.
More precisely, this the exhaustive list of spring-boot versions against which springdoc-openapi has been built:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
- <version>2.0.2</version>
+ <version>2.0.3</version>
</dependency>
@@ -96,7 +96,7 @@