Skip to content

Document pagination support for findings REST endpoint#1739

Merged
sahibamittal merged 1 commit intomainfrom
issue-1708-document-findings-pagination
Apr 3, 2025
Merged

Document pagination support for findings REST endpoint#1739
sahibamittal merged 1 commit intomainfrom
issue-1708-document-findings-pagination

Conversation

@sahibamittal
Copy link
Collaborator

@sahibamittal sahibamittal commented Apr 2, 2025

Description

Pagination was already supported by findings REST endpoints /api/v1/finding and /api/v1/finding/grouped.
Now, it has been added to endpoint /api/v1/finding/project/{uuid} as well.

Document the same.

Addressed Issue

#1708
Backend : DependencyTrack/hyades-apiserver#1111

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have updated the migration changelog accordingly
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

@sahibamittal sahibamittal marked this pull request as ready for review April 2, 2025 09:57
@codacy-production
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+18.46% (target: -1.00%) (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (1c2bd72) 201 132 65.67%
Head commit (e265269) 7006 (+6805) 5894 (+5762) 84.13% (+18.46%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#1739) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

@nscuro nscuro added the documentation Improvements or additions to documentation label Apr 2, 2025
@nscuro nscuro added this to the 0.6.0 milestone Apr 2, 2025
@sahibamittal sahibamittal merged commit a389569 into main Apr 3, 2025
13 checks passed
@sahibamittal sahibamittal deleted the issue-1708-document-findings-pagination branch April 3, 2025 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants