Moving to OpenAPI 3.1 as the default implementation for springdoc-ope…

…napi. Fixes #2790
springdoc · Jan 2, 2025 · 9d7f6ae · 9d7f6ae
1 parent d003748
commit 9d7f6ae
Show file tree

Hide file tree

Showing 23 changed files with 39 additions and 21 deletions.
diff --git a/...ngdoc-openapi-starter-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java b/...ngdoc-openapi-starter-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java
@@ -510,6 +510,8 @@ private void trimIndentOperation(Operation operation) {
 	 */
 	protected void calculateWebhooks(OpenAPI calculatedOpenAPI, Locale locale) {
 		Webhooks[] webhooksAttr = openAPIService.getWebhooks();
+		if(ArrayUtils.isEmpty(webhooksAttr))
+			return;
 		var webhooks = Arrays.stream(webhooksAttr).map(Webhooks::value).flatMap(Arrays::stream).toArray(Webhook[]::new);
 		Arrays.stream(webhooks).forEach(webhook -> {
 			io.swagger.v3.oas.annotations.Operation apiOperation = webhook.operation();

diff --git a/...starter-common/src/main/java/org/springdoc/core/properties/SpringDocConfigProperties.java b/...starter-common/src/main/java/org/springdoc/core/properties/SpringDocConfigProperties.java
@@ -1304,7 +1304,7 @@ public static class ApiDocs {
 		/**
 		 * The OpenAPI version.
 		 */
-		private OpenApiVersion version;
+		private OpenApiVersion version = OpenApiVersion.OPENAPI_3_1;
 
 		/**
 		 * Gets path.

diff --git a/...-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/AbstractCommonTest.java b/...-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/AbstractCommonTest.java
@@ -11,10 +11,12 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.reactive.server.WebTestClient;
 
 @AutoConfigureWebTestClient(timeout = "3600000")
 @ActiveProfiles("test")
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractCommonTest {
 
 	protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractCommonTest.class);

diff --git a/...oc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/AbstractCommonTest.java b/...oc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/AbstractCommonTest.java
@@ -12,10 +12,12 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.reactive.server.WebTestClient;
 
 @AutoConfigureWebTestClient(timeout = "3600000")
 @ActiveProfiles("test")
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractCommonTest {
 
 	protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractCommonTest.class);

diff --git a/...starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/AbstractSpringDocV30Test.java b/...starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/AbstractSpringDocV30Test.java
@@ -29,6 +29,7 @@
 import test.org.springdoc.api.AbstractCommonTest;
 
 import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.servlet.MvcResult;
 
 import static org.hamcrest.Matchers.is;
@@ -38,6 +39,7 @@
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
 @SpringBootTest
+@TestPropertySource(properties = { "springdoc.api-docs.version=openapi_3_0" })
 public abstract class AbstractSpringDocV30Test extends AbstractCommonTest {
 
 	public static String className;

diff --git a/...arter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app136/SpringDocApp136Test.java b/...arter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app136/SpringDocApp136Test.java
@@ -52,7 +52,7 @@
 /**
  * Tests deterministic creation of operationIds
  */
-@SpringBootTest(properties = { SPRINGDOC_CACHE_DISABLED + "=true" })
+@SpringBootTest(properties = { SPRINGDOC_CACHE_DISABLED + "=true", "springdoc.api-docs.version=openapi_3_0"  })
 public class SpringDocApp136Test extends AbstractCommonTest {
 
 	@Autowired

diff --git a/...arter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app193/SpringDocApp193Test.java b/...arter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app193/SpringDocApp193Test.java
@@ -39,7 +39,7 @@
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
-@SpringBootTest
+@SpringBootTest(properties = { "springdoc.api-docs.version=openapi_3_0" })
 public class SpringDocApp193Test extends AbstractCommonTest {
 
 	@Test

diff --git a/...arter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app209/SpringDocApp209Test.java b/...arter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app209/SpringDocApp209Test.java
@@ -56,7 +56,8 @@
 
 @SpringBootTest(properties = {
 		"springdoc.pre-loading-enabled=true",
-		"springdoc.pre-loading-locales=ja"
+		"springdoc.pre-loading-locales=ja",
+		"springdoc.api-docs.version=openapi_3_0"
 })
 public class SpringDocApp209Test extends AbstractCommonTest {
 	public static String className;

diff --git a/...starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/AbstractSpringDocV31Test.java b/...starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/AbstractSpringDocV31Test.java
@@ -39,7 +39,6 @@
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
 @SpringBootTest
-@TestPropertySource(properties = { "springdoc.api-docs.version=openapi_3_1" })
 public abstract class AbstractSpringDocV31Test extends AbstractCommonTest {
 
 	public static String className;

diff --git a/...doc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/AbstractCommonTest.java b/...doc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/AbstractCommonTest.java
@@ -9,10 +9,12 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.servlet.MockMvc;
 
 @AutoConfigureMockMvc
 @ActiveProfiles("test")
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractCommonTest {
 
 	@Autowired

diff --git a/...enapi-actuator-webflux-tests/src/test/java/test/org/springdoc/api/AbstractCommonTest.java b/...enapi-actuator-webflux-tests/src/test/java/test/org/springdoc/api/AbstractCommonTest.java
@@ -20,7 +20,7 @@
 
 @AutoConfigureWebTestClient(timeout = "3600000")
 @ActiveProfiles("test")
-@TestPropertySource(properties = { "management.endpoints.enabled-by-default=false" })
+@TestPropertySource(properties = { "management.endpoints.enabled-by-default=false" ,  "springdoc.api-docs.version=openapi_3_0" })
 public abstract class AbstractCommonTest {
 
 	protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractCommonTest.class);

diff --git a/...penapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/AbstractCommonTest.java b/...penapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/AbstractCommonTest.java
@@ -13,7 +13,7 @@
 
 @AutoConfigureMockMvc
 @ActiveProfiles("test")
-@TestPropertySource(properties = { "management.endpoints.enabled-by-default=false" })
+@TestPropertySource(properties = { "management.endpoints.enabled-by-default=false" ,  "springdoc.api-docs.version=openapi_3_0" })
 public abstract class AbstractCommonTest {
 
 	@Autowired

diff --git a/...c-openapi-data-rest-tests/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java b/...c-openapi-data-rest-tests/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java
@@ -24,14 +24,13 @@
 import java.nio.file.Paths;
 
 import org.junit.jupiter.api.Test;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springdoc.core.utils.Constants;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MvcResult;
 
@@ -44,10 +43,9 @@
 @ActiveProfiles("test")
 @SpringBootTest
 @AutoConfigureMockMvc
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractSpringDocTest {
 
-	protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractSpringDocTest.class);
-
 	public static String className;
 
 	@Autowired

diff --git a/...enapi-function-webflux-tests/src/test/java/test/org/springdoc/api/AbstractCommonTest.java b/...enapi-function-webflux-tests/src/test/java/test/org/springdoc/api/AbstractCommonTest.java
@@ -11,10 +11,12 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.reactive.server.WebTestClient;
 
 @AutoConfigureWebTestClient(timeout = "3600000")
 @ActiveProfiles("test")
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractCommonTest {
 
 	protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractCommonTest.class);

diff --git a/...penapi-function-webmvc-tests/src/test/java/test/org/springdoc/api/AbstractCommonTest.java b/...penapi-function-webmvc-tests/src/test/java/test/org/springdoc/api/AbstractCommonTest.java
@@ -8,10 +8,12 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.servlet.MockMvc;
 
 @AutoConfigureMockMvc
 @ActiveProfiles("test")
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractCommonTest {
 
 	@Autowired

diff --git a/...oc-openapi-groovy-tests/src/test/groovy/test/org/springdoc/api/AbstractSpringDocTest.java b/...oc-openapi-groovy-tests/src/test/groovy/test/org/springdoc/api/AbstractSpringDocTest.java
@@ -32,6 +32,7 @@
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MvcResult;
 
@@ -44,6 +45,7 @@
 @ActiveProfiles("test")
 @SpringBootTest
 @AutoConfigureMockMvc
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractSpringDocTest {
 
 	protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractSpringDocTest.class);

diff --git a/...doc-openapi-hateoas-tests/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java b/...doc-openapi-hateoas-tests/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java
@@ -36,6 +36,7 @@
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MvcResult;
 
@@ -48,6 +49,7 @@
 @ActiveProfiles("test")
 @SpringBootTest
 @AutoConfigureMockMvc
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractSpringDocTest {
 
 	public static String className;

diff --git a/...doc-openapi-javadoc-tests/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java b/...doc-openapi-javadoc-tests/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java
@@ -32,6 +32,7 @@
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MvcResult;
 
@@ -47,6 +48,7 @@
 @ActiveProfiles("test")
 @SpringBootTest
 @AutoConfigureMockMvc
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractSpringDocTest {
 
 	/**

diff --git a/...napi-kotlin-webflux-tests/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java b/...napi-kotlin-webflux-tests/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java
@@ -31,13 +31,15 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.reactive.server.EntityExchangeResult;
 import org.springframework.test.web.reactive.server.WebTestClient;
 
 import static org.skyscreamer.jsonassert.JSONAssert.assertEquals;
 
 @WebFluxTest
 @ActiveProfiles("test")
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractSpringDocTest {
 
 	protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractSpringDocTest.class);

diff --git a/...otlin-webflux-tests/src/test/kotlin/test/org/springdoc/api/AbstractKotlinSpringDocTest.kt b/...otlin-webflux-tests/src/test/kotlin/test/org/springdoc/api/AbstractKotlinSpringDocTest.kt
@@ -26,6 +26,7 @@ import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient
 import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest
 import org.springframework.test.context.ActiveProfiles
+import org.springframework.test.context.TestPropertySource
 import org.springframework.test.web.reactive.server.WebTestClient
 import java.nio.charset.StandardCharsets
 import java.nio.file.Files
@@ -34,6 +35,7 @@ import java.nio.file.Paths
 @WebFluxTest
 @ActiveProfiles("test")
 @AutoConfigureWebTestClient(timeout = "3600000")
+@TestPropertySource(properties = ["springdoc.api-docs.version=openapi_3_0"])
 abstract class AbstractKotlinSpringDocTest {
 
 	@Autowired

diff --git a/...lin-webmvc-tests/src/test/kotlin/test/org/springdoc/api/AbstractKotlinSpringDocMVCTest.kt b/...lin-webmvc-tests/src/test/kotlin/test/org/springdoc/api/AbstractKotlinSpringDocMVCTest.kt
@@ -25,6 +25,7 @@ import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
 import org.springframework.boot.test.context.SpringBootTest
 import org.springframework.test.context.ActiveProfiles
+import org.springframework.test.context.TestPropertySource
 import org.springframework.test.web.servlet.MockMvc
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers
@@ -35,6 +36,7 @@ import java.nio.file.Paths
 @SpringBootTest
 @AutoConfigureMockMvc
 @ActiveProfiles("test")
+@TestPropertySource(properties = ["springdoc.api-docs.version=openapi_3_0"])
 abstract class AbstractKotlinSpringDocMVCTest {
 
     @Autowired

diff --git a/...pi-kotlin-webmvc-tests/src/test/kotlin/test/org/springdoc/api/app13/SpringDocApp13Test.kt b/...pi-kotlin-webmvc-tests/src/test/kotlin/test/org/springdoc/api/app13/SpringDocApp13Test.kt
@@ -21,23 +21,15 @@ package test.org.springdoc.api.app13
 import org.springdoc.core.properties.SpringDocConfigProperties
 import org.springdoc.core.properties.SpringDocConfigProperties.ApiDocs.OpenApiVersion
 import org.springframework.boot.autoconfigure.SpringBootApplication
-import org.springframework.boot.test.context.SpringBootTest
 import org.springframework.context.annotation.Bean
-import org.springframework.context.annotation.ComponentScan
-import org.springframework.context.annotation.Configuration
+import org.springframework.test.context.TestPropertySource
 import test.org.springdoc.api.AbstractKotlinSpringDocMVCTest
 
-
+@TestPropertySource(properties = ["springdoc.api-docs.version=openapi_3_1"])
 class SpringDocApp13Test : AbstractKotlinSpringDocMVCTest() {
 
 	@SpringBootApplication
 	class DemoApplication {
-		@Bean
-		fun springDocConfigProperties():SpringDocConfigProperties{
-			val x= SpringDocConfigProperties()
-			x.apiDocs.version = OpenApiVersion.OPENAPI_3_1
-			return x
-		}		
 	}
 
 

diff --git a/...oc-openapi-security-tests/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java b/...oc-openapi-security-tests/src/test/java/test/org/springdoc/api/AbstractSpringDocTest.java
@@ -33,6 +33,7 @@
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MvcResult;
 
@@ -45,6 +46,7 @@
 @ActiveProfiles("test")
 @SpringBootTest
 @AutoConfigureMockMvc
+@TestPropertySource(properties =  "springdoc.api-docs.version=openapi_3_0" )
 public abstract class AbstractSpringDocTest {
 
 	public static String className;