What's Changed

• Align Swagger-UI Prefix Path with Swagger-WebMvc Behavior by @abdelmoez-guetat in #2862
• Improve performance of getGenericMapResponse by @ML-Marco in #2873
• Provide option to set allowed locales #2836 by @martin-tarjanyi in #2875

Added

• #2873 - Improve performance of getGenericMapResponse
• #2836 - Provide option to set allowed locales
• #2862 - Align Swagger-UI Prefix Path with Swagger-WebMvc Behavior. This ER, removes SpringDocUIConfiguration

Changed

• Upgrade spring-boot to 3.4.2
• Upgrade spring-cloud-function to 4.2.1
• Upgrade swagger-core to 2.2.28

Fixed

• #2870 - Springdoc 2.8.x + Spring Boot 3.4.1 breaks native image support
• #2869 - Exception logged when generating schema for delete method of Spring Data repository.
• #2856 - @JsonUnwrapped is ignored in new version of lib.
• #2852 - @Schema(types = "xxx") does not work for multipart param with enabled springdoc.default-support-form-data config option.

New Contributors

• @abdelmoez-guetat made their first contribution in #2862
• @ML-Marco made their first contribution in #2873
• @martin-tarjanyi made their first contribution in #2875

Full Changelog: v2.8.3...v2.8.4

Contributors

• @abdelmoez-guetat
• @martin-tarjanyi
• @Schema
• @ML-Marco

Added

• #2851 - Refine condition, for ignoring types when using PolymorphicModelConverter

Full Changelog: v2.8.2...v2.8.3

Added

• #2849 - Provide better compatibility for projects migrating from OAS 3.0 to OAS 3.1

Fixed

• #2846 - ClassCastException with spring-data-rest and openapi version 3.1 bug
• #2844 - PageableObject and SortObject are called Pageablenull and Sortnull

Full Changelog: v2.8.1...v2.8.2

Full Changelog: v2.8.0...v2.8.1

Fixed

• #2834 - java.lang.ClassNotFoundException: kotlin.reflect.full.KClasses when upgrade from 2.7.0 to 2.8.0

What's Changed

• Upgrade spring-cloud-function from 4.2.0-M1 to 4.2.0 by @aheritier in #2805
• Obey annotations when flattening ParameterObject fields. Fixes #2787 by @mc1arke in #2788
• Upgrade Swagger to 2.2.27 by @jochenberger in #2810

Added

• #2790 - Moving to OpenAPI 3.1 as the default implementation for springdoc-openapi
• #2817 - Obey annotations when flattening ParameterObject fields
• #2826 - Make it possible to mark parameters with @RequestParam annotation to be sent in form instead of query.
• #2822 - Support returning null in ParameterCustomizer
• #2830 - Add support for deprecated fields.
• #2780 - Add Security Schema by AutoConfigure

Changed

• Upgrade spring-boot to 3.4.1
• Upgrade spring-cloud-function to 4.2.0
• Upgrade swagger-core to 2.2.27

Fixed

• #2804 - Stable release 2.7.0 depends on Spring Cloud Milestone 4.2.0-M1
• #2828 - Required a bean of type 'org.springframework.data.rest.webmvc.mapping.Associations' that could not be found.
• #2823 - Capturing pattern in identical paths only renders the path element of one method
• #2817 - Automatically add required if a field is @NotNull or @notblank.
• #2814 - An unresolvable circular reference with management.endpoint.gateway.enabled=true.
• #2798 - Object schema generated for Unit Kotlin type.
• #2797 - Removing operationId via customizer does not work anymore.
• #2833 - Resolve infinite recursion and add example test with OpenAPI v3.1
• #2827 - Ignoring @parameter(required = false)

New Contributors

• @aheritier made their first contribution in #2805
• @jochenberger made their first contribution in #2810

Full Changelog: v2.7.0...v2.8.0

Contributors

• @aheritier
• @parameter
• @jochenberger
• @notblank
• @NotNull
• @mc1arke
• @RequestParam

What's Changed

• Add Encoding to multiple files and JSON payloads request test case. Fixes #2649 by @buzzerrookie in #2650
• Trim indent apply schema description by @e-build in #2653
• fix: typo in SpringSecurityLoginEndpointCustomizer method name by @YunByungil in #2659
• fix: Update Response Code by @YunByungil in #2660
• Refactor Replace hardcoded schema prefix length by @zinzoddari in #2664
• Replace swagger urls in org.springdoc.core.properties.AbstractSwaggerUiConfigProperties#urls only if url is changed. Test to check if the issue is fixed. Fixes #2509. by @dgswan in #2668
• Fix SpringDocApp193Test for Java 21 and above. Fixes #2442. by @dgswan in #2669
• Ensure default media type order is preserved using LinkedHashSet in mergeArrays. Fixes #2671 by @limehee in #2672
• fix: Missing descriptions on Kotlin ByteArray fields by @GeorgEchterling in #2711
• Display nullable request body with map type by @granddaifuku in #2727
• fix for issue #2733 by @kamilkrzywanski in #2734
• issue #2733 second change for only check response entity type by @kamilkrzywanski in #2736
• Readme.md add gradle import by @divinenickname in #2746
• Added support for RequestBody as a meta-annotation by @edudar in #2760
• Add SortAsQueryParam annotation by @ondrejkrpec in #2777

Added

• #2777 - Add SortAsQueryParam annotation
• #2649 - Add Encoding to multiple files and JSON payloads request test case
• #2653 - Trim indent apply schema description
• #2664 - Refactor Replace hardcoded schema prefix length
• #2509, #2668 - Replace swagger urls in org.springdoc.core.properties.AbstractSwaggerUiConfigProperties#urls only if url is changed
• #2727 - Display nullable request body with map type
• #2746 - Readme.md add gradle import
• #2760 - Added support for RequestBody as a meta-annotation
• #2703 - Display nullable request body with map type
• #2657 - Add support for OAS v3.1 webhooks

Changed

• Upgrade spring-boot to 3.4.0
• Upgrade swagger-ui to 5.18.2
• Upgrade spring-security-oauth2-authorization-server to 1.4.0
• Upgrade swagger-core to 2.2.25
• Upgrade spring-cloud-function to 4.2.0-M1

Fixed

• #2752 - Swagger doesn't work after custom annotation replacing request parameters
• #2747 - Move to webjars-locator-lite, in preparation for spring-boot 3.4 GA
• #2705 - @Schema oneOf config is ignored when generate the api-docs
• #2744 - SpringDocUI doest add Javadoc into swagger from abstract class
• #2708 - Spring Boot (Webflux) - Swagger UI - redirect URI does not include Gateway Prefix
• #2725 - Serialization to openapi of org.springframework.data.domain.Sort is wrong for Spring Boot >2.x
• #2740 - Swagger-ui ignores property springdoc.swagger-ui.supported-submit-methods
• #2733 - Bad schema return type when created a generic wrapper class for response entity
• #2687 - Failed to load api definition after spring boot 3.4.0-M2
• #2642 - Calling Swagger UI via different context paths fails
• #2709 - Annotation @hidden on rest controller class level doesn't work due to spring default proxying mechanism CGLIB
• #2642 - Calling Swagger UI via different context paths fails
• #2663 - Content definition in @apiresponse remove schema generated based on the returned value
• #2646 - The operationId is unnecessarily deduplicated for a requestBody with multiple content types
• #2643 - UpperSnakeCaseStrategy is not working with spring boot and ParameterObject
• #2640 - @JsonUnwrapped is ignored when PolymorphicConverter is enabled
• #2638 - Boolean Parameter with @Schema Annotation Changes Type to string in OpenAPI Documentation
• #2659 - Fix typo in SpringSecurityLoginEndpointCustomizer method name
• #2660 - Update Response Code
• #2442, #2669 - Fix SpringDocApp193Test for Java 21 and above
• #2671 - Ensure default media type order is preserved using LinkedHashSet in mergeArrays
• #2711 - Missing descriptions on Kotlin ByteArray fields
• #2733 - Bad schema return type when created a generic wrapper class for response entity

New Contributors

• @buzzerrookie made their first contribution in #2650
• @YunByungil made their first contribution in #2659
• @dgswan made their first contribution in #2668
• @limehee made their first contribution in #2672
• @GeorgEchterling made their first contribution in #2711
• @granddaifuku made their first contribution in #2727
• @kamilkrzywanski made their first contribution in #2734
• @divinenickname made their first contribution in #2746
• @edudar made their first contribution in #2760
• @ondrejkrpec made their first contribution in #2777

Full Changelog: v2.6.0...v2.7.0

Contributors

• @hidden
• @edudar
• @dgswan
• @divinenickname
• @buzzerrookie
• @ondrejkrpec
• @Schema
• @zinzoddari
• @granddaifuku
• @GeorgEchterling
• @kamilkrzywanski
• @e-build
• @limehee
• @YunByungil

What's Changed

• Add Encoding to multiple files and JSON payloads request test case. Fixes #2649 by @buzzerrookie in #2650
• Trim indent apply schema description by @e-build in #2653
• fix: typo in SpringSecurityLoginEndpointCustomizer method name by @YunByungil in #2659
• fix: Update Response Code by @YunByungil in #2660
• Refactor Replace hardcoded schema prefix length by @zinzoddari in #2664
• Replace swagger urls in org.springdoc.core.properties.AbstractSwaggerUiConfigProperties#urls only if url is changed. Test to check if the issue is fixed. Fixes #2509. by @dgswan in #2668
• Fix SpringDocApp193Test for Java 21 and above. Fixes #2442. by @dgswan in #2669
• Ensure default media type order is preserved using LinkedHashSet in mergeArrays. Fixes #2671 by @limehee in #2672
• fix: Missing descriptions on Kotlin ByteArray fields by @GeorgEchterling in #2711
• Display nullable request body with map type by @granddaifuku in #2727
• fix for issue #2733 by @kamilkrzywanski in #2734
• issue #2733 second change for only check response entity type by @kamilkrzywanski in #2736
• Readme.md add gradle import by @divinenickname in #2746
• Added support for RequestBody as a meta-annotation by @edudar in #2760

Added

• #2649 - Add Encoding to multiple files and JSON payloads request test case
• #2653 - Trim indent apply schema description
• #2664 - Refactor Replace hardcoded schema prefix length
• #2509, #2668 - Replace swagger urls in org.springdoc.core.properties.AbstractSwaggerUiConfigProperties#urls only if url is changed
• #2727 - Display nullable request body with map type
• #2746 - Readme.md add gradle import
• #2760 - Added support for RequestBody as a meta-annotation
• #2703 - Display nullable request body with map type
• #2657 - Add support for OAS v3.1 webhooks

Changed

• Upgrade spring-boot to 3.4.0-RC1
• Upgrade swagger-core to 2.2.25
• Upgrade swagger-ui to 5.18.1
• Upgrade spring-cloud-function to 4.2.0-M1
• Upgrade spring-security-oauth2-authorization-server to 1.4.0-M2

Fixed

• #2752 - Swagger doesn't work after custom annotation replacing request parameters
• #2747 - Move to webjars-locator-lite, in preparation for spring-boot 3.4 GA
• #2705 - @Schema oneOf config is ignored when generate the api-docs
• #2744 - SpringDocUI doest add Javadoc into swagger from abstract class
• #2708 - Spring Boot (Webflux) - Swagger UI - redirect URI does not include Gateway Prefix
• #2725 - Serialization to openapi of org.springframework.data.domain.Sort is wrong for Spring Boot >2.x
• #2740 - Swagger-ui ignores property springdoc.swagger-ui.supported-submit-methods
• #2733 - Bad schema return type when created a generic wrapper class for response entity
• #2687 - Failed to load api definition after spring boot 3.4.0-M2
• #2642 - Calling Swagger UI via different context paths fails
• #2709 - Annotation @hidden on rest controller class level doesn't work due to spring default proxying mechanism CGLIB
• #2642 - Calling Swagger UI via different context paths fails
• #2663 - Content definition in @apiresponse remove schema generated based on the returned value
• #2646 - The operationId is unnecessarily deduplicated for a requestBody with multiple content types
• #2643 - UpperSnakeCaseStrategy is not working with spring boot and ParameterObject
• #2640 - @JsonUnwrapped is ignored when PolymorphicConverter is enabled
• #2638 - Boolean Parameter with @Schema Annotation Changes Type to string in OpenAPI Documentation
• #2659 - Fix typo in SpringSecurityLoginEndpointCustomizer method name
• #2660 - Update Response Code
• #2442, #2669 - Fix SpringDocApp193Test for Java 21 and above
• #2671 - Ensure default media type order is preserved using LinkedHashSet in mergeArrays
• #2711 - Missing descriptions on Kotlin ByteArray fields
• #2733 - Bad schema return type when created a generic wrapper class for response entity

New Contributors

• @buzzerrookie made their first contribution in #2650
• @YunByungil made their first contribution in #2659
• @dgswan made their first contribution in #2668
• @limehee made their first contribution in #2672
• @GeorgEchterling made their first contribution in #2711
• @granddaifuku made their first contribution in #2727
• @kamilkrzywanski made their first contribution in #2734
• @divinenickname made their first contribution in #2746
• @edudar made their first contribution in #2760

Full Changelog: v2.6.0...v2.7.0-RC1

Contributors

• @hidden
• @edudar
• @dgswan
• @divinenickname
• @buzzerrookie
• @Schema
• @zinzoddari
• @granddaifuku
• @GeorgEchterling
• @kamilkrzywanski
• @e-build
• @limehee
• @YunByungil

What's Changed

• NPE occurs when outputting an OpenAPI document since 2.5.0 by @footaku in #2561
• Fix missing exception response types in OpenAPI spec by @mschout in #2577
• fix: add support for leading tab characters with trim-kotlin-indent. by @testersen in #2579
• pass HttpRequest to ServerBaseUrlCustomizer by @mshima in #2589
• Fix consumes and produces calculation. Fixes #2596 by @jakvbs in #2600
• Replace Page schema with PagedModel when pageSerializationMode is set to VIA_DTO by @EvaristeGalois11 in #2626
• Ensure compatibility with previous version of spring data by @EvaristeGalois11 in #2627

New Contributors

• @footaku made their first contribution in #2561
• @mschout made their first contribution in #2577
• @testersen made their first contribution in #2579
• @jakvbs made their first contribution in #2600
• @EvaristeGalois11 made their first contribution in #2626

Added

• #2561 - NPE occurs when outputting an OpenAPI document since 2.5.0
• #2579 - Add support for leading tab characters with trim-kotlin-indent.
• #2589 - Pass HttpRequest to ServerBaseUrlCustomizer
• #2596, #2600 - consumes and produces calculation. Fixes
• #2625, #2626 - Replace Page schema with PagedModel when pageSerializationMode is set to VIA_DTO
• #2627 - Ensure compatibility with previous version of spring data
• #2576 - GroupedApi orders by displayName instead of name.
• #2584 - Dynamically define ApiGroups does not work.
• #2595 - Spring security support of @RegisteredOAuth2AuthorizedClient

Changed

• Upgrade spring-boot to 3.3.0
• Upgrade swagger-core to 2.2.22
• Upgrade swagger-ui to 5.17.14
• Upgrade spring-cloud-function to 4.1.2
• Upgrade spring-security-oauth2-authorization-server to 1.3.0

Fixed

• #2577 - Fix missing exception response types in OpenAPI spec
• #2591 - When an entity class contains fields of Class<?> type, an infinite loop.
• #2603 - PolymorphicModelConverter only handles direct subtypes and misses indirect.
• #2606 - Spring Authorization Server Metadata Endpoint not compatible.
• #2621 - Content-type for POST endpoints with multipart/form-data does not work since v2.4.0.
• #2622 - Kotlin enums are always marked as required if used in Java controllers.
• #2601 - Multiple Superclasses Are Not Mapped To Multiple allOf If Used In Different Services.
• #2597 - Polymorphic fields on polymorphic parents don't get correct oneOf docs generated.

Full Changelog: v2.5.0...v2.6.0

Contributors

• @mschout
• @mshima
• @footaku
• @EvaristeGalois11
• @jakvbs
• @jamesbradlee

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
• @codespearhead
• @e-build
• @EAlf91

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
• @BokoEnos
• @SimonCardaire
• @tkachenkoas
• @lbruun
• @zinzoddari
• @cnhnwt
• @danrose499
• @operation
• @sunshiningsoo
• @viktor-berglund-mw