Skip to content

Commit 9d7f6ae

Browse files
committed
Moving to OpenAPI 3.1 as the default implementation for springdoc-openapi. Fixes #2790
1 parent d003748 commit 9d7f6ae

File tree

23 files changed

+39
-21
lines changed

23 files changed

+39
-21
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -510,6 +510,8 @@ private void trimIndentOperation(Operation operation) {
510510
*/
511511
protected void calculateWebhooks(OpenAPI calculatedOpenAPI, Locale locale) {
512512
Webhooks[] webhooksAttr = openAPIService.getWebhooks();
513+
if(ArrayUtils.isEmpty(webhooksAttr))
514+
return;
513515
var webhooks = Arrays.stream(webhooksAttr).map(Webhooks::value).flatMap(Arrays::stream).toArray(Webhook[]::new);
514516
Arrays.stream(webhooks).forEach(webhook -> {
515517
io.swagger.v3.oas.annotations.Operation apiOperation = webhook.operation();

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/properties/SpringDocConfigProperties.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1304,7 +1304,7 @@ public static class ApiDocs {
13041304
/**
13051305
* The OpenAPI version.
13061306
*/
1307-
private OpenApiVersion version;
1307+
private OpenApiVersion version = OpenApiVersion.OPENAPI_3_1;
13081308

13091309
/**
13101310
* Gets path.

springdoc-openapi-starter-webflux-api/src/test/java/test/org/springdoc/api/AbstractCommonTest.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@
1111
import org.springframework.beans.factory.annotation.Autowired;
1212
import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
1313
import org.springframework.test.context.ActiveProfiles;
14+
import org.springframework.test.context.TestPropertySource;
1415
import org.springframework.test.web.reactive.server.WebTestClient;
1516

1617
@AutoConfigureWebTestClient(timeout = "3600000")
1718
@ActiveProfiles("test")
19+
@TestPropertySource(properties = "springdoc.api-docs.version=openapi_3_0" )
1820
public abstract class AbstractCommonTest {
1921

2022
protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractCommonTest.class);

springdoc-openapi-starter-webflux-ui/src/test/java/test/org/springdoc/ui/AbstractCommonTest.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@
1212
import org.springframework.beans.factory.annotation.Autowired;
1313
import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
1414
import org.springframework.test.context.ActiveProfiles;
15+
import org.springframework.test.context.TestPropertySource;
1516
import org.springframework.test.web.reactive.server.WebTestClient;
1617

1718
@AutoConfigureWebTestClient(timeout = "3600000")
1819
@ActiveProfiles("test")
20+
@TestPropertySource(properties = "springdoc.api-docs.version=openapi_3_0" )
1921
public abstract class AbstractCommonTest {
2022

2123
protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractCommonTest.class);

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/AbstractSpringDocV30Test.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import test.org.springdoc.api.AbstractCommonTest;
3030

3131
import org.springframework.boot.test.context.SpringBootTest;
32+
import org.springframework.test.context.TestPropertySource;
3233
import org.springframework.test.web.servlet.MvcResult;
3334

3435
import static org.hamcrest.Matchers.is;
@@ -38,6 +39,7 @@
3839
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
3940

4041
@SpringBootTest
42+
@TestPropertySource(properties = { "springdoc.api-docs.version=openapi_3_0" })
4143
public abstract class AbstractSpringDocV30Test extends AbstractCommonTest {
4244

4345
public static String className;

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app136/SpringDocApp136Test.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
/**
5353
* Tests deterministic creation of operationIds
5454
*/
55-
@SpringBootTest(properties = { SPRINGDOC_CACHE_DISABLED + "=true" })
55+
@SpringBootTest(properties = { SPRINGDOC_CACHE_DISABLED + "=true", "springdoc.api-docs.version=openapi_3_0" })
5656
public class SpringDocApp136Test extends AbstractCommonTest {
5757

5858
@Autowired

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app193/SpringDocApp193Test.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
4040
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
4141

42-
@SpringBootTest
42+
@SpringBootTest(properties = { "springdoc.api-docs.version=openapi_3_0" })
4343
public class SpringDocApp193Test extends AbstractCommonTest {
4444

4545
@Test

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app209/SpringDocApp209Test.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@
5656

5757
@SpringBootTest(properties = {
5858
"springdoc.pre-loading-enabled=true",
59-
"springdoc.pre-loading-locales=ja"
59+
"springdoc.pre-loading-locales=ja",
60+
"springdoc.api-docs.version=openapi_3_0"
6061
})
6162
public class SpringDocApp209Test extends AbstractCommonTest {
6263
public static String className;

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v31/AbstractSpringDocV31Test.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@
3939
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
4040

4141
@SpringBootTest
42-
@TestPropertySource(properties = { "springdoc.api-docs.version=openapi_3_1" })
4342
public abstract class AbstractSpringDocV31Test extends AbstractCommonTest {
4443

4544
public static String className;

springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/AbstractCommonTest.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@
99
import org.springframework.beans.factory.annotation.Autowired;
1010
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
1111
import org.springframework.test.context.ActiveProfiles;
12+
import org.springframework.test.context.TestPropertySource;
1213
import org.springframework.test.web.servlet.MockMvc;
1314

1415
@AutoConfigureMockMvc
1516
@ActiveProfiles("test")
17+
@TestPropertySource(properties = "springdoc.api-docs.version=openapi_3_0" )
1618
public abstract class AbstractCommonTest {
1719

1820
@Autowired

0 commit comments

Comments
 (0)