apply 'springdoc.trim-kotlin-indent' to schema annotation properties

Author: e-build

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

@@ -69,6 +69,7 @@
 import io.swagger.v3.oas.models.PathItem.HttpMethod;
 import io.swagger.v3.oas.models.Paths;
 import io.swagger.v3.oas.models.SpecVersion;
+import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.media.StringSchema;
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.responses.ApiResponses;
@@ -100,6 +101,7 @@
 import org.springdoc.core.service.GenericResponseService;
 import org.springdoc.core.service.OpenAPIService;
 import org.springdoc.core.service.OperationService;
+import org.springdoc.core.utils.PropertyResolverUtils;
 import org.springdoc.core.utils.SpringDocUtils;
 
 import org.springframework.aop.support.AopUtils;
@@ -352,6 +354,9 @@ protected OpenAPI getOpenApi(Locale locale) {
 				}
 				getPaths(mappingsMap, finalLocale, openAPI);
 
+				if (springDocConfigProperties.isTrimKotlinIndent())
+					this.trimIndent(openAPI);
+
 				Optional<CloudFunctionProvider> cloudFunctionProviderOptional = springDocProviders.getSpringCloudFunctionProvider();
 				cloudFunctionProviderOptional.ifPresent(cloudFunctionProvider -> {
 							List<RouterOperation> routerOperationList = cloudFunctionProvider.getRouterOperations(openAPI);
@@ -384,7 +389,6 @@ protected OpenAPI getOpenApi(Locale locale) {
 				if (!CollectionUtils.isEmpty(openAPI.getServers()) && !openAPI.getServers().equals(serversCopy))
 					openAPIService.setServersPresent(true);
 
-
 				openAPIService.setCachedOpenAPI(openAPI, finalLocale);
 
 				LOGGER.info("Init duration for springdoc-openapi is: {} ms",
@@ -396,12 +400,62 @@ protected OpenAPI getOpenApi(Locale locale) {
 				openAPIService.updateServers(openAPI);
 			}
 			openAPIService.updateServers(openAPI);
-			return openAPI;		}
-		finally {
+			return openAPI;
+		} finally {
 			this.reentrantLock.unlock();
 		}
 	}
 
+	private void trimIndent(OpenAPI openAPI) {
+		trimComponents(openAPI);
+		trimPaths(openAPI);
+	}
+
+	private void trimComponents(OpenAPI openAPI) {
+		final PropertyResolverUtils propertyResolverUtils = operationParser.getPropertyResolverUtils();
+		if (openAPI.getComponents() == null || openAPI.getComponents().getSchemas() == null) {
+			return;
+		}
+		for (Schema<?> schema : openAPI.getComponents().getSchemas().values()) {
+			schema.description(propertyResolverUtils.trimIndent(schema.getDescription()));
+			if (schema.getProperties() == null) {
+				continue;
+			}
+			for (Object prop : schema.getProperties().values()) {
+				if (prop instanceof Schema<?> schemaProp) {
+					schemaProp.setDescription(propertyResolverUtils.trimIndent(schemaProp.getDescription()));
+				}
+			}
+		}
+	}
+
+	private void trimPaths(OpenAPI openAPI) {
+		final PropertyResolverUtils propertyResolverUtils = operationParser.getPropertyResolverUtils();
+		if (openAPI.getPaths() == null) {
+			return;
+		}
+		for (PathItem value : openAPI.getPaths().values()) {
+			value.setDescription(propertyResolverUtils.trimIndent(value.getDescription()));
+			trimIndentOperation(value.getGet());
+			trimIndentOperation(value.getPut());
+			trimIndentOperation(value.getPost());
+			trimIndentOperation(value.getDelete());
+			trimIndentOperation(value.getOptions());
+			trimIndentOperation(value.getHead());
+			trimIndentOperation(value.getPatch());
+			trimIndentOperation(value.getTrace());
+		}
+	}
+
+	private void trimIndentOperation(Operation operation) {
+		final PropertyResolverUtils propertyResolverUtils = operationParser.getPropertyResolverUtils();
+		if (operation == null) {
+			return;
+		}
+		operation.setSummary(propertyResolverUtils.trimIndent(operation.getSummary()));
+		operation.setDescription(propertyResolverUtils.trimIndent(operation.getDescription()));
+	}
+
 	/**
 	 * Gets paths.
 	 *

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

@@ -646,4 +646,12 @@ public Operation mergeOperation(Operation operation, Operation operationModel) {
 	public JavadocProvider getJavadocProvider() {
 		return parameterBuilder.getJavadocProvider();
 	}
+
+	/**
+	 * Gets propertyResolverUtils
+	 * @return propertyResolverUtils
+	 */
+	public PropertyResolverUtils getPropertyResolverUtils(){
+		return parameterBuilder.getPropertyResolverUtils();
+	}
 }

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

@@ -99,9 +99,6 @@ public String resolve(String parameterProperty, Locale locale) {
 				}
 			if (parameterProperty.equals(result))
 				try {
-                    if (springDocConfigProperties.isTrimKotlinIndent()) {
-                        parameterProperty = trimIndent(parameterProperty);
-                    }
 					result = factory.resolveEmbeddedValue(parameterProperty);
 				}
 				catch (IllegalArgumentException ex) {
@@ -119,18 +116,23 @@ public String resolve(String parameterProperty, Locale locale) {
 	 * @param text The original string with possible leading indentation.
 	 * @return The string with leading indentation removed from each line.
 	 */
-    private String trimIndent(String text) {
-		if (text == null) {
-			return null;
+	public String trimIndent(String text) {
+		try {
+			if (text == null) {
+				return null;
+			}
+			final String newLine = "\n";
+			String[] lines = text.split(newLine);
+			int minIndent = resolveMinIndent(lines);
+			return Arrays.stream(lines)
+				.map(line -> line.substring(Math.min(line.length(), minIndent)))
+				.reduce((a, b) -> a + newLine + b)
+				.orElse(StringUtils.EMPTY);
+		} catch (Exception ex){
+			LOGGER.warn(ex.getMessage());
+			return text;
 		}
-		final String newLine = "\n";
-		String[] lines = text.split(newLine);
-		int minIndent = resolveMinIndent(lines);
-        return Arrays.stream(lines)
-            .map(line -> line.substring(Math.min(line.length(), minIndent)))
-            .reduce((a, b) -> a + newLine + b)
-            .orElse(StringUtils.EMPTY);
-    }
+	}
 
 	private int resolveMinIndent(String[] lines) {
 		return Arrays.stream(lines)
@@ -222,4 +224,4 @@ public Map<String, Object> resolveExtensions(Locale locale, Map<String, Object>
 		else
 			return extensions;
 	}
-}
+}