Skip to content

Document pagination support for findings REST endpoint #1739

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

Merged
sahibamittal merged 1 commit into from
Apr 3, 2025
Merged

Document pagination support for findings REST endpoint #1739

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion docs/getting-started/changes-over-v4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,7 @@ and vulnerability analysis is performed by services separately from the API serv
* The Findings response object's `vulnerability` will no longer contain two fields below, `cwes` will hold the respective ids.
* `cweId`
* `cweName`
* In the SARIF file (schema defined in [sarif.peb]), `cweId` will be replaced by list of cwe ids in `cwes`. And name of the SARIF rule will be vulnerability's `vulnId` instead of `cweName`.
* In the SARIF file (schema defined in [sarif.peb]), `cweId` will be replaced by list of cwe ids in `cwes`. And name of the SARIF rule will be vulnerability's `vulnId` instead of `cweName`.
* The `/api/v1/finding/project/{uuid}` REST API endpoint now supports pagination
[apiserver/#1111](https://github.com/DependencyTrack/hyades-apiserver/pull/1111). The page size defaults to `100`.
Clients currently expecting *all* items to be returned at once must be updated to deal with pagination.
Loading