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 sorting query parameters in OpenAPI spec #3631

Merged
merged 2 commits into from
Apr 21, 2024

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented Apr 21, 2024

Description

Includes sorting query parameters in OpenAPI spec.

These parameters are handled implicitly by Alpine and as such are not directly documented in the Dependency-Track code base.

The sortName and sortOrder parameters are now included in the OpenAPI spec for all endpoints that support them.

Addressed Issue

N/A

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

These parameters are handled implicitly by Alpine and as such are not directly documented in the Dependency-Track codebase.

The `sortName` and `sortOrder` parameters are now included in the OpenAPI spec for all endpoints that support them.

Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro added enhancement New feature or request api docs labels Apr 21, 2024
@nscuro nscuro added this to the 4.11 milestone Apr 21, 2024
Copy link

codacy-production bot commented Apr 21, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
-0.01% (target: -1.00%) (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (8e44ee5) 21979 16459 74.89%
Head commit (7840ca3) 21979 (+0) 16456 (-3) 74.87% (-0.01%)

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

Codacy will stop sending the deprecated coverage status from June 5th, 2024. Learn more

Including default values for both `pageNumber`/`pageSize` and `offset`/`limit` causes the request generated by Swagger UI to use them all, which is confusing.

Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro merged commit 85e770a into DependencyTrack:master Apr 21, 2024
12 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 22, 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