releasing v1.8.0

springdoc · Mar 12, 2024 · 1a90a37 · 1a90a37
1 parent 843bf1d
commit 1a90a37
Show file tree

Hide file tree

Showing 192 changed files with 7,108 additions and 1,160 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,12 +5,78 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.8.0] - 2024-03-12
+
+### Added
+
+- #2189 - Add support for swagger-ui.url property
+- #2200 - Support schema.requiredMode() on ParameterObject
+- #2309 - Added function to preload by specifying locale
+- #2332 - Group name cannot be null or empty
+- #2281 - Initial Virtual thread support
+- #2311 - Enhance springdoc-ui to support spring.mvc.servlet.path
+- #2340 - Add support OIDC with Spring Authorization Server
+- #2345 - Support Schema added in OpenAPI Specification v3.1
+- #2387 - Support get javadoc description from getter method
+- #2404 - Update condition to register links schema customizer
+- #2359 - Update condition to register links schema customizer
+- #2348 - Enhance resource path processing
+- #2438, #2315 - Support for @JsonProperty with Javadoc Change in springdoc-openapi
+- #2443 - Respect schema annotations when using spring mvc with kotlin
+- #2492, #2488 - Support dynamic evaluation of description field in the RequestBody
+- #2510 - Option to disable root api-docs path when using groups
+
+### Changed
+
+- Upgrade spring-boot to 2.7.14
+- Upgrade swagger-core to 2.2.20
+- Upgrade swagger-ui to 5.11.8
+
+### Fixed
+
+- #2199 - Fix Schema get condition of ArraySchema.
+- #2194 - Fix Swagger UI with provided spec
+- #2213 - Using both generated and configured specs stoped working in 1.6.5
+- #2222 - String Index Out of Bounce Exception Fix when deployed on Azure
+- #2243, #2235 - Fix StringIndexOutOfBoundsException when path is same webjar
+- #2291 - Fix default-flat-param-object doesn't work when using http body
+- #2310 - Change bean name of objectMapperProvider
+- #2207 - swagger-initializer.js is sent endcoded in the JVM's default charset
+-  #2271, #2280 - Fix loop when response inherits generic class fixes
+- #2239 - Swagger UI not accessible when FormattingConversionService is a CGLIB proxy
+- #2366 - Fix the failed test due to hardcoded file separators
+- #2370, #2371 - No empty description for polymorphic subtypes
+- #2373 - SchemaProperty.array Schema is ignored in /api-docs or api-docs.yaml
+- #2366 - Refactoring AbstractSwaggerResourceResolver.findWebJarResourcePath
+- #2320 - javadoc for class attribute ignored when in EntityModel.
+- #2347 - Not working if a property of entity contains generic parameters.
+- #2399 - SpringdocRouteBuilder.onError is overriding last route defined.
+- #2426 -  StackOverflowError when using @ParameterObject on groovy class.
+- #2453 - Fix CODE_OF_CONDUCT.md links
+- #2454 - Fix typo in SwaggerWelcomeWebMvc
+- #2507 - Fix typo in Constants
+- #2472 - Update JavadocPropertyCustomizer.java
+- #2495 - Fix broken links in README and CONTRIBUTING
+- #2501 - bug fix when "exported" is set to false in RestResource annotation
+- #2447 - Serialization to openapi of org.springframework.data.domain.Sort is not done correctly
+- #2449 - Extensions in subobjects of OpenAPI no longer work
+- #2461 - Springdoc OpenApi Annotations @ExtensionProperty Not Evaluating Properties from application.yml
+- #2469 - Pom contains invalid organizationUrl
+- #2518 - Duplicate GroupConfigs in SpringDocConfigProperties
+- #2506 - Springdoc breaks (Unexpected value: TRACE) when a spring-cloud-starter-gateway-mvc universal gateway is configured.
+- #2519 - Request parameter parsing error after using @NotBlank from type interface field
+- #2516 - Spring Data REST fails when setting version to openapi_3_1
+- #2509 - ArrayIndexOutOfBoundsException in SwaggerUiConfigParameters
+- #2484 - JavaDoc integration not working with SnakeCaseStrategy property naming
+- #2483 - Controller advice documents ApiResponse on every operation, even if the operation does not annotate the exception to be thrown
+- #2477 - buildApiResponses ignores produced ContentType in case of many @Operation
+
 ## [1.7.0] - 2023-04-01
 
 ### Added
 
 - #2152 - Detect directions in default sort values
-- #2167 #2166 - Add request parameter for token endpoint 
+- #2167 #2166 - Add request parameter for token endpoint
 - #2188 - Support of {*param} path patterns
 
 ### Changed
@@ -19,7 +85,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Upgrade swagger-core to 2.2.9
 - Upgrade swagger-ui to 4.18.2
 - Spring Native is now superseded by Spring Boot 3 official
-- #2173 - Remove webjars-locator-core 
+- #2173 - Remove webjars-locator-core
 
 ### Fixed
 
@@ -28,8 +94,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - #2140 - Javadoc record class parameters not recognized
 - #2123 #2141 - fix spring authorization server response.
 - #2148 - Fix properties show-oauth2-endpoints and SpringDocConfigProperties#showOauth2Endpoint properties name mismatch
-- #2149 - Request parameters with default values are marked as required. 
-- #2155 - openApi.getServers() is null in OpenApiCustomiser when using different locales. 
+- #2149 - Request parameters with default values are marked as required.
+- #2155 - openApi.getServers() is null in OpenApiCustomiser when using different locales.
 - #2152 - Redundant(wrong) direction appended to @PageableDefault.
 - #2181 #2183 - Fixed DefaultFlatParamObject to work with annotated parameters.
 - #2170 #2187 - All request parameters marked as required for Java controllers in mixed projects in 2.0.3
@@ -42,8 +108,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - #2006 - Support for nullable request parameters in Kotlin.
 - #2054 - Add copyright and license information to Jar.
-- #2021 - Required field in Schema annotation ignored in Kotlin. 
-- #2094 - Initial support for Spring Authorization Server. 
+- #2021 - Required field in Schema annotation ignored in Kotlin.
+- #2094 - Initial support for Spring Authorization Server.
 ### Changed
 
 - Upgrade spring-boot to 2.7.9
@@ -52,7 +118,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- #2010 - findByNameContainingIgnoreCaseAndDateBefore throw NullPointerException. 
+- #2010 - findByNameContainingIgnoreCaseAndDateBefore throw NullPointerException.
 - #2031 - Path variables parameters are not assigned correctly to endpoints.
 - #2038 - When extends JpaRepository, using @Parameter over the method results in duplicate of the same parameter.
 - #2046 - Map Fields Disappear with Groovy on Classpath.
@@ -99,8 +165,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 - #1892 - springdoc.model-and-view-allowed enhanced
-- #1901 - When @Get, using @Parameter over the method results in duplicate of the same parameter 
-- #1909 - ExceptionHandler in controller is not used by another controller 
+- #1901 - When @Get, using @Parameter over the method results in duplicate of the same parameter
+- #1909 - ExceptionHandler in controller is not used by another controller
 - #1904 - springdoc-openapi-webflux-ui 2.0.0-M7 + spring actuator + spring cloud crashes at startup
 - #1911 - Wrong type for springdoc.swagger-ui.oauth.useBasicAuthenticationWithAccessCodeGrant configuration property
 - #1931 - Spring Security form login only offers application/json req body type.

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,4 +1,4 @@
-## Contributor Code of Conduct
+= Contributor Code of Conduct
 
 As contributors and maintainers of this project, and in the interest of fostering an open
 and welcoming community, we pledge to respect all people who contribute through reporting

diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc
@@ -79,7 +79,7 @@ If you have performed a checkout of this repository already, use "`File`" -> "`O
 Alternatively, you can let IntellIJ IDEA checkout the code for you.
 Use "`File`" ->
 "`New`" -> "`Project from Version Control`" and
-`https://github.com/springdoc/springdoc-openapi.git` for the URL.
+`https://github.com/springdoc/springdoc-openapi-v1.git` for the URL.
 Once the checkout has completed, a pop-up will suggest to open the project.
 
 ==== Install the Spring Formatter plugin
@@ -132,5 +132,5 @@ If you get `Filename too long`
 errors, set the `core.longPaths=true` git option:
 
 ```
-git clone -c core.longPaths=true https://github.com/springdoc/springdoc-openapi
+git clone -c core.longPaths=true https://github.com/springdoc/springdoc-openapi-v1
 ```
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 ![Octocat](https://springdoc.org/img/banner-logo.svg)
-[![Build Status](http://129.159.254.115:8686/buildStatus/icon?job=springdoc-openapi-IC)](http://129.159.254.115:8686/view/springdoc-openapi/job/springdoc-openapi-IC/)
-[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=springdoc_springdoc-openapi&metric=alert_status)](https://sonarcloud.io/dashboard?id=springdoc_springdoc-openapi)
+[![Build Status](https://ci-cd.springdoc.org:8443/buildStatus/icon?job=springdoc-openapi-IC)](https://ci-cd.springdoc.org:8443/view/springdoc-openapi/job/springdoc-openapi-IC/)
+[![Quality Gate Status](https://sonar.springdoc.org/api/project_badges/measure?project=springdoc-openapi&metric=alert_status&token=sqb_b0202ce5e7c6d83a91e0bcb04d1cf24419585e34)](https://sonar.springdoc.org/dashboard?id=springdoc-openapi)
 [![Known Vulnerabilities](https://snyk.io/test/github/springdoc/springdoc-openapi.git/badge.svg)](https://snyk.io/test/github/springdoc/springdoc-openapi.git)
 [![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/springdoc)](https://stackoverflow.com/questions/tagged/springdoc?tab=Votes)
 
@@ -17,9 +17,6 @@ This project is sponsored by
     <img src="https://springdoc.org/img/mercedes-benz.png" height="10%" width="10%" />
 </a>
 &nbsp;&nbsp;
-<a href="https://www.dm-jobs.com/dmTECH/?locale=de_DE&wt_mc=.display.github.sponsoring.logo" target="_blank">
-     <img src="https://springdoc.org/img/dmTECH_Logo.jpg" height="10%" width="10%" />
-</a>
 <a href="https://www.contrastsecurity.com/" target="_blank">
    <img src="https://springdoc.org/img/contrastsecurity.svg" height="10%" width="30%" />
 </a>
@@ -111,7 +108,7 @@ springdoc.swagger-ui.path=/swagger-ui.html
 
 ## Spring-boot with OpenAPI Demo applications.
 
-### [Source Code for Demo Applications](https://github.com/springdoc/springdoc-openapi-demos.git).
+### [Source Code for Demo Applications](https://github.com/springdoc/springdoc-openapi-v1-demos.git).
 
 ### [Demo Spring Boot 2 Web MVC with OpenAPI 3](http://158.101.191.70:8081/).
 
@@ -202,22 +199,22 @@ The artifacts can be viewed accessed at the following locations:
 
 Releases:
 
-* [https://s01.oss.sonatype.org/content/groups/public/org/springdoc/](https://s01.oss.sonatype.org/content/groups/public/org/springdoc/)
+* [https://nexus.springdoc.org/repository/maven-releases/org/springdoc/](https://nexus.springdoc.org/content/groups/public/org/springdoc/)
   .
 
 Snapshots:
 
-* [https://s01.oss.sonatype.org/content/repositories/snapshots/org/springdoc/](https://s01.oss.sonatype.org/content/repositories/snapshots/org/springdoc/)
+* [https://nexus.springdoc.orgg/repository/maven-snapshots/org/springdoc/](https://nexus.springdoc.org/content/repositories/snapshots/org/springdoc/)
   .
 
 # Acknowledgements
 
 ## Contributors
 
 springdoc-openapi is relevant and updated regularly due to the valuable contributions from
-its [contributors](https://github.com/springdoc/springdoc-openapi/graphs/contributors).
+its [contributors](https://github.com/springdoc/springdoc-openapi-v1/graphs/contributors).
 
-<a href="https://github.com/springdoc/springdoc-openapi/graphs/contributors">
+<a href="https://github.com/springdoc/springdoc-openapi-v1/graphs/contributors">
   <img src="https://contrib.rocks/image?repo=springdoc/springdoc-openapi" width="50%"/>
 </a>
 

diff --git a/pom.xml b/pom.xml
@@ -2,7 +2,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>org.springdoc</groupId>
 	<artifactId>springdoc-openapi</artifactId>
-	<version>1.7.0</version>
+	<version>1.8.0</version>
 	<packaging>pom</packaging>
 	<name>Spring openapi documentation</name>
 	<description>Spring openapi documentation</description>
@@ -11,7 +11,7 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>2.7.10</version>
+		<version>2.7.18</version>
 	</parent>
 
 	<licenses>
@@ -26,8 +26,7 @@
 			<name>Badr NASS LAHSEN</name>
 			<email>[email protected]</email>
 			<organization>springdoc</organization>
-			<organizationUrl>https://springdoc.github.io/springdoc-openapi/
-			</organizationUrl>
+			<organizationUrl>https://springdoc.org/</organizationUrl>
 		</developer>
 	</developers>
 
@@ -36,7 +35,7 @@
 		<connection>scm:git:[email protected]:springdoc/springdoc-openapi.git</connection>
 		<developerConnection>scm:git:[email protected]:springdoc/springdoc-openapi.git
 		</developerConnection>
-		<tag>v1.7.0</tag>
+		<tag>v1.8.0</tag>
 	</scm>
 	<distributionManagement>
 		<snapshotRepository>
@@ -67,8 +66,8 @@
 		<maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
 		<maven-release-plugin.version>2.5.3</maven-release-plugin.version>
 		<nexus-staging-maven-plugin>1.6.8</nexus-staging-maven-plugin>
-		<swagger-api.version>2.2.9</swagger-api.version>
-		<swagger-ui.version>4.18.2</swagger-ui.version>
+		<swagger-api.version>2.2.20</swagger-api.version>
+		<swagger-ui.version>5.11.8</swagger-ui.version>
 		<spring-security-oauth2.version>2.5.2.RELEASE</spring-security-oauth2.version>
 		<gmavenplus-plugin.version>1.8.1</gmavenplus-plugin.version>
 		<jaxb-impl.version>2.1</jaxb-impl.version>
@@ -78,6 +77,7 @@
 		<spring-cloud-function.version>3.2.4</spring-cloud-function.version>
 		<dependency-check.version>8.2.1</dependency-check.version>
 		<spring-security-oauth2-authorization-server.version>0.4.1</spring-security-oauth2-authorization-server.version>
+		<tomcat.embed.version>9.0.86</tomcat.embed.version>
 	</properties>
 
 	<dependencyManagement>
@@ -193,6 +193,11 @@
 				<artifactId>springdoc-openapi-javadoc</artifactId>
 				<version>${project.version}</version>
 			</dependency>
+			<dependency>
+				<groupId>org.apache.tomcat.embed</groupId>
+				<artifactId>tomcat-embed-core</artifactId>
+				<version>${tomcat.embed.version}</version>
+			</dependency>
 		</dependencies>
 	</dependencyManagement>
 	<dependencies>
@@ -384,4 +389,4 @@
 			</snapshots>
 		</pluginRepository>
 	</pluginRepositories>
-</project>
+</project>
diff --git a/springdoc-openapi-common/pom.xml b/springdoc-openapi-common/pom.xml
@@ -3,7 +3,7 @@
 	<parent>
 		<groupId>org.springdoc</groupId>
 		<artifactId>springdoc-openapi</artifactId>
-		<version>1.7.0</version>
+		<version>1.8.0</version>
 	</parent>
 	<artifactId>springdoc-openapi-common</artifactId>
 	<dependencies>