Test update and summary/description fix

Summary is only filled using javadoc if there is no description from annotation.
Failing test update (missing summary or schema description and ordering).

Author: gebezs

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

@@ -463,13 +463,16 @@ protected void calculatePath(HandlerMethod handlerMethod, RouterOperation router
 			// get javadoc method description
 			if (javadocProvider != null) {
 				String description = javadocProvider.getMethodJavadocDescription(handlerMethod.getMethod());
-				if (!StringUtils.isEmpty(description)
-						&& StringUtils.isEmpty(operation.getDescription())) {
+				String summary = javadocProvider.getFirstSentence(description);
+				boolean emptyOverrideDescription = StringUtils.isEmpty(operation.getDescription());
+				boolean emptyOverrideSummary = StringUtils.isEmpty(operation.getSummary());
+				if (!StringUtils.isEmpty(description) && emptyOverrideDescription) {
 					operation.setDescription(description);
 				}
-				String summary = javadocProvider.getFirstSentence(description);
-				if (!StringUtils.isEmpty(summary)
-						&& StringUtils.isEmpty(operation.getSummary())) {
+				// if there is a previously set description
+				// but no summary then it is intentional
+				// we keep it as is
+				if (!StringUtils.isEmpty(summary) && emptyOverrideSummary && emptyOverrideDescription) {
 					operation.setSummary(javadocProvider.getFirstSentence(description));
 				}
 			}

springdoc-openapi-javadoc/src/test/resources/results/app1.json

@@ -212,6 +212,7 @@
         "tags": [
           "items"
         ],
+        "summary": "Show items list.",
         "description": "Show items list.",
         "operationId": "showItems",
         "parameters": [
@@ -293,6 +294,7 @@
         "tags": [
           "items"
         ],
+        "summary": "Add item response entity.",
         "description": "Add item response entity.",
         "operationId": "addItem",
         "requestBody": {
@@ -494,6 +496,7 @@
         "tags": [
           "tea"
         ],
+        "summary": "Index string.",
         "description": "Index string.",
         "operationId": "index",
         "parameters": [
@@ -554,7 +557,8 @@
             "type": "string",
             "description": "The Message."
           }
-        }
+        },
+        "description": "The type Error message."
       },
       "PersonDTO": {
         "type": "object",
@@ -571,7 +575,8 @@
             "type": "string",
             "description": "The Last name."
           }
-        }
+        },
+        "description": "The type Person dto."
       },
       "ItemLightDTO": {
         "type": "object",
@@ -591,7 +596,8 @@
             "format": "int32",
             "deprecated": true
           }
-        }
+        },
+        "description": "The type Item light dto."
       },
       "InventoryItem": {
         "required": [
@@ -621,7 +627,8 @@
           "manufacturer": {
             "$ref": "#/components/schemas/Manufacturer"
           }
-        }
+        },
+        "description": "InventoryItem"
       },
       "Manufacturer": {
         "required": [
@@ -644,7 +651,8 @@
             "description": "The Phone.",
             "example": "408-867-5309"
           }
-        }
+        },
+        "description": "Manufacturer"
       },
       "ItemDTO": {
         "type": "object",
@@ -668,7 +676,8 @@
             "format": "int32",
             "deprecated": true
           }
-        }
+        },
+        "description": "The type Item dto."
       }
     },
     "securitySchemes": {
@@ -678,4 +687,4 @@
       }
     }
   }
-}
+}

springdoc-openapi-javadoc/src/test/resources/results/app10.json

@@ -10,12 +10,19 @@
       "description": "Generated server url"
     }
   ],
+  "tags": [
+    {
+      "name": "hello-controller",
+      "description": "The type Hello controller."
+    }
+  ],
   "paths": {
     "/testreq": {
       "get": {
         "tags": [
           "hello-controller"
         ],
+        "summary": "Test request attribute.",
         "description": "Test request attribute.",
         "operationId": "testRequestAttribute",
         "parameters": [
@@ -41,6 +48,7 @@
         "tags": [
           "hello-controller"
         ],
+        "summary": "Test.",
         "description": "Test.",
         "operationId": "test",
         "parameters": [

springdoc-openapi-javadoc/src/test/resources/results/app100.json

@@ -25,6 +25,7 @@
           "hello-ap1",
           "hello-ap2"
         ],
+        "summary": "Gets all pets.",
         "description": "Gets all pets.",
         "operationId": "getAllPets",
         "parameters": [
@@ -75,8 +76,9 @@
             "type": "string",
             "description": "The Last name."
           }
-        }
+        },
+        "description": "The type Person dto."
       }
     }
   }
-}
+}

springdoc-openapi-javadoc/src/test/resources/results/app101.json

@@ -10,12 +10,19 @@
       "description": "Generated server url"
     }
   ],
+  "tags": [
+    {
+      "name": "hello-controller",
+      "description": "The type Hello controller."
+    }
+  ],
   "paths": {
     "/hello": {
       "get": {
         "tags": [
           "hello-controller"
         ],
+        "summary": "Hello hello dto.",
         "description": "Hello hello dto.",
         "operationId": "hello",
         "responses": {

springdoc-openapi-javadoc/src/test/resources/results/app102.json

@@ -10,12 +10,19 @@
       "description": "Generated server url"
     }
   ],
+  "tags": [
+    {
+      "name": "test-controller",
+      "description": "The type Test controller."
+    }
+  ],
   "paths": {
     "/test": {
       "get": {
         "tags": [
           "test-controller"
         ],
+        "summary": "Gets test.",
         "description": "Gets test.",
         "operationId": "getTest",
         "parameters": [
@@ -145,7 +152,8 @@
             "type": "integer",
             "description": "The Param 2."
           }
-        }
+        },
+        "description": "The type Nested."
       }
     }
   }

springdoc-openapi-javadoc/src/test/resources/results/app103.json

@@ -10,12 +10,19 @@
       "description": "Generated server url"
     }
   ],
+  "tags": [
+    {
+      "name": "hello-controller",
+      "description": "The type Hello controller."
+    }
+  ],
   "paths": {
     "/test/103": {
       "post": {
         "tags": [
           "hello-controller"
         ],
+        "summary": "Post my request body string.",
         "description": "Post my request body string.",
         "operationId": "postMyRequestBody",
         "requestBody": {
@@ -75,7 +82,8 @@
             "description": "The Int param.",
             "format": "int32"
           }
-        }
+        },
+        "description": "The type Example body."
       }
     }
   }

springdoc-openapi-javadoc/src/test/resources/results/app105-1.json

@@ -257,7 +257,8 @@
             "type": "string",
             "description": "Order Status"
           }
-        }
+        },
+        "description": "The type Order."
       }
     },
     "securitySchemes": {

springdoc-openapi-javadoc/src/test/resources/results/app105-2.json

@@ -425,7 +425,8 @@
             "type": "string",
             "description": "The Username."
           }
-        }
+        },
+        "description": "The type User."
       }
     },
     "securitySchemes": {

springdoc-openapi-javadoc/src/test/resources/results/app105-3.json

@@ -570,7 +570,8 @@
             "type": "string",
             "description": "The Type."
           }
-        }
+        },
+        "description": "The type Model api response."
       },
       "Pet": {
         "required": [
@@ -615,7 +616,8 @@
               "$ref": "#/components/schemas/Tag"
             }
           }
-        }
+        },
+        "description": "The type Pet."
       },
       "Tag": {
         "type": "object",

springdoc-openapi-javadoc/src/test/resources/results/app105-4.json

@@ -28,6 +28,7 @@
         "tags": [
           "store"
         ],
+        "summary": "Stores.",
         "description": "Stores.",
         "operationId": "stores",
         "parameters": [

springdoc-openapi-javadoc/src/test/resources/results/app106.json

@@ -10,6 +10,12 @@
       "description": "Generated server url"
     }
   ],
+  "tags": [
+    {
+      "name": "hello-controller",
+      "description": "The type Hello controller."
+    }
+  ],
   "paths": {
     "/": {
       "get": {

springdoc-openapi-javadoc/src/test/resources/results/app107.json

@@ -10,12 +10,19 @@
       "description": "Generated server url"
     }
   ],
+  "tags": [
+    {
+      "name": "hello-controller",
+      "description": "The type Hello controller."
+    }
+  ],
   "paths": {
     "/entity-b": {
       "get": {
         "tags": [
           "hello-controller"
         ],
+        "summary": "Gets entity b.",
         "description": "Gets entity b.",
         "operationId": "getEntityB",
         "responses": {
@@ -50,7 +57,8 @@
             "type": "string",
             "description": "The Field a."
           }
-        }
+        },
+        "description": "The type Entity a."
       },
       "EntityB": {
         "required": [
@@ -66,7 +74,8 @@
           "entityA": {
             "$ref": "#/components/schemas/EntityA"
           }
-        }
+        },
+        "description": "The type Entity b."
       }
     }
   }

springdoc-openapi-javadoc/src/test/resources/results/app108.json

@@ -10,12 +10,19 @@
       "description": "Generated server url"
     }
   ],
+  "tags": [
+    {
+      "name": "hello-controller",
+      "description": "The type Hello controller."
+    }
+  ],
   "paths": {
     "/": {
       "post": {
         "tags": [
           "hello-controller"
         ],
+        "summary": "Update action result.",
         "description": "Update action result.",
         "operationId": "update",
         "parameters": [
@@ -73,8 +80,9 @@
             "type": "object",
             "description": "The Value."
           }
-        }
+        },
+        "description": "The type Action result."
       }
     }
   }
-}
+}