@deprecated on controller should mark all its operations as deprecated.Fixes #1544.

Author: bnasslahsen

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

@@ -21,7 +21,7 @@
 package org.springdoc.core.converters;
 
 import java.lang.annotation.Annotation;
-import java.lang.reflect.AnnotatedElement;
+import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
@@ -82,10 +82,13 @@ public static void addDeprecatedType(Class<? extends Annotation> cls) {
 	/**
 	 * Is deprecated boolean.
 	 *
-	 * @param annotatedElement the annotated element
+	 * @param method the annotated element
 	 * @return the boolean
 	 */
-	public static boolean isDeprecated(AnnotatedElement annotatedElement) {
-		return DEPRECATED_ANNOTATIONS.stream().anyMatch(annoClass -> AnnotatedElementUtils.findMergedAnnotation(annotatedElement, annoClass) != null);
+	public static boolean isDeprecated(Method method) {
+		Class<?> declaringClass = method.getDeclaringClass();
+		boolean deprecatedMethod = DEPRECATED_ANNOTATIONS.stream().anyMatch(annoClass -> AnnotatedElementUtils.findMergedAnnotation(method, annoClass) != null);
+		boolean deprecatedClass = DEPRECATED_ANNOTATIONS.stream().anyMatch(annoClass -> AnnotatedElementUtils.findMergedAnnotation(declaringClass, annoClass) != null);
+		return deprecatedClass || deprecatedMethod;
 	}
 }

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app59/HelloController2.java

@@ -0,0 +1,42 @@
+/*
+ *
+ *  * Copyright 2019-2020 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.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  * Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  * limitations under the License.
+ *
+ */
+
+package test.org.springdoc.api.app59;
+
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@Deprecated
+public class HelloController2 {
+
+	@GetMapping("/example2")
+	public void test() {
+	}
+
+	@PostMapping("/hello2")
+	@ApiResponse(responseCode = "200", description = "The server accepted your hello.")
+	String hello(@Validated @RequestBody final HelloBody helloBody) {
+		return "World!";
+	}
+}

springdoc-openapi-webmvc-core/src/test/resources/results/app59.json

@@ -28,6 +28,16 @@
           "required": true
         },
         "responses": {
+          "400": {
+            "description": "The request is malformed or information is missing.",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
           "500": {
             "description": "An unknown error occurred",
             "content": {
@@ -38,6 +48,36 @@
               }
             }
           },
+          "200": {
+            "description": "The server accepted your hello.",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/hello2": {
+      "post": {
+        "tags": [
+          "hello-controller-2"
+        ],
+        "operationId": "hello_1",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/HelloBody"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
           "400": {
             "description": "The request is malformed or information is missing.",
             "content": {
@@ -48,6 +88,16 @@
               }
             }
           },
+          "500": {
+            "description": "An unknown error occurred",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
           "200": {
             "description": "The server accepted your hello.",
             "content": {
@@ -58,7 +108,8 @@
               }
             }
           }
-        }
+        },
+        "deprecated": true
       }
     },
     "/example": {
@@ -68,6 +119,16 @@
         ],
         "operationId": "test",
         "responses": {
+          "400": {
+            "description": "The request is malformed or information is missing.",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
           "500": {
             "description": "An unknown error occurred",
             "content": {
@@ -78,6 +139,20 @@
               }
             }
           },
+          "200": {
+            "description": "OK"
+          }
+        },
+        "deprecated": true
+      }
+    },
+    "/example2": {
+      "get": {
+        "tags": [
+          "hello-controller-2"
+        ],
+        "operationId": "test_1",
+        "responses": {
           "400": {
             "description": "The request is malformed or information is missing.",
             "content": {
@@ -88,6 +163,16 @@
               }
             }
           },
+          "500": {
+            "description": "An unknown error occurred",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
           "200": {
             "description": "OK"
           }
@@ -111,4 +196,4 @@
       }
     }
   }
-}
+}