Skip to content

Commit e4d0c0d

Browse files
committed
code review
1 parent 728d2c3 commit e4d0c0d

File tree

6 files changed

+25
-34
lines changed

6 files changed

+25
-34
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
315315
Map<String, Object> findControllerAdvice = openAPIService.getControllerAdviceMap();
316316
// calculate generic responses
317317
openApi = openAPIService.getCalculatedOpenAPI();
318-
if (springDocConfigProperties.isOverrideWithGenericResponse() || springDocConfigProperties.isOverrideWithGenericResponseIfDeclared()) {
318+
if (springDocConfigProperties.isDefaultOverrideWithGenericResponse()) {
319319
if (!CollectionUtils.isEmpty(mappingsMap))
320320
findControllerAdvice.putAll(mappingsMap);
321321
responseBuilder.buildGenericResponse(openApi.getComponents(), findControllerAdvice, finalLocale);

springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ public GenericResponseService(OperationService operationService, List<ReturnType
142142
public ApiResponses build(Components components, HandlerMethod handlerMethod, Operation operation,
143143
MethodAttributes methodAttributes) {
144144
Map<String, ApiResponse> genericMapResponse = getGenericMapResponse(handlerMethod.getBeanType());
145-
if (springDocConfigProperties.isOverrideWithGenericResponseIfDeclared()) {
145+
if (springDocConfigProperties.isOverrideWithGenericResponse()) {
146146
genericMapResponse = filterAndEnrichGenericMapResponseByDeclarations(handlerMethod, genericMapResponse);
147147
}
148148
ApiResponses apiResponses = methodAttributes.calculateGenericMapResponse(genericMapResponse);
@@ -549,7 +549,7 @@ else if (CollectionUtils.isEmpty(apiResponse.getContent()))
549549
if (schemaN != null && ArrayUtils.isNotEmpty(methodAttributes.getMethodProduces()))
550550
Arrays.stream(methodAttributes.getMethodProduces()).forEach(mediaTypeStr -> mergeSchema(existingContent, schemaN, mediaTypeStr));
551551
}
552-
if (springDocConfigProperties.isOverrideWithGenericResponseIfDeclared()
552+
if (springDocConfigProperties.isOverrideWithGenericResponse()
553553
&& methodParameter.getExecutable().isAnnotationPresent(ExceptionHandler.class)) {
554554
// ExceptionHandler's exception class resolution is non-trivial
555555
// more info on its javadoc

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

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -115,12 +115,7 @@ public class SpringDocConfigProperties {
115115
/**
116116
* The Override with generic response.
117117
*/
118-
private boolean overrideWithGenericResponse = true;
119-
120-
/**
121-
* The Override with generic response only if the exception is declared
122-
*/
123-
private boolean overrideWithGenericResponseIfDeclared = false;
118+
private Boolean overrideWithGenericResponse;
124119

125120
/**
126121
* The Remove broken reference definitions.
@@ -584,35 +579,29 @@ public void setDefaultProducesMediaType(String defaultProducesMediaType) {
584579
*
585580
* @return the boolean
586581
*/
587-
public boolean isOverrideWithGenericResponse() {
588-
return overrideWithGenericResponse;
582+
public Boolean isOverrideWithGenericResponse() {
583+
return overrideWithGenericResponse != null && overrideWithGenericResponse;
589584
}
590585

591586
/**
592-
* Sets override with generic response.
587+
* Gets default override with generic response.
593588
*
594-
* @param overrideWithGenericResponse the override with generic response
589+
* @return the default override with generic response
595590
*/
596-
public void setOverrideWithGenericResponse(boolean overrideWithGenericResponse) {
597-
this.overrideWithGenericResponse = overrideWithGenericResponse;
591+
public boolean isDefaultOverrideWithGenericResponse() {
592+
if (overrideWithGenericResponse == null)
593+
return true;
594+
else
595+
return overrideWithGenericResponse;
598596
}
599597

600598
/**
601-
* Is override with generic response if declared boolean.
602-
*
603-
* @return the boolean
604-
*/
605-
public boolean isOverrideWithGenericResponseIfDeclared() {
606-
return overrideWithGenericResponseIfDeclared;
607-
}
608-
609-
/**
610-
* Sets override with generic response if declared.
599+
* Sets override with generic response.
611600
*
612-
* @param overrideWithGenericResponseIfDeclared the override with generic response if declared
601+
* @param overrideWithGenericResponse the override with generic response
613602
*/
614-
public void setOverrideWithGenericResponseIfDeclared(boolean overrideWithGenericResponseIfDeclared) {
615-
this.overrideWithGenericResponseIfDeclared = overrideWithGenericResponseIfDeclared;
603+
public void setOverrideWithGenericResponse(Boolean overrideWithGenericResponse) {
604+
this.overrideWithGenericResponse = overrideWithGenericResponse;
616605
}
617606

618607
/**

springdoc-openapi-javadoc/src/test/java/test/org/springdoc/api/app162/SpringDocApp162Test.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
/**
1111
* The type Spring doc app 162 test.
1212
*/
13-
@TestPropertySource(properties = "springdoc.override-with-generic-response-if-declared=true")
13+
@TestPropertySource(properties = "springdoc.override-with-generic-response=true")
1414
public class SpringDocApp162Test extends AbstractSpringDocTest {
1515

1616
/**

springdoc-openapi-javadoc/src/test/java/test/org/springdoc/api/app163/SpringDocApp163Test.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22

33
import io.swagger.v3.oas.models.OpenAPI;
44
import io.swagger.v3.oas.models.info.Info;
5+
import test.org.springdoc.api.AbstractSpringDocTest;
6+
57
import org.springframework.boot.autoconfigure.SpringBootApplication;
68
import org.springframework.context.annotation.Bean;
79
import org.springframework.test.context.TestPropertySource;
8-
import test.org.springdoc.api.AbstractSpringDocTest;
910

1011
/**
1112
* The type Spring doc app 163 test.
1213
*/
13-
@TestPropertySource(properties = "springdoc.override-with-generic-response-if-declared=true")
14+
@TestPropertySource(properties = "springdoc.override-with-generic-response=true")
1415
public class SpringDocApp163Test extends AbstractSpringDocTest {
1516

1617
/**
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
package org.springdoc.openapi.javadoc;
1+
package test.org.springdoc.api.app164;
2+
3+
import java.util.stream.Stream;
24

35
import org.junit.jupiter.api.BeforeEach;
46
import org.junit.jupiter.params.ParameterizedTest;
57
import org.junit.jupiter.params.provider.Arguments;
68
import org.junit.jupiter.params.provider.MethodSource;
79
import org.springdoc.core.providers.JavadocProvider;
8-
9-
import java.util.stream.Stream;
10+
import org.springdoc.openapi.javadoc.SpringDocJavadocProvider;
1011

1112
import static org.assertj.core.api.Assertions.assertThat;
1213
import static org.junit.jupiter.params.provider.Arguments.arguments;

0 commit comments

Comments
 (0)