Skip to content

Commit 98dacbd

Browse files
committed
Prepare for the next release
1 parent 5eb7d77 commit 98dacbd

File tree

2 files changed

+58
-36
lines changed

2 files changed

+58
-36
lines changed

CHANGELOG.md

Lines changed: 56 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,33 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [2.8.7] - 2025-05-04
9+
10+
### Added
11+
- #2944 - Introducing springdoc-openapi-bom project
12+
- #2948 - Customize Servers via application.yml
13+
- #2963 - Set default content type for problem details object to application/problem+jso
14+
- #2971 - List of value classes in Kotlin
15+
16+
### Changed
17+
- Upgrade swagger-ui to v5.21.0
18+
- Upgrade swagger-core to 2.2.30
19+
- Upgrade spring-boot to version 3.4.5
20+
- Upgrade spring-security-oauth2-authorization-server to version 1.4.3
21+
22+
### Fixed
23+
- #2947 - Unexpected warning "Appended trailing slash to static resource location"
24+
- #2960 - NPE when customizing group's open-api without specifying any schema
25+
- #2969 - fix path to register resource handler to work SwaggerIndexPageTransformer considering /webjar path prefix
26+
- #2964 - Cannot add custom description and example for java.time.Duration since v2.8.6
27+
- #2972 - @Header(schema = @Schema(type = "string")) generates empty or broken schema in OpenAPI output since 2.8.0
28+
- #2976, #2967 - Build Failure due to Private Inner Class.
29+
830
## [2.8.6] - 2025-03-23
931

1032
### Added
11-
- #2909 - Check both SerDe BeanPropertyDefinition for @JsonUnwrapped/@Schema
12-
- #2927 - Bail sealed class subtype introspection on Schema
33+
- #2909 - Check both SerDe BeanPropertyDefinition for @JsonUnwrapped/@Schema
34+
- #2927 - Bail sealed class subtype introspection on Schema
1335
- #2917 - Add Future to ignored response wrappers
1436
- #2938 - Add out of the box support for LocalTime, YearMonth, MonthDay
1537

@@ -29,7 +51,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2951

3052
### Added
3153
- #2696 - Do not require JsonSubType annotation for sealed classes
32-
- #2898 - add needed runtime reflection hints for native image
54+
- #2898 - add needed runtime reflection hints for native image
3355
- #2891 - Refactor trimIndent Method
3456
- #2931 - OpenAPIService serverBaseUrl is not thread safe
3557
- #2933 - Wrong schema generation with PagedModel generated VIA_DTO and wrapped in ResponseEntity
@@ -49,15 +71,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4971

5072
### Added
5173
- #2873 - Improve performance of getGenericMapResponse
52-
- #2836 - Provide option to set allowed locales
74+
- #2836 - Provide option to set allowed locales
5375
- 2862 - Align Swagger-UI Prefix Path with Swagger-WebMvc Behavior
5476

5577
### Changed
5678
- Upgrade spring-boot to 3.4.2
5779
- Upgrade spring-cloud-function to 4.2.1
5880
- Upgrade swagger-core to 2.2.28
5981

60-
### Fixed
82+
### Fixed
6183
- #2870 - Springdoc 2.8.x + Spring Boot 3.4.1 breaks native image support
6284
- #2869 - Exception logged when generating schema for delete method of Spring Data repository.
6385
- #2856 - @JsonUnwrapped is ignored in new version of lib.
@@ -80,13 +102,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
80102
## [2.8.1] - 2025-01-06
81103

82104
### Fixed
83-
- #2834 - java.lang.ClassNotFoundException: kotlin.reflect.full.KClasses when upgrade from 2.7.0 to 2.8.0
105+
- #2834 - java.lang.ClassNotFoundException: kotlin.reflect.full.KClasses when upgrade from 2.7.0 to 2.8.0
84106

85107
## [2.8.0] - 2025-01-03
86108

87109
### Added
88110
- #2790 - Moving to OpenAPI 3.1 as the default implementation for springdoc-openapi
89-
- #2817 - Obey annotations when flattening ParameterObject fields
111+
- #2817 - Obey annotations when flattening ParameterObject fields
90112
- #2826 - Make it possible to mark parameters with @RequestParam annotation to be sent in form instead of query.
91113
- #2822 - Support returning null in ParameterCustomizer
92114
- #2830 - Add support for deprecated fields.
@@ -112,7 +134,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
112134

113135
### Added
114136
- #2777 - Add SortAsQueryParam annotation
115-
- #2786 - No static resource swagger-ui/index.html error after migration to 2.7.0-RC1
137+
- #2786 - No static resource swagger-ui/index.html error after migration to 2.7.0-RC1
116138

117139
### Changed
118140
- Upgrade spring-boot to 3.4.0
@@ -124,11 +146,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
124146
### Added
125147
- #2649 - Add Encoding to multiple files and JSON payloads request test case
126148
- #2653 - Trim indent apply schema description
127-
- #2664 - Refactor Replace hardcoded schema prefix length
149+
- #2664 - Refactor Replace hardcoded schema prefix length
128150
- #2509, #2668 - Replace swagger urls in org.springdoc.core.properties.AbstractSwaggerUiConfigProperties#urls only if url is changed
129151
- #2727 - Display nullable request body with map type
130152
- #2746 - Readme.md add gradle import
131-
- #2760 - Added support for RequestBody as a meta-annotation
153+
- #2760 - Added support for RequestBody as a meta-annotation
132154
- #2703 - Display nullable request body with map type
133155
- #2657 - Add support for OAS v3.1 webhooks
134156

@@ -143,7 +165,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
143165
- #2752 - Swagger doesn't work after custom annotation replacing request parameters
144166
- #2747 - Move to webjars-locator-lite, in preparation for spring-boot 3.4 GA
145167
- #2705 - @Schema oneOf config is ignored when generate the api-docs
146-
- #2744 - SpringDocUI doest add Javadoc into swagger from abstract class
168+
- #2744 - SpringDocUI doest add Javadoc into swagger from abstract class
147169
- #2708 - Spring Boot (Webflux) - Swagger UI - redirect URI does not include Gateway Prefix
148170
- #2725 - Serialization to openapi of org.springframework.data.domain.Sort is wrong for Spring Boot >2.x
149171
- #2740 - Swagger-ui ignores property springdoc.swagger-ui.supported-submit-methods
@@ -158,23 +180,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
158180
- #2640 - @JsonUnwrapped is ignored when PolymorphicConverter is enabled
159181
- #2638 - Boolean Parameter with @Schema Annotation Changes Type to string in OpenAPI Documentation
160182
- #2659 - Fix typo in SpringSecurityLoginEndpointCustomizer method name
161-
- #2660 - Update Response Code
162-
- #2442, #2669 - Fix SpringDocApp193Test for Java 21 and above
183+
- #2660 - Update Response Code
184+
- #2442, #2669 - Fix SpringDocApp193Test for Java 21 and above
163185
- #2671 - Ensure default media type order is preserved using LinkedHashSet in mergeArrays
164186
- #2711 - Missing descriptions on Kotlin ByteArray fields
165-
- #2733 - Bad schema return type when created a generic wrapper class for response entity
187+
- #2733 - Bad schema return type when created a generic wrapper class for response entity
166188

167189
## [2.6.0] - 2024-06-30
168190

169191
### Added
170192
- #2561 - NPE occurs when outputting an OpenAPI document since 2.5.0
171-
- #2579 - Add support for leading tab characters with trim-kotlin-indent.
172-
- #2589 - Pass HttpRequest to ServerBaseUrlCustomizer
173-
- #2596, #2600 - consumes and produces calculation. Fixes
193+
- #2579 - Add support for leading tab characters with trim-kotlin-indent.
194+
- #2589 - Pass HttpRequest to ServerBaseUrlCustomizer
195+
- #2596, #2600 - consumes and produces calculation. Fixes
174196
- #2625, #2626 - Replace Page schema with PagedModel when pageSerializationMode is set to VIA_DTO
175197
- #2627 - Ensure compatibility with previous version of spring data
176-
- #2576 - GroupedApi orders by displayName instead of name.
177-
- #2584 - Dynamically define ApiGroups does not work.
198+
- #2576 - GroupedApi orders by displayName instead of name.
199+
- #2584 - Dynamically define ApiGroups does not work.
178200
- #2595 - Spring security support of @RegisteredOAuth2AuthorizedClient
179201

180202
### Changed
@@ -187,7 +209,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
187209
### Fixed
188210
- #2577 - Fix missing exception response types in OpenAPI spec
189211
- #2591 - When an entity class contains fields of Class<?> type, an infinite loop.
190-
- #2603 - PolymorphicModelConverter only handles direct subtypes and misses indirect.
212+
- #2603 - PolymorphicModelConverter only handles direct subtypes and misses indirect.
191213
- #2606 - Spring Authorization Server Metadata Endpoint not compatible.
192214
- #2621 - Content-type for POST endpoints with multipart/form-data does not work since v2.4.0.
193215
- #2622 - Kotlin enums are always marked as required if used in Java controllers.
@@ -243,14 +265,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
243265
- #2509 - ArrayIndexOutOfBoundsException in SwaggerUiConfigParameters
244266
- #2484 - JavaDoc integration not working with SnakeCaseStrategy property naming
245267
- #2483 - Controller advice documents ApiResponse on every operation, even if the operation does not annotate the exception to be thrown
246-
- #2477 - buildApiResponses ignores produced ContentType in case of many @Operation
268+
- #2477 - buildApiResponses ignores produced ContentType in case of many @Operation
247269

248270
## [2.3.0] - 2023-12-03
249271

250272
### Added
251273
- #2340 - Add support OIDC with Spring Authorization Server
252-
- #2345 - Support Schema added in OpenAPI Specification v3.1
253-
- #2387 - Support get javadoc description from getter method
274+
- #2345 - Support Schema added in OpenAPI Specification v3.1
275+
- #2387 - Support get javadoc description from getter method
254276
- #2404 - Update condition to register links schema customizer
255277
- #2359 - Update condition to register links schema customizer
256278
- #2348 - Enhance resource path processing
@@ -264,20 +286,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
264286
### Fixed
265287

266288
- #2366 - Fix the failed test due to hardcoded file separators
267-
- #2370, #2371 - No empty description for polymorphic subtypes
268-
- #2373 - SchemaProperty.array Schema is ignored in /api-docs or api-docs.yaml
289+
- #2370, #2371 - No empty description for polymorphic subtypes
290+
- #2373 - SchemaProperty.array Schema is ignored in /api-docs or api-docs.yaml
269291
- #2366 - Refactoring AbstractSwaggerResourceResolver.findWebJarResourcePath
270292
- #2320 - javadoc for class attribute ignored when in EntityModel.
271293
- #2347 - Not working if a property of entity contains generic parameters.
272-
- #2399 - SpringdocRouteBuilder.onError is overriding last route defined.
294+
- #2399 - SpringdocRouteBuilder.onError is overriding last route defined.
273295
- #2426 - StackOverflowError when using @ParameterObject on groovy class.
274296

275297
## [2.2.0] - 2023-08-06
276298

277299
### Added
278-
- #2189 - Add support for swagger-ui.url property
300+
- #2189 - Add support for swagger-ui.url property
279301
- #2200 - Support schema.requiredMode() on ParameterObject
280-
- #2309 - Added function to preload by specifying locale
302+
- #2309 - Added function to preload by specifying locale
281303
- #2332 - Group name cannot be null or empty
282304
- #2281 - Initial Virtual thread support
283305

@@ -289,13 +311,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
289311

290312
### Fixed
291313

292-
- #2199 - Fix Schema get condition of ArraySchema.
293-
- #2194 - Fix Swagger UI with provided spec
294-
- #2213 - Using both generated and configured specs stoped working in 1.6.5
314+
- #2199 - Fix Schema get condition of ArraySchema.
315+
- #2194 - Fix Swagger UI with provided spec
316+
- #2213 - Using both generated and configured specs stoped working in 1.6.5
295317
- #2222 - String Index Out of Bounce Exception Fix when deployed on Azure
296-
- #2243, #2235 - Fix StringIndexOutOfBoundsException when path is same webjar
297-
- #2291 - Fix default-flat-param-object doesn't work when using http body
298-
- #2310 - Change bean name of objectMapperProvider
318+
- #2243, #2235 - Fix StringIndexOutOfBoundsException when path is same webjar
319+
- #2291 - Fix default-flat-param-object doesn't work when using http body
320+
- #2310 - Change bean name of objectMapperProvider
299321
- #2207 - swagger-initializer.js is sent endcoded in the JVM's default charset
300322
- #2271, #2280 - Fix loop when response inherits generic class fixes
301323
- #2312 - Spec for @ParameterObject disappears if building native-images

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,12 +234,12 @@ The artifacts can be viewed accessed at the following locations:
234234

235235
Releases:
236236

237-
* [https://s01.oss.sonatype.org/content/groups/public/org/springdoc/](https://s01.oss.sonatype.org/content/groups/public/org/springdoc/)
237+
* [https://central.sonatype.com/search?q=g:org.springdoc)](https://central.sonatype.com/search?q=g:org.springdoc)
238238
.
239239

240240
Snapshots:
241241

242-
* [https://s01.oss.sonatype.org/content/repositories/snapshots/org/springdoc/](https://s01.oss.sonatype.org/content/repositories/snapshots/org/springdoc/)
242+
* [https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/org/springdoc/](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/org/springdoc/)
243243
.
244244

245245
# Acknowledgements

0 commit comments

Comments
 (0)