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

OpenAPI spec fixes and improvements #3557

Merged
merged 5 commits into from
Mar 17, 2024

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented Mar 17, 2024

Description

  • Removes unused usedBy property from Component model
  • Hides internal, transient properties from Component for OpenAPI spec
  • Adds OpenAPI notification tag to Notification*Resource classes
  • Renames OsvEcosystemResource to IntegrationResource, and changes OpenAPI tag from ecosystems to integration
  • Adds required permissions to OpenAPI descriptions of endpoints (by @a5a351e7 via fixes #3113 #3504)
  • Adds more example values to fields of request objects
  • Fixes bom and vex fields not being visible in OpenAPI spec

Addressed Issue

Fixes #3113
Fixes #3528
Closes #3504

Additional Details

N/A

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 and others added 4 commits March 17, 2024 15:49
…es from OpenAPI

Signed-off-by: nscuro <nscuro@protonmail.com>
Previously, these endpoints were listed under `default` in the OpenAPI spec.

Signed-off-by: nscuro <nscuro@protonmail.com>
Signed-off-by: nscuro <nscuro@protonmail.com>
Fixes DependencyTrack#3113
Closes DependencyTrack#3504

Co-authored-by: Florian <a5a351e7@users.noreply.github.com>
Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro added defect Something isn't working enhancement New feature or request api docs labels Mar 17, 2024
@nscuro nscuro added this to the 4.11 milestone Mar 17, 2024
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%) 100.00% (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (4356d02) 21523 15942 74.07%
Head commit (753924d) 21517 (-6) 15938 (-4) 74.07% (+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 (#3557) 1 1 100.00%

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 cde65d8 into DependencyTrack:master Mar 17, 2024
12 checks passed
@nscuro nscuro deleted the openapi-fixes branch March 17, 2024 17:34
@nscuro nscuro mentioned this pull request Mar 17, 2024
5 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api docs defect Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

swagger.json reports wrong field name for /vex Add information of necessary permissions to swagger
1 participant