Skip to content

Releases: springdoc/springdoc-openapi

springdoc-openapi v2.3.0 released!

03 Dec 00:25
Compare
Choose a tag to compare

What's Changed

  • #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

Full Changelog: v2.2.0...v2.3.0

springdoc-openapi v2.2.0 released!

06 Aug 21:23
Compare
Choose a tag to compare

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

Full Changelog: v2.1.0...v2.2.0

springdoc-openapi v2.1.0 released!

01 Apr 22:38
Compare
Choose a tag to compare

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

springdoc-openapi v1.7.0 released!

01 Apr 22:37
Compare
Choose a tag to compare

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-endpoints and SpringDocConfigProperties#showOauth2Endpoint properties 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

Full Changelog: v1.6.15...v1.7.0

springdoc-openapi v2.0.4 released!

14 Mar 23:49
Compare
Choose a tag to compare

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

springdoc-openapi v2.0.3 released!

09 Mar 22:20
Compare
Choose a tag to compare

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

springdoc-openapi v1.6.15 released!

09 Mar 22:21
Compare
Choose a tag to compare

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

springdoc-openapi v2.0.2 released!

16 Dec 14:12
Compare
Choose a tag to compare

Fixed

  • #2008 - Error when com.fasterxml.jackson.module.kotlin.KotlinModule is not present in classpath

Full Changelog: v2.0.1...v2.0.2

springdoc-openapi v2.0.1 released!

16 Dec 11:23
Compare
Choose a tag to compare

Added

  • #1965 - Prevents premature initialisation of factory-beans
  • #2003 - Resolve property descriptions for arrays

Fixed

  • #1957 - AdditionalModelsConverter Schema params rewriting
  • #1962 - override-with-generic-response shouldn't shallow copy
  • #1985 - IllegalStateException: Duplicate key when two endpoints at the same URL with same header exist
  • #1992 - Java enumeration and Spring Converter no longer generates enum drop-down
  • #2001 - Enum Collection parameter missing type info in Spring Data Rest search method
  • #1961 - ContinuationObject leaks into schema

New Contributors

Full Changelog: v2.0.0...v2.0.1

springdoc-openapi v1.6.14 released!

16 Dec 11:21
Compare
Choose a tag to compare

Added

  • #1965 - Prevents premature initialisation of factory-beans
  • #2003 - Resolve property descriptions for arrays

Changed

  • Upgrade spring-boot to 2.7.6

Fixed

  • #1957 - AdditionalModelsConverter Schema params rewriting
  • #1962 - override-with-generic-response shouldn't shallow copy
  • #1985 - IllegalStateException: Duplicate key when two endpoints at the same URL with same header exist
  • #1992 - Java enumeration and Spring Converter no longer generates enum drop-down.
  • #2001 - Enum Collection parameter missing type info in Spring Data Rest search method

New Contributors

Full Changelog: v1.6.13...v1.6.14