code review

Author: bnasslahsen

CHANGELOG.md

@@ -5,6 +5,32 @@ 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.7.1] - 2025-01-03
+
+### 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)
+
 ## [2.7.0] - 2024-23-11
 
 ### Added

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
  *  *  *  *
  *  *  *
  *  *
- *
+ *  
  */
 
 package org.springdoc.api;

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/annotations/ParameterObject.java

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/annotations/RouterOperation.java

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/annotations/RouterOperations.java

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/conditions/CacheOrGroupedOpenApiCondition.java

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/conditions/MultipleOpenApiGroupsCondition.java

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/conditions/MultipleOpenApiSupportCondition.java

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/conditions/SpecPropertiesCondition.java

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.
@@ -30,7 +30,6 @@ import io.swagger.v3.oas.annotations.Parameter
 import org.springdoc.core.customizers.KotlinDeprecatedPropertyCustomizer
 import org.springdoc.core.customizers.ParameterCustomizer
 import org.springdoc.core.providers.ObjectMapperProvider
-import org.springdoc.core.service.AbstractRequestService.addRequestWrapperToIgnore
 import org.springdoc.core.utils.Constants
 import org.springdoc.core.utils.SpringDocUtils
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

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

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configurer/SpringdocActuatorBeanFactoryConfigurer.java

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configurer/SpringdocBeanFactoryConfigurer.java

@@ -4,7 +4,7 @@
  *  *  *
  *  *  *  *
  *  *  *  *  *
- *  *  *  *  *  * Copyright 2019-2024 the original author or authors.
+ *  *  *  *  *  * Copyright 2019-2025 the original author or authors.
  *  *  *  *  *  *
  *  *  *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
  *  *  *  *  *  * you may not use this file except in compliance with the License.