Description for Pageable parameters is not displayed in swagger-ui. Fixes #543.

Author: bnasslahsen

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/converters/Pageable.java

@@ -25,6 +25,7 @@
 import javax.validation.constraints.Min;
 import javax.validation.constraints.NotNull;
 
+import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.media.ArraySchema;
 import io.swagger.v3.oas.annotations.media.Schema;
 
@@ -33,20 +34,19 @@
 @NotNull
 public class Pageable {
 
-	@Nullable
 	@Min(0)
-	@Schema(description = "Zero-based page index (0..N)", defaultValue = "0")
+	@Parameter(description = "Zero-based page index (0..N)",schema = @Schema(type = "integer", defaultValue = "0"),required = true)
 	private Integer page;
 
-	@Nullable
 	@Min(1)
 	@Max(2000)
-	@Schema(description = "The size of the page to be returned", defaultValue = "20")
+	@Parameter(description = "The size of the page to be returned",schema = @Schema(type = "integer", defaultValue = "20"),required = true)
 	private Integer size;
 
-	@Nullable
-	@ArraySchema(arraySchema = @Schema(description = "Sorting criteria in the format: property(,asc|desc). "
-			+ "Default sort order is ascending. " + "Multiple sort criteria are supported."))
+	@Parameter(description = "Sorting criteria in the format: property(,asc|desc). "
+			+ "Default sort order is ascending. " + "Multiple sort criteria are supported."
+			, name = "sort"
+			,array = @ArraySchema(schema = @Schema(type = "string")),required = true)
 	private List<String> sort;
 
 	public Pageable(int page, int size, List<String> sort) {

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

@@ -56,26 +56,26 @@
   "components": {
     "schemas": {
       "Pageable": {
+        "required": [
+          "page",
+          "size",
+          "sort"
+        ],
         "type": "object",
         "properties": {
           "page": {
             "minimum": 0,
             "type": "integer",
-            "description": "Zero-based page index (0..N)",
-            "format": "int32",
-            "default": 0
+            "format": "int32"
           },
           "size": {
             "maximum": 2000,
             "minimum": 1,
             "type": "integer",
-            "description": "The size of the page to be returned",
-            "format": "int32",
-            "default": 20
+            "format": "int32"
           },
           "sort": {
             "type": "array",
-            "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
             "items": {
               "type": "string"
             }

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

@@ -21,35 +21,33 @@
           {
             "name": "page",
             "in": "query",
-            "required": false,
+            "description": "Zero-based page index (0..N)",
+            "required": true,
             "schema": {
               "minimum": 0,
               "type": "integer",
-              "description": "Zero-based page index (0..N)",
-              "format": "int32",
-              "default": 0
+              "default": "0"
             }
           },
           {
             "name": "size",
             "in": "query",
-            "required": false,
+            "description": "The size of the page to be returned",
+            "required": true,
             "schema": {
               "maximum": 2000,
               "minimum": 1,
               "type": "integer",
-              "description": "The size of the page to be returned",
-              "format": "int32",
-              "default": 20
+              "default": "20"
             }
           },
           {
             "name": "sort",
             "in": "query",
-            "required": false,
+            "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
+            "required": true,
             "schema": {
               "type": "array",
-              "description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
               "items": {
                 "type": "string"
               }