Skip to content

Commit bd55ac7

Browse files
committed
Wrong Parameter Name with Default Sort. Fixes #1010.
1 parent b52f491 commit bd55ac7

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/customisers/DataRestDelegatingMethodParameterCustomizer.java

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ public DataRestDelegatingMethodParameterCustomizer(Optional<SpringDataWebPropert
6262
@Override
6363
public void customize(MethodParameter originalParameter, MethodParameter methodParameter) {
6464
PageableDefault pageableDefault = originalParameter.getParameterAnnotation(PageableDefault.class);
65-
if (pageableDefault != null || (org.springframework.data.domain.Pageable.class.isAssignableFrom(originalParameter.getParameterType()) && (optionalSpringDataWebProperties.isPresent() || optionalRepositoryRestConfiguration.isPresent())))
66-
{
65+
if (pageableDefault != null || (org.springframework.data.domain.Pageable.class.isAssignableFrom(originalParameter.getParameterType()) && (optionalSpringDataWebProperties.isPresent() || optionalRepositoryRestConfiguration.isPresent()))) {
6766
Field field = FieldUtils.getDeclaredField(DelegatingMethodParameter.class, "additionalParameterAnnotations", true);
6867
try {
6968
Annotation[] parameterAnnotations = (Annotation[]) field.get(methodParameter);
@@ -100,7 +99,7 @@ public Class<? extends Annotation> annotationType() {
10099

101100
@Override
102101
public String name() {
103-
return getName(parameterName, pageableDefault, parameter.name());
102+
return getName(parameterName, parameter.name());
104103
}
105104

106105
@Override
@@ -390,11 +389,10 @@ public String ref() {
390389
* Gets name.
391390
*
392391
* @param parameterName the parameter name
393-
* @param pageableDefault the pageable default
394392
* @param originalName the original name
395393
* @return the name
396394
*/
397-
private String getName(String parameterName, PageableDefault pageableDefault, String originalName) {
395+
private String getName(String parameterName , String originalName) {
398396
String name = null;
399397
switch (parameterName) {
400398
case "size":
@@ -406,9 +404,7 @@ else if (optionalSpringDataWebProperties.isPresent())
406404
name = originalName;
407405
break;
408406
case "sort":
409-
if (pageableDefault != null && ArrayUtils.isNotEmpty(pageableDefault.sort()))
410-
name = String.join(",", pageableDefault.sort());
411-
else if (optionalRepositoryRestConfiguration.isPresent())
407+
if (optionalRepositoryRestConfiguration.isPresent())
412408
name = optionalRepositoryRestConfiguration.get().getSortParamName();
413409
else if (optionalSpringDataWebProperties.isPresent())
414410
name = optionalSpringDataWebProperties.get().getSort().getSortParameter();

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
}
4242
},
4343
{
44-
"name": "name",
44+
"name": "sort",
4545
"in": "query",
4646
"description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
4747
"required": false,

0 commit comments

Comments
 (0)