CHANGELOG.md

@@ -5,12 +5,34 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.8.6] - 2025-03-23
+
+### 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
+
 ## [2.8.5] - 2025-02-16
 
 ### Added
 - #2696 - Do not require JsonSubType annotation for sealed classes
 - #2898 - add needed runtime reflection hints for native image 
 - #2891 - Refactor trimIndent Method
+- #2931 - OpenAPIService serverBaseUrl is not thread safe
+- #2933 - Wrong schema generation with PagedModel generated VIA_DTO and wrapped in ResponseEntity
 
 ### Changed
 - Upgrade swagger-ui to v5.18.3

README.md

@@ -11,8 +11,7 @@ project is now available for organizations that need support beyond 2023.
 
 For more details, feel free to reach out: [sales@springdoc.org](mailto:sales@springdoc.org)
 
-``springdoc-openapi`` is on [Open Collective](https://opencollective.com/springdoc). If you ❤️ this project consider becoming
-a [sponsor](https://github.com/sponsors/springdoc).
+``springdoc-openapi`` is on [Open Collective](https://opencollective.com/springdoc). If you ❤️ this project consider becoming a [sponsor](https://github.com/sponsors/springdoc).
 
 This project is sponsored by
 
@@ -33,7 +32,7 @@ This project is sponsored by
  <a href="https://www.lvm.de/" target="_blank">
    <img src="https://springdoc.org/img/LVM_Versicherung_2010_logo.svg.png" height="10%" width="25%" />
   </a>
- <a href=""https://gdnext.com/" target="_blank">
+ <a href="https://gdnext.com/" target="_blank">
    <img src="https://springdoc.org/img/gdnext.png" height="10%" width="10%" />
   </a>
 </p>

pom.xml

@@ -2,7 +2,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>org.springdoc</groupId>
 	<artifactId>springdoc-openapi</artifactId>
-	<version>2.8.5</version>
+	<version>2.8.6</version>
 	<packaging>pom</packaging>
 	<name>Spring openapi documentation</name>
 	<description>Spring openapi documentation</description>
@@ -11,7 +11,7 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>3.4.2</version>
+		<version>3.4.4</version>
 	</parent>
 
 	<licenses>
@@ -35,7 +35,7 @@
 		<connection>scm:git:git@github.com:springdoc/springdoc-openapi.git</connection>
 		<developerConnection>scm:git:git@github.com:springdoc/springdoc-openapi.git
 		</developerConnection>
-		<tag>v2.8.5</tag>
+		<tag>v2.8.6</tag>
 	</scm>
 	<distributionManagement>
 		<snapshotRepository>
@@ -60,12 +60,12 @@
 		<maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
 		<maven-release-plugin.version>2.5.3</maven-release-plugin.version>
 		<nexus-staging-maven-plugin>1.6.8</nexus-staging-maven-plugin>
-		<swagger-api.version>2.2.28</swagger-api.version>
-		<swagger-ui.version>5.18.3</swagger-ui.version>
+		<swagger-api.version>2.2.29</swagger-api.version>
+		<swagger-ui.version>5.20.1</swagger-ui.version>
 		<gmavenplus-plugin.version>1.13.1</gmavenplus-plugin.version>
 		<jjwt.version>0.9.1</jjwt.version>
 		<therapi-runtime-javadoc.version>0.15.0</therapi-runtime-javadoc.version>
-		<spring-cloud-function.version>4.2.1</spring-cloud-function.version>
+		<spring-cloud-function.version>4.2.2</spring-cloud-function.version>
 		<spring-security-oauth2-authorization-server.version>1.4.0</spring-security-oauth2-authorization-server.version>
 	</properties>
 

springdoc-openapi-starter-common/pom.xml

@@ -3,7 +3,7 @@
 	<parent>
 		<groupId>org.springdoc</groupId>
 		<artifactId>springdoc-openapi</artifactId>
-		<version>2.8.5</version>
+		<version>2.8.6</version>
 	</parent>
 	<artifactId>springdoc-openapi-starter-common</artifactId>
 	<dependencies>

springdoc-openapi-starter-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -86,6 +86,7 @@
 import org.slf4j.LoggerFactory;
 import org.springdoc.core.annotations.RouterOperations;
 import org.springdoc.core.customizers.DataRestRouterOperationCustomizer;
+import org.springdoc.core.customizers.GlobalOperationComponentsCustomizer;
 import org.springdoc.core.customizers.OpenApiLocaleCustomizer;
 import org.springdoc.core.customizers.OperationCustomizer;
 import org.springdoc.core.customizers.RouterOperationCustomizer;
@@ -255,7 +256,7 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIService
 			}
 			else {
 				for (String locale : springDocConfigProperties.getPreLoadingLocales()) {
-					Executors.newSingleThreadExecutor().execute(() -> this.getOpenApi(Locale.forLanguageTag(locale)));
+					Executors.newSingleThreadExecutor().execute(() -> this.getOpenApi(null, Locale.forLanguageTag(locale)));
 				}
 			}
 		}
@@ -333,7 +334,7 @@ public static void setModelAndViewClass(Class<?> modelAndViewClass) {
 	 * Gets open api.
 	 */
 	private void getOpenApi() {
-		this.getOpenApi(Locale.getDefault());
+		this.getOpenApi(null, Locale.getDefault());
 	}
 
 	/**
@@ -342,7 +343,7 @@ private void getOpenApi() {
 	 * @param locale the locale
 	 * @return the open api
 	 */
-	protected OpenAPI getOpenApi(Locale locale) {
+	protected OpenAPI getOpenApi(String serverBaseUrl, Locale locale) {
 		this.reentrantLock.lock();
 		try {
 			final OpenAPI openAPI;
@@ -383,7 +384,7 @@ protected OpenAPI getOpenApi(Locale locale) {
 					openAPIService.setServersPresent(true);
 				else
 					openAPIService.setServersPresent(false);
-				openAPIService.updateServers(openAPI);
+				openAPIService.updateServers(serverBaseUrl, openAPI);
 
 				if (springDocConfigProperties.isRemoveBrokenReferenceDefinitions())
 					this.removeBrokenReferenceDefinitions(openAPI);
@@ -412,9 +413,8 @@ protected OpenAPI getOpenApi(Locale locale) {
 			else {
 				LOGGER.debug("Fetching openApi document from cache");
 				openAPI = openAPIService.getCachedOpenAPI(finalLocale);
-				openAPIService.updateServers(openAPI);
+				openAPIService.updateServers(serverBaseUrl, openAPI);
 			}
-			openAPIService.updateServers(openAPI);
 			return openAPI;
 		}
 		finally {
@@ -427,7 +427,7 @@ private Locale selectLocale(Locale inputLocale) {
 		if (!CollectionUtils.isEmpty(allowedLocales)) {
 			Locale bestMatchingAllowedLocale = Locale.lookup(
 				Locale.LanguageRange.parse(inputLocale.toLanguageTag()),
-				allowedLocales.stream().map(Locale::forLanguageTag).collect(Collectors.toList())
+				allowedLocales.stream().map(Locale::forLanguageTag).toList()
 			);
 
 			return bestMatchingAllowedLocale == null ? Locale.forLanguageTag(allowedLocales.get(0)) : bestMatchingAllowedLocale;
@@ -649,7 +649,7 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
 			buildCallbacks(openAPI, methodAttributes, operation, apiCallbacks);
 
 			// allow for customisation
-			operation = customizeOperation(operation, handlerMethod);
+			operation = customizeOperation(operation, components, handlerMethod);
 
 			if (StringUtils.contains(operationPath, "*")) {
 				Matcher matcher = pathPattern.matcher(operationPath);
@@ -1011,15 +1011,20 @@ protected Set<RequestMethod> getDefaultAllowedHttpMethods() {
 	 * Customise operation.
 	 *
 	 * @param operation     the operation
+	 * @param components
 	 * @param handlerMethod the handler method
 	 * @return the operation
 	 */
-	protected Operation customizeOperation(Operation operation, HandlerMethod handlerMethod) {
+	protected Operation customizeOperation(Operation operation, Components components, HandlerMethod handlerMethod) {
 		Optional<Set<OperationCustomizer>> optionalOperationCustomizers = springDocCustomizers.getOperationCustomizers();
 		if (optionalOperationCustomizers.isPresent()) {
 			Set<OperationCustomizer> operationCustomizerList = optionalOperationCustomizers.get();
-			for (OperationCustomizer operationCustomizer : operationCustomizerList)
-				operation = operationCustomizer.customize(operation, handlerMethod);
+			for (OperationCustomizer operationCustomizer : operationCustomizerList) {
+				if (operationCustomizer instanceof GlobalOperationComponentsCustomizer globalOperationComponentsCustomizer)
+					operation = globalOperationComponentsCustomizer.customize(operation, components, handlerMethod);
+				else
+					operation = operationCustomizer.customize(operation, handlerMethod);
+			}
 		}
 		return operation;
 	}

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocConfiguration.java

@@ -34,6 +34,7 @@
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
+import java.util.concurrent.Future;
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.querydsl.core.types.Predicate;
@@ -129,6 +130,7 @@
 import static org.springdoc.core.utils.Constants.GLOBAL_OPEN_API_CUSTOMIZER;
 import static org.springdoc.core.utils.Constants.SPRINGDOC_DEPRECATING_CONVERTER_ENABLED;
 import static org.springdoc.core.utils.Constants.SPRINGDOC_ENABLED;
+import static org.springdoc.core.utils.Constants.SPRINGDOC_ENABLE_EXTRA_SCHEMAS;
 import static org.springdoc.core.utils.Constants.SPRINGDOC_POLYMORPHIC_CONVERTER_ENABLED;
 import static org.springdoc.core.utils.Constants.SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES;
 import static org.springdoc.core.utils.Constants.SPRINGDOC_SHOW_ACTUATOR;
@@ -153,9 +155,18 @@ public class SpringDocConfiguration {
 	static {
 		getConfig().replaceWithSchema(ObjectNode.class, new ObjectSchema())
 				.replaceWithClass(Charset.class, String.class)
-				.addResponseWrapperToIgnore(DeferredResult.class);
+				.addResponseWrapperToIgnore(DeferredResult.class) 
+				.addResponseWrapperToIgnore(Future.class);
 	}
 
+	@Bean
+	@Lazy(false)
+	@ConditionalOnProperty(name = SPRINGDOC_ENABLE_EXTRA_SCHEMAS, matchIfMissing = true)
+	Object initExtraSchemas() {
+		getConfig().initExtraSchemas();
+		return null;
+	}
+
 	/**
 	 * Springdoc bean factory post processor bean factory post processor.
 	 *

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocSealedClassModule.java

@@ -26,10 +26,12 @@
 import java.util.Arrays;
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.databind.introspect.Annotated;
 import com.fasterxml.jackson.databind.jsontype.NamedType;
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import io.swagger.v3.core.jackson.SwaggerAnnotationIntrospector;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 /**
  * The type Spring doc sealed class module.
@@ -56,6 +58,18 @@ public List<NamedType> findSubtypes(Annotated annotated) {
 					&& clazz.isSealed()
 					&& !clazz.getPackage().getName().startsWith("java")
 			) {
+
+				Schema schema = clazz.getAnnotation(Schema.class);
+				if (schema != null && schema.oneOf().length > 0) {
+					return new ArrayList<>();
+				}
+
+				JsonSubTypes jsonSubTypes = clazz.getAnnotation(JsonSubTypes.class);
+				if (jsonSubTypes != null && jsonSubTypes.value().length > 0) {
+					return new ArrayList<>();
+				}
+
+
 				Class<?>[] permittedSubClasses = clazz.getPermittedSubclasses();
 				if (permittedSubClasses.length > 0) {
 					Arrays.stream(permittedSubClasses).map(NamedType::new).forEach(subTypes::add);

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/hints/SpringDocHints.java

@@ -196,7 +196,9 @@ public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
 								MemberCategory.INVOKE_DECLARED_METHODS))
 				.registerType(java.lang.ModuleLayer.class, MemberCategory.INVOKE_DECLARED_METHODS)
 				.registerType(java.lang.module.Configuration.class, MemberCategory.INVOKE_DECLARED_METHODS)
-				.registerType(java.lang.module.ResolvedModule.class, MemberCategory.INVOKE_DECLARED_METHODS);
+				.registerType(java.lang.module.ResolvedModule.class, MemberCategory.INVOKE_DECLARED_METHODS)
+				.registerType(java.lang.invoke.MethodHandles.class, MemberCategory.DECLARED_CLASSES)
+				.registerType(java.lang.invoke.MethodHandles.Lookup.class);
 		//swagger-models
 		Arrays.stream(typesToRegister).forEach(aClass ->
 				hints.reflection().registerType(aClass,

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/ModelConverterRegistrar.java

@@ -99,6 +99,6 @@ private boolean isSameConverter(ModelConverter modelConverter1, ModelConverter m
 		// comparing by the converter type
 		Class<? extends ModelConverter> modelConverter1Class = modelConverter1.getClass();
 		Class<? extends ModelConverter> modelConverter2Class = modelConverter2.getClass();
-		return modelConverter1Class.equals(modelConverter2Class);
+		return modelConverter1Class.getName().equals(modelConverter2Class.getName());
 	}
 }

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/converters/PageOpenAPIConverter.java

@@ -26,7 +26,6 @@
 
 package org.springdoc.core.converters;
 
-import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
 import java.util.Iterator;
 
@@ -94,7 +93,7 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
 			Class<?> cls = javaType.getRawClass();
 			if (replacePageWithPagedModel && PAGE_TO_REPLACE.equals(cls.getCanonicalName())) {
 				if (!type.isSchemaProperty())
-					type = resolvePagedModelType(type);
+					type = resolvePagedModelType(javaType);
 				else
 					type.name(getParentTypeName(type, cls));
 			}
@@ -108,13 +107,12 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
 	 * @param type the type
 	 * @return the annotated type
 	 */
-	private AnnotatedType resolvePagedModelType(AnnotatedType type) {
-		Type pageType = type.getType();
-		if (pageType instanceof ParameterizedType) {
-			Type argumentType = ((ParameterizedType) type.getType()).getActualTypeArguments()[0];
+	private AnnotatedType resolvePagedModelType(JavaType type) {
+		if(type.hasGenericTypes()){
+			JavaType innerType = type.containedType(0);
 			Type pagedModelType = ResolvableType
-				.forClassWithGenerics(PagedModel.class, ResolvableType.forType(argumentType))
-				.getType();
+					.forClassWithGenerics(PagedModel.class, ResolvableType.forType(innerType))
+					.getType();
 			return new AnnotatedType(pagedModelType).resolveAsRef(true);
 		}
 		else {