diff --git a/docs/_posts/2024-xx-xx-v4.11.0.md b/docs/_posts/2024-xx-xx-v4.11.0.md index 5bf59700a2..a771ca9976 100644 --- a/docs/_posts/2024-xx-xx-v4.11.0.md +++ b/docs/_posts/2024-xx-xx-v4.11.0.md @@ -69,6 +69,7 @@ Community input and contributions are highly requested. The chart repository can * Ingest vulnerability alias information from VulnDB - [apiserver/#3588] * Properly validate UUID request parameters to prevent internal server errors - [apiserver/#3590] * Document pagination query parameters in OpenAPI specification - [apiserver/#3625] +* Document sorting query parameters in OpenAPI specification - [apiserver/#3631] * Show component count in projects list - [frontend/#683] * Add current *fail*, *warn*, and *info* values to bottom of policy violation metrics - [frontend/#707] * Remove unused policy violation widget - [frontend/#710] @@ -233,6 +234,7 @@ Special thanks to everyone who contributed code to implement enhancements and fi [apiserver/#3590]: https://github.com/DependencyTrack/dependency-track/pull/3590 [apiserver/#3595]: https://github.com/DependencyTrack/dependency-track/pull/3595 [apiserver/#3625]: https://github.com/DependencyTrack/dependency-track/pull/3625 +[apiserver/#3631]: https://github.com/DependencyTrack/dependency-track/pull/3631 [frontend/#682]: https://github.com/DependencyTrack/frontend/pull/682 [frontend/#683]: https://github.com/DependencyTrack/frontend/pull/683 diff --git a/src/main/java/org/dependencytrack/resources/v1/openapi/PaginatedApi.java b/src/main/java/org/dependencytrack/resources/v1/openapi/PaginatedApi.java index 1dbf7249e0..64ea233efc 100644 --- a/src/main/java/org/dependencytrack/resources/v1/openapi/PaginatedApi.java +++ b/src/main/java/org/dependencytrack/resources/v1/openapi/PaginatedApi.java @@ -52,15 +52,26 @@ name = "offset", dataType = "int", paramType = "query", - defaultValue = "0", value = "Offset to start returning elements from. To be used in conjunction with limit." ), @ApiImplicitParam( name = "limit", dataType = "int", paramType = "query", - defaultValue = "100", value = "Number of elements to return per page. To be used in conjunction with offset." + ), + @ApiImplicitParam( + name = "sortName", + dataType = "string", + paramType = "query", + value = "Name of the resource field to sort on." + ), + @ApiImplicitParam( + name = "sortOrder", + dataType = "string", + paramType = "query", + allowableValues = "asc, desc", + value = "Ordering of items when sorting with sortName." ) }) public @interface PaginatedApi {