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

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/OpenAPIService.java

@@ -58,6 +58,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.security.SecurityScheme;
 import io.swagger.v3.oas.models.servers.Server;
@@ -470,6 +471,9 @@ 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){
+					resolveProperties(arraySchema.getItems(), locale);
+				}
 				return es;
 			}).collect(Collectors.toMap(Entry::getKey, Entry::getValue, (e1, e2) -> e2,
 					LinkedHashMap::new));

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/utils/PropertyResolverUtils.java

@@ -24,29 +24,15 @@
 
 package org.springdoc.core.utils;
 
-import java.util.LinkedHashMap;
-import java.util.List;
 import java.util.Locale;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.function.Consumer;
-import java.util.function.Supplier;
-import java.util.stream.Collectors;
 
-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.Schema;
-import io.swagger.v3.oas.models.servers.Server;
-import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springdoc.core.properties.SpringDocConfigProperties;
 
 import org.springframework.beans.factory.config.ConfigurableBeanFactory;
 import org.springframework.context.MessageSource;
 import org.springframework.context.NoSuchMessageException;
-import org.springframework.util.CollectionUtils;
 
 /**
  * The type Property resolver utils.
@@ -115,93 +101,6 @@ public String resolve(String parameterProperty, Locale locale) {
 		return result;
 	}
 
-	/**
-	 * Resolve properties info.
-	 *
-	 * @param servers the servers
-	 * @param locale the locale
-	 * @return the servers
-	 */
-	public List<Server> resolveProperties(List<Server> servers, Locale locale) {
-		servers.forEach(server -> {
-			resolveProperty(server::getUrl, server::url, this, locale);
-			resolveProperty(server::getDescription, server::description, this, locale);
-			if (CollectionUtils.isEmpty(server.getVariables()))
-				server.setVariables(null);
-		});
-		return servers;
-	}
-
-	/**
-	 * Resolve properties info.
-	 *
-	 * @param info the info
-	 * @param locale the locale
-	 * @return the info
-	 */
-	public Info resolveProperties(Info info, Locale locale) {
-		resolveProperty(info::getTitle, info::title, this, locale);
-		resolveProperty(info::getDescription, info::description, this, locale);
-		resolveProperty(info::getVersion, info::version, this, locale);
-		resolveProperty(info::getTermsOfService, info::termsOfService, this, locale);
-
-		License license = info.getLicense();
-		if (license != null) {
-			resolveProperty(license::getName, license::name, this, locale);
-			resolveProperty(license::getUrl, license::url, this, locale);
-		}
-
-		Contact contact = info.getContact();
-		if (contact != null) {
-			resolveProperty(contact::getName, contact::name, this, locale);
-			resolveProperty(contact::getEmail, contact::email, this, locale);
-			resolveProperty(contact::getUrl, contact::url, this, locale);
-		}
-		return info;
-	}
-
-	/**
-	 * Resolve properties schema.
-	 *
-	 * @param schema the schema
-	 * @param locale the locale
-	 * @return the schema
-	 */
-	@SuppressWarnings("unchecked")
-	public Schema resolveProperties(Schema<?> schema, Locale locale) {
-		resolveProperty(schema::getName, schema::name, this, locale);
-		resolveProperty(schema::getTitle, schema::title, this, locale);
-		resolveProperty(schema::getDescription, schema::description, this, locale);
-
-		Map<String, Schema> properties = schema.getProperties();
-		if (!CollectionUtils.isEmpty(properties)) {
-			LinkedHashMap<String, Schema> resolvedSchemas = properties.entrySet().stream().map(es -> {
-				es.setValue(resolveProperties(es.getValue(), locale));
-				return es;
-			}).collect(Collectors.toMap(Entry::getKey, Entry::getValue, (e1, e2) -> e2,
-					LinkedHashMap::new));
-			schema.setProperties(resolvedSchemas);
-		}
-
-		return schema;
-	}
-
-	/**
-	 * Resolve property.
-	 *
-	 * @param getProperty the get property
-	 * @param setProperty the set property
-	 * @param propertyResolverUtils the property resolver utils
-	 * @param locale the locale
-	 */
-	private void resolveProperty(Supplier<String> getProperty, Consumer<String> setProperty,
-			PropertyResolverUtils propertyResolverUtils, Locale locale) {
-		String value = getProperty.get();
-		if (StringUtils.isNotBlank(value)) {
-			setProperty.accept(propertyResolverUtils.resolve(value, locale));
-		}
-	}
-
 	/**
 	 * Gets factory.
 	 *

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app164/SampleResponseClass.java

@@ -24,6 +24,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;
@@ -34,6 +39,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;
 	}

springdoc-openapi-starter-webmvc-api/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

springdoc-openapi-starter-webmvc-api/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"
+            }
           }
         }
       }
     }
   }
-}
+}