Comments are not picked up for fields in Typed data classes. Fixes #1339

bnasslahsen · bnasslahsen · commit a3f14c3ee2fb · 2021-11-17T18:51:17.000+01:00
diff --git a/springdoc-openapi-javadoc/src/main/java/org/springdoc/openapi/javadoc/JavadocPropertyCustomizer.java b/springdoc-openapi-javadoc/src/main/java/org/springdoc/openapi/javadoc/JavadocPropertyCustomizer.java
@@ -75,7 +75,7 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
 				List<Field> fields = FieldUtils.getAllFieldsList(cls);
 				if (!CollectionUtils.isEmpty(fields)) {
 					if (!type.isSchemaProperty()) {
-						Schema existingSchema = context.getDefinedModels().get((cls).getSimpleName());
+						Schema existingSchema = context.resolve(type);
 						setJavadocDescription(fields, existingSchema);
 					}
 					else if (resolvedSchema.get$ref() != null && resolvedSchema.get$ref().contains(AnnotationsUtils.COMPONENTS_REF)) {
diff --git a/springdoc-openapi-javadoc/src/test/resources/results/app108.json b/springdoc-openapi-javadoc/src/test/resources/results/app108.json
@@ -48,23 +48,29 @@
       "ActionResultVoid": {
         "type": "object",
         "properties": {
-          "value": {
-            "type": "object"
-          },
-          "success": {
-            "type": "boolean"
-          },
           "errorCode": {
-            "type": "string"
+            "type": "string",
+            "description": "The Error code."
+          },
+          "errorValue": {
+            "type": "object",
+            "description": "The Error value."
           },
           "message": {
-            "type": "string"
+            "type": "string",
+            "description": "The Message."
           },
-          "errorValue": {
-            "type": "object"
+          "success": {
+            "type": "boolean",
+            "description": "The Success."
           },
           "targetUrl": {
-            "type": "string"
+            "type": "string",
+            "description": "The Target url."
+          },
+          "value": {
+            "type": "object",
+            "description": "The Value."
           }
         }
       }
diff --git a/springdoc-openapi-javadoc/src/test/resources/results/app122.json b/springdoc-openapi-javadoc/src/test/resources/results/app122.json
@@ -64,7 +64,8 @@
         "type": "object",
         "properties": {
           "wrapper": {
-            "type": "string"
+            "type": "string",
+            "description": "The Wrapper."
           }
         }
       }
diff --git a/springdoc-openapi-javadoc/src/test/resources/results/app129.json b/springdoc-openapi-javadoc/src/test/resources/results/app129.json
@@ -75,7 +75,8 @@
         "type": "object",
         "properties": {
           "operationResult": {
-            "type": "string"
+            "type": "string",
+            "description": "The Operation result."
           }
         }
       }
diff --git a/springdoc-openapi-javadoc/src/test/resources/results/app159.json b/springdoc-openapi-javadoc/src/test/resources/results/app159.json
@@ -76,6 +76,7 @@
         "properties": {
           "code": {
             "type": "integer",
+            "description": "The Code.",
             "format": "int32"
           }
         }
@@ -85,10 +86,12 @@
         "properties": {
           "code": {
             "type": "integer",
+            "description": "The Code.",
             "format": "int32"
           },
           "message": {
-            "type": "string"
+            "type": "string",
+            "description": "The Message."
           }
         }
       }
diff --git a/springdoc-openapi-javadoc/src/test/resources/results/app4.json b/springdoc-openapi-javadoc/src/test/resources/results/app4.json
@@ -55,10 +55,12 @@
         "properties": {
           "trackerId": {
             "type": "string",
+            "description": "The Tracker id.",
             "example": "the-tracker-id"
           },
           "timestamp": {
             "type": "string",
+            "description": "The Timestamp.",
             "format": "date-time",
             "example": "2018-01-01T00:00:00Z"
           },
diff --git a/springdoc-openapi-javadoc/src/test/resources/results/app54.json b/springdoc-openapi-javadoc/src/test/resources/results/app54.json
@@ -115,18 +115,21 @@
         "type": "object",
         "properties": {
           "name": {
-            "type": "string"
+            "type": "string",
+            "description": "The Name."
           }
         }
       },
       "MealParty_MealPartyAdmin": {
         "type": "object",
         "properties": {
           "name": {
-            "type": "string"
+            "type": "string",
+            "description": "The Name."
           },
           "members": {
             "type": "array",
+            "description": "The Members.",
             "items": {
               "type": "string"
             }

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato`
`75`	`75`	`List<Field> fields = FieldUtils.getAllFieldsList(cls);`
`76`	`76`	`if (!CollectionUtils.isEmpty(fields)) {`
`77`	`77`	`if (!type.isSchemaProperty()) {`
`78`		`- Schema existingSchema = context.getDefinedModels().get((cls).getSimpleName());`
	`78`	`+ Schema existingSchema = context.resolve(type);`
`79`	`79`	`setJavadocDescription(fields, existingSchema);`
`80`	`80`	`}`
`81`	`81`	`else if (resolvedSchema.get$ref() != null && resolvedSchema.get$ref().contains(AnnotationsUtils.COMPONENTS_REF)) {`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,8 @@`
`64`	`64`	`"type": "object",`
`65`	`65`	`"properties": {`
`66`	`66`	`"wrapper": {`
`67`		`- "type": "string"`
	`67`	`+ "type": "string",`
	`68`	`+ "description": "The Wrapper."`
`68`	`69`	`}`
`69`	`70`	`}`
`70`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,8 @@`
`75`	`75`	`"type": "object",`
`76`	`76`	`"properties": {`
`77`	`77`	`"operationResult": {`
`78`		`- "type": "string"`
	`78`	`+ "type": "string",`
	`79`	`+ "description": "The Operation result."`
`79`	`80`	`}`
`80`	`81`	`}`
`81`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@`
`76`	`76`	`"properties": {`
`77`	`77`	`"code": {`
`78`	`78`	`"type": "integer",`
	`79`	`+ "description": "The Code.",`
`79`	`80`	`"format": "int32"`
`80`	`81`	`}`
`81`	`82`	`}`
`@@ -85,10 +86,12 @@`
`85`	`86`	`"properties": {`
`86`	`87`	`"code": {`
`87`	`88`	`"type": "integer",`
	`89`	`+ "description": "The Code.",`
`88`	`90`	`"format": "int32"`
`89`	`91`	`},`
`90`	`92`	`"message": {`
`91`		`- "type": "string"`
	`93`	`+ "type": "string",`
	`94`	`+ "description": "The Message."`
`92`	`95`	`}`
`93`	`96`	`}`
`94`	`97`	`}`