Releases: springdoc/springdoc-openapi
Releases · springdoc/springdoc-openapi
springdoc-openapi v2.5.0 released!
What's Changed
- Fix typo in SpringRepositoryRestResourceProvider.java by @codespearhead in #2540
- Add 'springdoc.trim-kotlin-indent' property to handle Kotlin multiline string indentation by @e-build in #2535
- Fix README.md by @zinzoddari in #2549
- [issues#2318]Add Info to GroupedOpenAPI properties by @23557544 in #2551
- Showcase Issue #2553 by @EAlf91 in #2552
- Remove duplicate words from comments by @zinzoddari in #2554
- Upgrade spring-boot to 3.2.4
- Upgrade swagger-core to 2.2.21
- Upgrade swagger-ui to 5.13.0
Added
- #2318 - Add Info to GroupedOpenAPI properties
- #2554 - Remove duplicate words from comments
- #2418 - Improve support for externalizing strings in generated openapi
- #2535 - Add 'springdoc.trim-kotlin-indent' property to handle Kotlin multiline string indentation
Fixed
- #2525 - Inherited Methods Not Included in Swagger Documentation with @RouterOperation in Spring Boot WebFlux Application
- #2526 - SpringDoc bean naming conflict error with GraphQL Spring boot starter
- #2540 - Fix typo in SpringRepositoryRestResourceProvider.java
- #2549 - Fix README.md
New Contributors
- @codespearhead made their first contribution in #2540
- @e-build made their first contribution in #2535
- @23557544 made their first contribution in #2551
- @EAlf91 made their first contribution in #2552
Full Changelog: v2.4.0...v2.5.0
Contributors
23557544, zinzoddari, and 3 other contributors
Assets 2
springdoc-openapi v2.4.0 released!
What's Changed
- Respect schema annotations when using spring mvc with kotlin by @viktor-berglund-mw in #2443
- Fix CODE_OF_CONDUCT.md links by @danrose499 in #2453
- Fix typo by @zinzoddari in #2454
- Update Swagger Core API version to 2.2.20 by @lbruun in #2463
- Update JavadocPropertyCustomizer.java by @cnhnwt in #2472
- Support dynamic evaluation of description field in the RequestBody by @BokoEnos in #2492
- Fix broken links in README and CONTRIBUTING by @garrettgrimsley in #2495
- bug fix when "exported" is set to false in RestResource annotation by @SimonCardaire in #2501
- Fix typo in Constants by @sunshiningsoo in #2507
- Add support for externalizing strings in generated openapi schema via… by @tkachenkoas in #2418
Changed
- Upgrade spring-boot to 3.2.3
- Upgrade swagger-core to 2.2.20
- Upgrade swagger-ui to 5.11.8
Fixed
- #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
- #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
New Contributors
- @zinzoddari made their first contribution in #2454
- @lbruun made their first contribution in #2463
- @cnhnwt made their first contribution in #2472
- @BokoEnos made their first contribution in #2492
- @garrettgrimsley made their first contribution in #2495
- @SimonCardaire made their first contribution in #2501
- @sunshiningsoo made their first contribution in #2507
- @tkachenkoas made their first contribution in #2418
Full Changelog: v2.3.0...v2.4.0
Contributors
notblank, garrettgrimsley, and 10 other contributors
Assets 2
springdoc-openapi v1.8.0 released!
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.18
- 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
Contributors
notblank, operation, and JsonProperty
Assets 2
springdoc-openapi v2.3.0 released!
What's Changed
- feat: support OIDC by @uc4w6c in #2340
- Support Schema added in OpenAPI Specification v3.1 by @uc4w6c in #2345
- Add more test for OpenAPI Specification v3.1 by @xiaoxiangmoe in #2353
- Fix the failed test due to hardcoded file separators by @wnineg in #2366
- No empty description for polymorphic subtypes by @westse in #2371
- Support get javadoc description from getter method by @eshizhan in #2387
- Fix arrayschema by @uc4w6c in #2403
- Update condition to register links schema customizer, fixes #2359 by @mathieu-amblard in #2404
- Bump swagger-core to version 2.2.19. Fixes #2360 by @viktor-berglund-mw in #2437
- #2359 - Update condition to register links schema customizer
- #2348 - Enhance resource path processing
- #2438, #2315 - Support for @JsonProperty with Javadoc Change in springdoc-openapi
- Upgrade spring-boot to 3.2.0
- Upgrade swagger-core to 2.2.19
- Upgrade swagger-ui to 5.10.3
Fixed
- #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.
New Contributors
- @xiaoxiangmoe made their first contribution in #2353
- @wnineg made their first contribution in #2366
- @eshizhan made their first contribution in #2387
- @mathieu-amblard made their first contribution in #2404
- @viktor-berglund-mw made their first contribution in #2437
Full Changelog: v2.2.0...v2.3.0
Contributors
eshizhan, xiaoxiangmoe, and 5 other contributors
Assets 2
springdoc-openapi v2.2.0 released!
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
Changed
- Upgrade spring-boot to 3.1.2
- Upgrade swagger-core to 2.2.15
- Upgrade swagger-ui to 5.2.0
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
- #2312 - Spec for @ParameterObject disappears if building native-images
- #2326 - @QuerydslPredicate(root = X.class) annotation at Controller Method level not getting documented in Spring Boot 3
New Contributors
- @smou made their first contribution in #2189
- @kauegatto made their first contribution in #2296
Full Changelog: v2.1.0...v2.2.0
Contributors
smou and kauegatto
Assets 2
springdoc-openapi v2.1.0 released!
What's Changed
- Add request parameter for token endpointg by @uc4w6c in #2168
- Fixed DefaultFlatParamObject to work with annotated parameters. Fixes… by @uc4w6c in #2184
Added
- #2152 - Detect directions in default sort values
- #2167 #2166 - Add request parameter for token endpoint
- #2188 - Support of {*param} path patterns
Changed
- Upgrade spring-boot to 3.0.5
- Upgrade swagger-core to 2.2.9
- Upgrade swagger-ui to 4.18.2
- #2173 - Remove webjars-locator-core
Fixed
- #2122 - Super tiny fix typo
- #2131 - Fixed a bug that javadoc of record class parameters was not recognized.
- #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.
- #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
- #2165 - Custom Converters are not excluded if not registered for Http Message Converter.
- #2185 - Fix behaviour of required flag for schema class fields.
- #2139 - SpringDocSecurityConfiguration class not sufficiently constrained.
- #2142 - SpringDocJacksonModuleConfiguration is loaded even though there is no ObjectMapperProvider when springdoc.api-docs.enabled = false.
Full Changelog: v2.0.4...v2.1.0
Contributors
uc4w6c
Assets 2
springdoc-openapi v1.7.0 released!
What's Changed
- Super tiny fix typo by @fzyzcjy in #2121
- Fixed a bug that javadoc of record class parameters was not recognize… by @uc4w6c in #2140
- Fix spring authorization server response. Fixes #2123 by @uc4w6c in #2141
- bug: Fix properties
show-oauth2-endpointsandSpringDocConfigProperties#showOauth2Endpointproperties name mismatch by @Hccake in #2148 - Add failing test with multiple locales and customizing servers by @harsel in #2156
- Request parameters with default values are marked as required. Fixes #2149 by @tobiberger in #2158
- [#2152] Detect directions in default sort values by @onacit in #2159
- Add request parameter for token endpoint by @uc4w6c in #2167
- Fixed DefaultFlatParamObject to work with annotated parameters. Fixes… by @uc4w6c in #2183
Added
- #2152 - Detect directions in default sort values
- #2167 #2166 - Add request parameter for token endpoint
- #2188 - Support of {*param} path patterns
Changed
- Upgrade spring-boot to 2.7.10
- 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
Fixed
- #2122 - Super tiny fix typo
- #2131 - Fixed a bug that javadoc of record class parameters was not recognized.
- #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.
- #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
- #2165 - Custom Converters are not excluded if not registered for Http Message Converter.
- #2185 - Fix behaviour of required flag for schema class fields.
New Contributors
- @harsel made their first contribution in #2156
- @tobiberger made their first contribution in #2158
- @onacit made their first contribution in #2159
Full Changelog: v1.6.15...v1.7.0
Contributors
onacit, fzyzcjy, and 4 other contributors
Assets 2
springdoc-openapi v2.0.4 released!
What's Changed
- Super tiny fix typo (in v2 branch as requested) by @fzyzcjy in #2122
- fix spring authorization server response. Fixes #2123 by @uc4w6c in #2124
- Fixed a bug that javadoc of record class parameters was not recognize… by @uc4w6c in #2136
Changed
- Upgrade swagger-ui to 4.18.1
Fixed
- #2123 - Fix spring authorization server response
- #2131 - Fixed a bug that javadoc of record class parameters was not recognized.
- #2114 - Exception during WebFlux tests: NoClassDefFoundError: KotlinModule$Builder
Full Changelog: v2.0.3...v2.0.4
Contributors
fzyzcjy and uc4w6c
Assets 2
springdoc-openapi v2.0.3 released!
What's Changed
- When getting ExceptionHandler in the controller, use target class in … by @uc4w6c in #2100
- Fixed a bug that a NullPointerException is thrown when the descriptio… by @uc4w6c in #2110
Added
- #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.
Changed
- Upgrade spring-boot to 3.0.4
- Upgrade swagger-core to 2.2.8
- Upgrade swagger-ui to 4.17.1
Fixed
- #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.
- #2051 - Malformed api-docs JSON when StringHttpMessageConverter is not active
- #2062 - OperationCustomizer is not working with Spring Data REST.
- #2098 - When getting ExceptionHandler in the controller, use target class in case of AOP Proxy.
- #2107 - Ordering of GlobalOpenApiCustomizers different than for OpenApiCustomisers.
- #2089 - Fixed a bug that a NullPointerException is thrown when the description field of RequestBody is null and there is a javadoc description.
- #2104 - OpenAPI Extensions no longer work.
Full Changelog: v2.0.2...v2.0.3
Contributors
parameter and uc4w6c
Assets 2
springdoc-openapi v1.6.15 released!
What's Changed
- Fix IntelliJ instructions by @westse in #2052
- Issue #2054: Add copyright and license information to Jar. by @tobi5775 in #2055
- When getting ExceptionHandler in the controller, use target class in … by @uc4w6c in #2099
- Fixed a bug that a NullPointerException is thrown when the descriptio… by @uc4w6c in #2111
Added
- #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.
Changed
- Upgrade spring-boot to 2.7.9
- Upgrade swagger-core to 2.2.8
- Upgrade swagger-ui to 4.17.1
Fixed
- #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.
- #2051 - Malformed api-docs JSON when StringHttpMessageConverter is not active
- #2062 - OperationCustomizer is not working with Spring Data REST.
- #2098 - When getting ExceptionHandler in the controller, use target class in case of AOP Proxy.
- #2107 - Ordering of GlobalOpenApiCustomizers different than for OpenApiCustomisers.
- #2089 - Fixed a bug that a NullPointerException is thrown when the description field of RequestBody is null and there is a javadoc description.
- #2104 - OpenAPI Extensions no longer work.
New Contributors
Full Changelog: v1.6.14...v1.6.15
Contributors
parameter, westse, and 2 other contributors