Changes report: Missing Request Body for Write Operation Actuator Endpoints. Fixes springdoc#1565.

bnasslahsen · bnasslahsen · commit d061b3a2dabc · 2022-03-22T00:40:07.000+01:00
diff --git a/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/ActuatorOperationCustomizer.java b/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/ActuatorOperationCustomizer.java
@@ -22,12 +22,27 @@
 
 package org.springdoc.core.customizers;
 
+import java.lang.reflect.Field;
+import java.lang.reflect.Parameter;
 import java.util.HashMap;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import io.swagger.v3.core.util.AnnotationsUtils;
 import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.media.Content;
+import io.swagger.v3.oas.models.media.MediaType;
+import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.parameters.RequestBody;
+import org.apache.commons.lang3.reflect.FieldUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
+import org.springframework.boot.actuate.endpoint.OperationType;
+import org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredOperation;
+import org.springframework.boot.actuate.endpoint.annotation.Selector;
+import org.springframework.boot.actuate.endpoint.invoke.OperationParameter;
+import org.springframework.boot.actuate.endpoint.invoke.reflect.OperationMethod;
 import org.springframework.web.method.HandlerMethod;
 
 import static org.apache.commons.lang3.math.NumberUtils.INTEGER_ONE;
@@ -44,6 +59,11 @@ public class ActuatorOperationCustomizer implements OperationCustomizer {
 	 */
 	private HashMap<String, Integer> methodCountMap = new HashMap<>();
 
+	private static final String OPERATION = "operation";
+
+	private static final String PARAMETER = "parameter";
+
+	private static final Logger LOGGER = LoggerFactory.getLogger(ActuatorOperationCustomizer.class);
 
 	/**
 	 * The regex pattern for operationId lookup.
@@ -53,14 +73,39 @@ public class ActuatorOperationCustomizer implements OperationCustomizer {
 	@Override
 	public Operation customize(Operation operation, HandlerMethod handlerMethod) {
 		if (operation.getTags() != null && operation.getTags().contains(getTag().getName())) {
+			Field operationFiled = FieldUtils.getDeclaredField(handlerMethod.getBean().getClass(), OPERATION, true);
+			Object actuatorOperation;
+			if (operationFiled != null) {
+				try {
+					actuatorOperation = operationFiled.get(handlerMethod.getBean());
+					operationFiled = FieldUtils.getDeclaredField(actuatorOperation.getClass(), OPERATION, true);
+					AbstractDiscoveredOperation discoveredOperation = (AbstractDiscoveredOperation) operationFiled.get(actuatorOperation);
+					OperationMethod operationMethod = discoveredOperation.getOperationMethod();
+					if (OperationType.WRITE.equals(operationMethod.getOperationType())) {
+						for (OperationParameter operationParameter : operationMethod.getParameters()) {
+							Field parameterField = FieldUtils.getDeclaredField(operationParameter.getClass(), PARAMETER, true);
+							Parameter parameter = (Parameter) parameterField.get(operationParameter);
+							Schema<?> schema = AnnotationsUtils.resolveSchemaFromType(parameter.getType(), null, null);
+							if (parameter.getAnnotation(Selector.class) == null) {
+								operation.setRequestBody(new RequestBody()
+										.content(new Content().addMediaType(org.springframework.http.MediaType.APPLICATION_JSON_VALUE, new MediaType().schema(schema))));
+							}
+						}
+					}
+				}
+				catch (IllegalAccessException e) {
+					LOGGER.warn(e.getMessage());
+				}
+			}
+
 			String summary = handlerMethod.toString();
 			Matcher matcher = pattern.matcher(summary);
 			String operationId = operation.getOperationId();
 			while (matcher.find()) {
 				operationId = matcher.group(1);
 			}
 			if (methodCountMap.containsKey(operationId)) {
-				Integer methodCount = methodCountMap.get(operationId)+1;
+				Integer methodCount = methodCountMap.get(operationId) + 1;
 				methodCountMap.put(operationId, methodCount);
 				operationId = operationId + "_" + methodCount;
 			}
diff --git a/springdoc-openapi-tests/springdoc-openapi-actuator-webflux-tests/src/test/resources/results/app146-1.json b/springdoc-openapi-tests/springdoc-openapi-actuator-webflux-tests/src/test/resources/results/app146-1.json
@@ -75,6 +75,24 @@
             }
           }
         ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string",
+                "enum": [
+                  "TRACE",
+                  "DEBUG",
+                  "INFO",
+                  "WARN",
+                  "ERROR",
+                  "FATAL",
+                  "OFF"
+                ]
+              }
+            }
+          }
+        },
         "responses": {
           "200": {
             "description": "OK",
diff --git a/springdoc-openapi-tests/springdoc-openapi-actuator-webflux-tests/src/test/resources/results/app147-1.json b/springdoc-openapi-tests/springdoc-openapi-actuator-webflux-tests/src/test/resources/results/app147-1.json
@@ -75,6 +75,24 @@
             }
           }
         ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string",
+                "enum": [
+                  "TRACE",
+                  "DEBUG",
+                  "INFO",
+                  "WARN",
+                  "ERROR",
+                  "FATAL",
+                  "OFF"
+                ]
+              }
+            }
+          }
+        },
         "responses": {
           "200": {
             "description": "OK",
diff --git a/springdoc-openapi-tests/springdoc-openapi-actuator-webflux-tests/src/test/resources/results/app148-2.json b/springdoc-openapi-tests/springdoc-openapi-actuator-webflux-tests/src/test/resources/results/app148-2.json
@@ -75,6 +75,24 @@
             }
           }
         ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string",
+                "enum": [
+                  "TRACE",
+                  "DEBUG",
+                  "INFO",
+                  "WARN",
+                  "ERROR",
+                  "FATAL",
+                  "OFF"
+                ]
+              }
+            }
+          }
+        },
         "responses": {
           "200": {
             "description": "OK",
diff --git a/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app148/SpringDocApp148Test.java b/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/java/test/org/springdoc/api/app148/SpringDocApp148Test.java
@@ -55,6 +55,7 @@ public void testApp() throws Exception {
 	@Test
 	public void testApp2() throws Exception {
 		String result = actuatorRestTemplate.getForObject("/test/application/openapi/x-actuator", String.class);
+		System.out.println(result);
 		String expected = getContent("results/app148-2.json");
 		assertEquals(expected, result, true);
 	}
diff --git a/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/resources/results/app146-1.json b/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/resources/results/app146-1.json
@@ -77,6 +77,24 @@
             }
           }
         ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string",
+                "enum": [
+                  "TRACE",
+                  "DEBUG",
+                  "INFO",
+                  "WARN",
+                  "ERROR",
+                  "FATAL",
+                  "OFF"
+                ]
+              }
+            }
+          }
+        },
         "responses": {
           "200": {
             "description": "OK",
diff --git a/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/resources/results/app147-1.json b/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/resources/results/app147-1.json
@@ -77,6 +77,24 @@
             }
           }
         ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string",
+                "enum": [
+                  "TRACE",
+                  "DEBUG",
+                  "INFO",
+                  "WARN",
+                  "ERROR",
+                  "FATAL",
+                  "OFF"
+                ]
+              }
+            }
+          }
+        },
         "responses": {
           "200": {
             "description": "OK",
diff --git a/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/resources/results/app148-2.json b/springdoc-openapi-tests/springdoc-openapi-actuator-webmvc-tests/src/test/resources/results/app148-2.json
@@ -77,6 +77,24 @@
             }
           }
         ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string",
+                "enum": [
+                  "TRACE",
+                  "DEBUG",
+                  "INFO",
+                  "WARN",
+                  "ERROR",
+                  "FATAL",
+                  "OFF"
+                ]
+              }
+            }
+          }
+        },
         "responses": {
           "200": {
             "description": "OK",

Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ public void testApp() throws Exception {`
`55`	`55`	`@Test`
`56`	`56`	`public void testApp2() throws Exception {`
`57`	`57`	`String result = actuatorRestTemplate.getForObject("/test/application/openapi/x-actuator", String.class);`
	`58`	`+ System.out.println(result);`
`58`	`59`	`String expected = getContent("results/app148-2.json");`
`59`	`60`	`assertEquals(expected, result, true);`
`60`	`61`	`}`