Releases: springdoc/springdoc-openapi
Releases · springdoc/springdoc-openapi
v2.8.8
springdoc-openapi v2.8.7 released!
What's Changed
Added
- #2944 - Introducing springdoc-openapi-bom project
- #2948 - Customize Servers via application.yml
- #2963 - Set default content type for problem details object to application/problem+jso
- #2971 - List of value classes in Kotlin
Changed
- Upgrade swagger-ui to v5.21.0
- Upgrade swagger-core to 2.2.30
- Upgrade spring-boot to version 3.4.5
- Upgrade spring-security-oauth2-authorization-server to version 1.4.3
Fixed
- #2947 - Unexpected warning "Appended trailing slash to static resource location"
- #2960 - NPE when customizing group's open-api without specifying any schema
- #2969 - fix path to register resource handler to work SwaggerIndexPageTransformer considering /webjar path prefix
- #2964 - Cannot add custom description and example for java.time.Duration since v2.8.6
- #2972 - @Header(schema = @Schema(type = "string")) generates empty or broken schema in OpenAPI output since 2.8.0
- #2976, #2967 - Build Failure due to Private Inner Class.
- #2556 - Unable to determine if it is a Kotlin type
New Contributors
Full Changelog: v2.8.6...v2.8.7
Contributors
Header, Schema, and 2 other contributors
Assets 2
springdoc-openapi v2.8.6 released!
What's Changed
- Update README.md by @berezkin88 in #2911
- Check both SerDe
BeanPropertyDefinitionfor@JsonUnwrapped/@Schemaby @wingsofovnia in #2909 - Bail sealed class subtype introspection on Schema by @sahil-ramagiri in #2927
- Add missing builder methods in SchemaBuilder by @JohnNiang in #2928
Added
- #2909 - Check both SerDe BeanPropertyDefinition for @JsonUnwrapped/@Schema
- #2927 - Bail sealed class subtype introspection on Schema
- #2917 - Add Future to ignored response wrappers
- #2938 - Add out of the box support for LocalTime, YearMonth, MonthDay
Changed
- Upgrade swagger-ui to v5.20.1
- Upgrade swagger-core to 2.2.29
- Upgrade spring-cloud-function to 4.2.2
- Upgrade spring-boot to version 3.4.4
Fixed
- #2928 - Add missing builder methods in SchemaBuilder
- #2905 - ModelResolver.enumAsRef = true result in invalid openapi with actuator using enum param
- #2939 - Duplicate ModelConverter registration with Spring Boot DevTools
- #2941 - SpringBoot native fails /v3/api-docs when using a Map as an http entity field
New Contributors
- @berezkin88 made their first contribution in #2911
Full Changelog: v2.8.5...v2.8.6
Contributors
wingsofovnia, JohnNiang, and 3 other contributors
Assets 2
springdoc-openapi v2.8.5 released!
What's Changed
- fix defaultValue when using @PageableDefault together with one-indexed-parameters by @pheyken in #2881
- Refactor trimIndent Method by @Ryan-Dia in #2891
- fix: respect
@JsonUnwrapped&@Schemaon props not fields only by @wingsofovnia in #2894 - Only filter out actuator endpoints with double asterisks. Fixes #2895 by @mc1arke in #2896
- add needed runtime reflection hints for native image by @lorenzbaier in #2898
- Do not require JsonSubType annotation for sealed classes by @sahil-ramagiri in #2696
Added
- #2696 - Do not require JsonSubType annotation for sealed classes
- #2898 - add needed runtime reflection hints for native image
- #2891 - Refactor trimIndent Method
Changed
- Upgrade swagger-ui to v5.18.3
Fixed
- #2902 - Schema replaced by String when using @ApiResponse with RepresentationModel (Hateoas links)
- #2876 - Restentpoints with same name get mix up
- #2895 - Only filter out actuator endpoints with double asterisks.
- #2894 - respect @JsonUnwrapped & @Schema on props not fields only
- #2881 - fix defaultValue when using @PageableDefault together with one-indexed-parameters
- #2888 - Provide a better consistency for parameters and responses order.
New Contributors
- @pheyken made their first contribution in #2881
- @Ryan-Dia made their first contribution in #2891
- @wingsofovnia made their first contribution in #2894
- @lorenzbaier made their first contribution in #2898
- @sahil-ramagiri made their first contribution in #2696
Full Changelog: v2.8.4...v2.8.5
Contributors
mc1arke, wingsofovnia, and 5 other contributors
Assets 2
springdoc-openapi v2.8.4 released!
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
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, and 2 other contributors
Assets 2
springdoc-openapi v2.8.3 released!
Added
- #2851 - Refine condition, for ignoring types when using PolymorphicModelConverter
Full Changelog: v2.8.2...v2.8.3
springdoc-openapi v2.8.2 released!
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
springdoc-openapi v2.8.1 released!
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
springdoc-openapi v2.8.0 released!
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, and 5 other contributors
Assets 2
springdoc-openapi v2.7.0 released! Latest
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#urlsonly 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, and 12 other contributors