code review

Author: bnasslahsen

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

@@ -19,8 +19,6 @@
 package org.springdoc.api;
 
 import java.io.UnsupportedEncodingException;
-import java.lang.annotation.Annotation;
-import java.lang.reflect.AnnotatedElement;
 import java.lang.reflect.Method;
 import java.net.URLDecoder;
 import java.nio.charset.StandardCharsets;
@@ -35,7 +33,6 @@
 import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
-import java.util.stream.Stream;
 
 import com.fasterxml.jackson.annotation.JsonView;
 import io.swagger.v3.core.filter.SpecFilter;
@@ -60,7 +57,6 @@
 import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.customizers.OperationCustomizer;
 
-import org.springframework.core.MethodParameter;
 import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.util.AntPathMatcher;
@@ -70,6 +66,8 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.method.HandlerMethod;
 
+import static org.springdoc.core.converters.SchemaPropertyDeprecatingConverter.isDeprecated;
+
 public abstract class AbstractOpenApiResource extends SpecFilter {
 
 	private static final Logger LOGGER = LoggerFactory.getLogger(AbstractOpenApiResource.class);
@@ -78,12 +76,6 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 
 	private static final List<Class<?>> HIDDEN_REST_CONTROLLERS = new ArrayList<>();
 
-	public static final List<Class<? extends Annotation>> DEPRECATED_ANNOTATIONS = new ArrayList<>();
-
-	static {
-		DEPRECATED_ANNOTATIONS.add(Deprecated.class);
-	}
-
 	protected final OpenAPIBuilder openAPIBuilder;
 
 	protected final SpringDocConfigProperties springDocConfigProperties;
@@ -129,10 +121,6 @@ public static void addHiddenRestControllers(Class<?>... classes) {
 		HIDDEN_REST_CONTROLLERS.addAll(Arrays.asList(classes));
 	}
 
-	public static void addDeprecatedType(Class<? extends Annotation> cls) {
-		DEPRECATED_ANNOTATIONS.add(cls);
-	}
-
 	protected synchronized OpenAPI getOpenApi() {
 		OpenAPI openApi;
 		if (openAPIBuilder.getCachedOpenAPI() == null || springDocConfigProperties.isCacheDisabled()) {
@@ -415,7 +403,4 @@ protected Operation customiseOperation(Operation operation, HandlerMethod handle
 		return operation;
 	}
 
-	private boolean isDeprecated(AnnotatedElement annotatedElement) {
-		return DEPRECATED_ANNOTATIONS.stream().anyMatch(annoClass -> AnnotatedElementUtils.findMergedAnnotation(annotatedElement, annoClass) != null);
-	}
 }

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

@@ -31,11 +31,11 @@
 import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.Schema;
 import org.springdoc.core.converters.AdditionalModelsConverter;
-import org.springdoc.core.converters.SchemaPropertyDeprecatingConverter;
 import org.springdoc.core.converters.FileSupportConverter;
 import org.springdoc.core.converters.ModelConverterRegistrar;
 import org.springdoc.core.converters.PropertyCustomizingConverter;
 import org.springdoc.core.converters.ResponseSupportConverter;
+import org.springdoc.core.converters.SchemaPropertyDeprecatingConverter;
 import org.springdoc.core.customizers.OpenApiBuilderCustomiser;
 import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.customizers.PropertyCustomizer;

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

@@ -38,7 +38,7 @@ public static SpringDocUtils getConfig() {
 	}
 
 	public SpringDocUtils addDeprecatedType(Class<? extends Annotation> cls) {
-		AbstractOpenApiResource.addDeprecatedType(cls);
+		addDeprecatedType(cls);
 		return this;
 	}
 

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

@@ -1,18 +1,27 @@
 package org.springdoc.core.converters;
 
 import java.lang.annotation.Annotation;
+import java.lang.reflect.AnnotatedElement;
+import java.util.ArrayList;
 import java.util.Iterator;
+import java.util.List;
 import java.util.stream.Stream;
 
 import io.swagger.v3.core.converter.AnnotatedType;
 import io.swagger.v3.core.converter.ModelConverter;
 import io.swagger.v3.core.converter.ModelConverterContext;
 import io.swagger.v3.oas.models.media.Schema;
 
-import static org.springdoc.api.AbstractOpenApiResource.DEPRECATED_ANNOTATIONS;
+import org.springframework.core.annotation.AnnotatedElementUtils;
 
 public class SchemaPropertyDeprecatingConverter implements ModelConverter {
 
+	private static final List<Class<? extends Annotation>> DEPRECATED_ANNOTATIONS = new ArrayList<>();
+
+	static {
+		DEPRECATED_ANNOTATIONS.add(Deprecated.class);
+	}
+
 	@Override
 	public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
 		if (chain.hasNext()) {
@@ -27,4 +36,12 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
 	public static boolean containsDeprecatedAnnotation(Annotation[] annotations) {
 		return annotations != null && Stream.of(annotations).map(Annotation::annotationType).anyMatch(DEPRECATED_ANNOTATIONS::contains);
 	}
+
+	public static void addDeprecatedType(Class<? extends Annotation> cls) {
+		DEPRECATED_ANNOTATIONS.add(cls);
+	}
+
+	public static boolean isDeprecated(AnnotatedElement annotatedElement) {
+		return DEPRECATED_ANNOTATIONS.stream().anyMatch(annoClass -> AnnotatedElementUtils.findMergedAnnotation(annotatedElement, annoClass) != null);
+	}
 }