Springdoc does not resolve property descriptions for arrays. Fixes #2003

springdoc · Dec 14, 2022 · e4400d0 · e4400d0
1 parent 209c55b
commit e4400d0
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/PropertyResolverUtils.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/PropertyResolverUtils.java
@@ -34,6 +34,7 @@
 import io.swagger.v3.oas.models.info.Contact;
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.info.License;
+import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.servers.Server;
 import org.apache.commons.lang3.StringUtils;
@@ -174,6 +175,10 @@ public Schema resolveProperties(Schema<?> schema, Locale locale) {
 		if (!CollectionUtils.isEmpty(properties)) {
 			LinkedHashMap<String, Schema> resolvedSchemas = properties.entrySet().stream().map(es -> {
 				es.setValue(resolveProperties(es.getValue(), locale));
+				if(es.getValue() instanceof ArraySchema){
+					ArraySchema arraySchema = (ArraySchema) es.getValue();
+					resolveProperties(arraySchema.getItems(), locale);
+				}
 				return es;
 			}).collect(Collectors.toMap(Entry::getKey, Entry::getValue, (e1, e2) -> e2,
 					LinkedHashMap::new));

diff --git a/...napi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app164/SampleResponseClass.java b/...napi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app164/SampleResponseClass.java
@@ -22,6 +22,11 @@
 
 package test.org.springdoc.api.v30.app164;
 
+import java.util.List;
+
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Schema;
+
 public class SampleResponseClass {
 
 	private String idAsFirstParameter;
@@ -32,6 +37,18 @@ public class SampleResponseClass {
 
 	private boolean booleanValueAsFourthParameter;
 
+	@ArraySchema( arraySchema = @Schema( description = "${blahDescription.value}" ),
+			schema = @Schema( description = "${blahDescription.value}" ) )
+	private List<String> listBlah;
+
+	public List<String> getListBlah() {
+		return listBlah;
+	}
+
+	public void setListBlah(List<String> listBlah) {
+		this.listBlah = listBlah;
+	}
+
 	public String getIdAsFirstParameter() {
 		return idAsFirstParameter;
 	}

diff --git a/springdoc-openapi-webmvc-core/src/test/resources/application-test.properties b/springdoc-openapi-webmvc-core/src/test/resources/application-test.properties
@@ -1,3 +1,4 @@
 spring.main.banner-mode=off
 logging.level.root=OFF
-spring.main.lazy-initialization=true
+spring.main.lazy-initialization=true
+blahDescription.value=test
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app164.json b/springdoc-openapi-webmvc-core/src/test/resources/results/3.0.1/app164.json
@@ -48,9 +48,17 @@
           },
           "booleanValueAsFourthParameter": {
             "type": "boolean"
+          },
+          "listBlah": {
+            "type": "array",
+            "description": "test",
+            "items": {
+              "type": "string",
+              "description": "test"
+            }
           }
         }
       }
     }
   }
-}
+}