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.

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

Support Pagination for v1/finding/project/{uuid} #4677

Open
2 tasks done
ybelMekk opened this issue Feb 20, 2025 · 2 comments
Open
2 tasks done

Support Pagination for v1/finding/project/{uuid} #4677

ybelMekk opened this issue Feb 20, 2025 · 2 comments
Labels
enhancement New feature or request p2 Non-critical bugs, and features that help organizations to identify and reduce risk performance size/S Small effort

Comments

@ybelMekk
Copy link
Contributor

ybelMekk commented Feb 20, 2025

Current Behavior

Hi team,

First off, thanks for all the great work on Dependency-Track! It's an amazing tool, and I truly appreciate the effort that goes into making it better with each release.

I was wondering if there are any plans to support pagination for the v1/finding/project/{uuid} endpoint. Some of my projects have 4,000+ vulnerabilities, and since I primarily use the API rather than the frontend, fetching all findings at once can be extremely slow—sometimes even unresponsive.

I saw this discussion: #3811 but am still waiting for version 4.13 (as referenced in #4352).

Given that Dependency-Track is positioned as an API-first platform, adding this functionality would greatly enhance its usability for large-scale projects.

Proposed Behavior

To improve performance and usability, I propose implementing pagination for this endpoint, similar to how it’s done in other paginated API responses.

  • Limit and offset parameters or headers?

This change would greatly improve response times and reliability, especially for users dealing with large projects.

Thanks again for all your hard work. 🚀

Best,

Youssef

Checklist

@ybelMekk ybelMekk added the enhancement New feature or request label Feb 20, 2025
@ybelMekk ybelMekk changed the title Support Pagination for api/v1/findings/{projectId} Support Pagination for v1/finding/project/{uuid} Feb 20, 2025
@nscuro nscuro added p2 Non-critical bugs, and features that help organizations to identify and reduce risk performance size/S Small effort labels Feb 20, 2025
@nscuro
Copy link
Member

nscuro commented Feb 20, 2025

Fully agree, and yes this is planned.

Need to be cautious though, as existing integrations will rely on the fact that all findings are returned in a single request at the moment. If we simply change the endpoint to be paginated, it can break those integrations.

@stohrendorf
Copy link
Contributor

I have a client app relying on that the result is not paginated. This would introduce a breaking change for me, implicitly breaking important functionality. There are two options I see here:

  • introduce a new REST endpoint with a different path supporting pagination - this would allow for a migration without changing client apps and breaking behaviour, and it would be IMHO most transparent
  • add dependent behaviour - like passing an HTTP header or an additional URL parameter which would enable pagination, but this would add behaviour that would silently break client apps if devs don't read the changelogs (which, in my own experience, is very likely)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request p2 Non-critical bugs, and features that help organizations to identify and reduce risk performance size/S Small effort
Projects
None yet
Development

No branches or pull requests

3 participants