Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include sorting query parameters in OpenAPI spec #3631

Merged
merged 2 commits into from
Apr 21, 2024
Merged

Include sorting query parameters in OpenAPI spec #3631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed5d37a
Include sorting query parameters in OpenAPI spec
nscuro Apr 21, 2024
7840ca3
Remove default values from `offset` and `limit` in OpenAPI spec
nscuro Apr 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/_posts/2024-xx-xx-v4.11.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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
Expand Down
15 changes: 13 additions & 2 deletions src/main/java/org/dependencytrack/resources/v1/openapi/PaginatedApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>limit</code>."
),
@ApiImplicitParam(
name = "limit",
dataType = "int",
paramType = "query",
defaultValue = "100",
value = "Number of elements to return per page. To be used in conjunction with <code>offset</code>."
),
@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 <code>sortName</code>."
)
})
public @interface PaginatedApi {
Expand Down