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

Include pagination parameters in OpenAPI spec #3625

Merged
merged 1 commit into from
Apr 17, 2024

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented Apr 17, 2024

Description

The query parameters for pagination (pageNumber, pageSize / offset, limit) were previously not included in the OpenAPI specification. This made it hard to work out how pagination works, and which endpoints support it.

This PR adds documentation for the mentioned parameters to all endpoints that support them.

Addressed Issue

Relates to #3608

Additional Details

image

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 added corresponding update logic
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

@nscuro nscuro added enhancement New feature or request api docs labels Apr 17, 2024
@nscuro nscuro added this to the 4.11 milestone Apr 17, 2024
Relates to DependencyTrack#3608

Signed-off-by: nscuro <nscuro@protonmail.com>
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%) (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (6583e2d) 21979 16459 74.89%
Head commit (d09d303) 21979 (+0) 16459 (+0) 74.89% (+0.00%)

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 (#3625) 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

You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation

@nscuro nscuro merged commit f520b83 into DependencyTrack:master Apr 17, 2024
12 checks passed
@nscuro nscuro deleted the openapi-pagination-params branch April 17, 2024 14:06
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api docs enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant