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

Fix type of purl fields in Swagger docs #3512

Merged
merged 1 commit into from
Mar 4, 2024

Conversation

sebD
Copy link
Contributor

@sebD sebD commented Feb 29, 2024

Description

Adds a custom deserializer for pURL properties of Project and Component objects. This deserializer allows to describe pURL either as text value or object value in JSON payloads to better conform to the swagger api definitions.

Addressed Issue

Fixes: #3509

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
Copy link
Member

nscuro commented Mar 3, 2024

Thanks for the PR @sebD. However, I don't believe we should fix the issue this way, see #3509 (comment).

Are you happy to revise this PR to apply the suggested change instead? Otherwise please let me know, and I'll raise a separate PR.

Copy link

codacy-production bot commented Mar 3, 2024

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 (8b23434) 21360 15775 73.85%
Head commit (54df0dd) 21360 (+0) 15775 (+0) 73.85% (+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 (#3512) 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

… force string type in swagger definitions.

Signed-off-by: Sebastien Delcoigne <sebastien.delcoigne@gmail.com>
@nscuro nscuro added defect Something isn't working api docs labels Mar 4, 2024
@nscuro nscuro added this to the 4.11 milestone Mar 4, 2024
@nscuro nscuro changed the title 3509 purl object form Fix type of purl fields in Swagger docs Mar 4, 2024
Copy link
Member

@nscuro nscuro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@nscuro nscuro merged commit 788be8c into DependencyTrack:master Mar 4, 2024
12 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 4, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API Patch Project endpoint silently ignore purl value in object form
2 participants