Added support using properties from application.yml for description on operation. Fixes #231

Author: springdoc

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

@@ -29,14 +29,16 @@ public class OperationBuilder {
     private final RequestBodyBuilder requestBodyBuilder;
     private final SecurityParser securityParser;
     private final OpenAPIBuilder openAPIBuilder;
+    private final PropertyResolverUtils propertyResolverUtils;
 
     public OperationBuilder(AbstractParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
-                            SecurityParser securityParser, OpenAPIBuilder openAPIBuilder) {
+                            SecurityParser securityParser, OpenAPIBuilder openAPIBuilder, PropertyResolverUtils propertyResolverUtils) {
         super();
         this.parameterBuilder = parameterBuilder;
         this.requestBodyBuilder = requestBodyBuilder;
         this.securityParser = securityParser;
         this.openAPIBuilder = openAPIBuilder;
+        this.propertyResolverUtils=propertyResolverUtils;
     }
 
     public OpenAPI parse(Components components, io.swagger.v3.oas.annotations.Operation apiOperation,
@@ -45,7 +47,7 @@ public OpenAPI parse(Components components, io.swagger.v3.oas.annotations.Operat
             operation.setSummary(apiOperation.summary());
         }
         if (StringUtils.isNotBlank(apiOperation.description())) {
-            operation.setDescription(apiOperation.description());
+            operation.setDescription(propertyResolverUtils.resolve(apiOperation.description()));
         }
         if (StringUtils.isNotBlank(apiOperation.operationId())) {
             operation.setOperationId(getOperationId(apiOperation.operationId(), openAPI));

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

@@ -37,9 +37,9 @@ public OpenAPIBuilder openAPIBuilder(Optional<OpenAPI> openAPI, ApplicationConte
 
     @Bean
     public OperationBuilder operationBuilder(AbstractParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
-                                             SecurityParser securityParser, OpenAPIBuilder openAPIBuilder) {
+                                             SecurityParser securityParser, OpenAPIBuilder openAPIBuilder, PropertyResolverUtils propertyResolverUtils) {
         return new OperationBuilder(parameterBuilder, requestBodyBuilder,
-                securityParser, openAPIBuilder);
+                securityParser, openAPIBuilder,propertyResolverUtils);
     }
 
     @Bean

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app15/HelloController.java

@@ -12,7 +12,7 @@
 public class HelloController {
 
     @GetMapping(value = "/persons")
-    @Operation(responses = @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(hidden = true))))
+    @Operation(description = "${springdoc.operation-descriptions.myOperation}", responses = @ApiResponse(responseCode = "200", content = @Content(schema = @Schema(hidden = true))))
     public JSONObject persons() {
         return new JSONObject();
     }

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app15/SpringDocApp15Test.java

@@ -1,7 +1,9 @@
 package test.org.springdoc.api.app15;
 
+import org.springframework.test.context.TestPropertySource;
 import test.org.springdoc.api.AbstractSpringDocTest;
 
+@TestPropertySource(properties = "springdoc.operation-descriptions.myOperation=My Desc")
 public class SpringDocApp15Test extends AbstractSpringDocTest {
 
 

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

@@ -16,6 +16,7 @@
         "tags": [
           "hello-controller"
         ],
+        "description": "My Desc",
         "operationId": "persons",
         "responses": {
           "200": {

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

@@ -11,13 +11,13 @@
     }
   ],
   "paths": {
-    "/demo/operation2": {
+    "/demo/operation4": {
       "get": {
         "tags": [
           "hello-controller"
         ],
-        "summary": "Operation 2 (expected result - 3 parameters)",
-        "operationId": "operation2",
+        "summary": "Operation 4 (expected result - 3 parameters)",
+        "operationId": "operation4",
         "parameters": [
           {
             "name": "pageNumber",
@@ -63,6 +63,32 @@
         }
       }
     },
+    "/demo/operation1": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "summary": "Operation 1 (expected result - no parameters)",
+        "operationId": "operation1",
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              },
+              "text/plain": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/demo/operation3": {
       "get": {
         "tags": [
@@ -115,52 +141,26 @@
         }
       }
     },
-    "/demo/operation1": {
-      "get": {
-        "tags": [
-          "hello-controller"
-        ],
-        "summary": "Operation 1 (expected result - no parameters)",
-        "operationId": "operation1",
-        "responses": {
-          "200": {
-            "description": "default response",
-            "content": {
-              "*/*": {
-                "schema": {
-                  "type": "string"
-                }
-              },
-              "text/plain": {
-                "schema": {
-                  "type": "string"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/demo/operation4": {
+    "/demo/operation2": {
       "get": {
         "tags": [
           "hello-controller"
         ],
-        "summary": "Operation 4 (expected result - 3 parameters)",
-        "operationId": "operation4",
+        "summary": "Operation 2 (expected result - 3 parameters)",
+        "operationId": "operation2",
         "parameters": [
           {
-            "name": "pageSize",
+            "name": "pageNumber",
             "in": "query",
-            "description": "page size",
+            "description": "page number",
             "schema": {
               "type": "integer"
             }
           },
           {
-            "name": "pageNumber",
+            "name": "pageSize",
             "in": "query",
-            "description": "page number",
+            "description": "page size",
             "schema": {
               "type": "integer"
             }