Redunant(wrong) direction appended to @PageableDefault. Fixes #2152

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/customizers/DataRestDelegatingMethodParameterCustomizer.java

@@ -24,10 +24,12 @@
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Field;
-import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import io.swagger.v3.core.util.ObjectMapperFactory;
@@ -805,11 +807,7 @@ private String getArrayDefaultValue(String parameterName, PageableDefault pageab
 		if ("sort".equals(parameterName)) {
 			DefaultSort defaultSort = getDefaultSort(pageableDefault, sortDefault);
 			if (defaultSort != null && ArrayUtils.isNotEmpty(defaultSort.properties)) {
-				List<String> sortValues = new ArrayList<>();
-				for (String sortValue : defaultSort.properties) {
-					String sortStr = String.join(",", sortValue, defaultSort.direction.name());
-					sortValues.add(sortStr);
-				}
+				final List<String> sortValues = defaultSort.getEffectiveProperties();
 				try {
 					defaultValue = ObjectMapperFactory.buildStrictGenericObjectMapper().writeValueAsString(sortValues);
 				}
@@ -881,6 +879,13 @@ private boolean isRepositoryRestConfigurationPresent() {
 	}
 
 	private static class DefaultSort {
+
+		private static final String DIRECTION_GROUP = Arrays.stream(Sort.Direction.values()).map(Enum::name).collect(Collectors.joining("|"));
+
+		private static final String DIRECTED_REGEXP = "\\w+(\\.\\w+)*,\\s*(" + DIRECTION_GROUP + ')';
+
+		private static final Pattern DIRECTED_PATTERN = Pattern.compile(DIRECTED_REGEXP, Pattern.CASE_INSENSITIVE);
+
 		private final Sort.Direction direction;
 
 		private final String[] properties;
@@ -889,5 +894,16 @@ private static class DefaultSort {
 			this.direction = direction;
 			this.properties = properties;
 		}
+
+		List<String> getEffectiveProperties() {
+			return Arrays.stream(properties)
+					.map(p -> {
+						if (DIRECTED_PATTERN.matcher(p).matches()) {
+							return p;
+						}
+						return p + ',' + direction.name();
+					})
+					.collect(Collectors.toList());
+		}
 	}
-}
+}

springdoc-openapi-tests/springdoc-openapi-data-rest-tests/src/test/java/test/org/springdoc/api/app13/HelloController.java

@@ -57,4 +57,20 @@ public String getPatientList3(@PageableDefault(size = 100)
 	@ParameterObject Pageable pageable) {
 		return "bla";
 	}
+
+	@GetMapping("/test4")
+	public String getPatientList4(@PageableDefault(100)
+	@ParameterObject Pageable pageable) {
+		return "bla";
+	}
+
+	@GetMapping("/test5")
+	public void read(
+			@PageableDefault(sort = {
+					"some,desc",
+					"other,asc",
+					"another.that,desc"
+			})
+			@ParameterObject final Pageable pageable) {
+	}
 }

springdoc-openapi-tests/springdoc-openapi-data-rest-tests/src/test/resources/results/app13.json

@@ -11,6 +11,116 @@
     }
   ],
   "paths": {
+    "/test5": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "read",
+        "parameters": [
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Zero-based page index (0..N)",
+            "required": false,
+            "schema": {
+              "minimum": 0,
+              "type": "integer",
+              "default": 0
+            }
+          },
+          {
+            "name": "size",
+            "in": "query",
+            "description": "The size of the page to be returned",
+            "required": false,
+            "schema": {
+              "minimum": 1,
+              "type": "integer",
+              "default": 10
+            }
+          },
+          {
+            "name": "sort",
+            "in": "query",
+            "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+            "required": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "default": [
+                "some,desc",
+                "other,asc",
+                "another.that,desc"
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/test4": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "getPatientList4",
+        "parameters": [
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Zero-based page index (0..N)",
+            "required": false,
+            "schema": {
+              "minimum": 0,
+              "type": "integer",
+              "default": 0
+            }
+          },
+          {
+            "name": "size",
+            "in": "query",
+            "description": "The size of the page to be returned",
+            "required": false,
+            "schema": {
+              "minimum": 1,
+              "type": "integer",
+              "default": 100
+            }
+          },
+          {
+            "name": "sort",
+            "in": "query",
+            "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+            "required": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/hal+json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/test3": {
       "get": {
         "tags": [