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

chore: added swagger types for BOM operations #2230

Merged
merged 1 commit into from
Dec 6, 2022

Conversation

omerlh
Copy link
Contributor

@omerlh omerlh commented Dec 4, 2022

Description

I was working on generating a typescript client using Swagger (happy to contribute the client also!) and I noticed some APIs does not have well defined responses.

Addressed Issue

Additional Details

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

I am not sure how I should test it, so happy to get some feedback on the change!

@omerlh omerlh force-pushed the chore/fix-swagger-types branch 2 times, most recently from 1460574 to 62e426b Compare December 4, 2022 08:24
@valentijnscholten
Copy link
Contributor

Can I suggest to submit a PR with only the changes you propose? Currently 90% seems to be only linting?

@omerlh
Copy link
Contributor Author

omerlh commented Dec 4, 2022

Yes, sorry - fixed. VS code did things I didn't noticed...

@omerlh omerlh force-pushed the chore/fix-swagger-types branch 5 times, most recently from acb2291 to edad8fb Compare December 4, 2022 11:16
@nscuro
Copy link
Member

nscuro commented Dec 4, 2022

You'll find lots of these inconsistencies, which is why I can't really recommend generating clients from the swagger doc. See #840.

@omerlh
Copy link
Contributor Author

omerlh commented Dec 5, 2022

I don't mind keep fixing it as I'm going, I have a client that works pretty well and generated from Swagger. If this is acceptable by you, OFC...

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.

I guess I'm fine with small incremental improvements until we have a better OpenAPI doc in place.

A few minor adjustments and clarifications.

@omerlh
Copy link
Contributor Author

omerlh commented Dec 6, 2022

I think the build failure are not related to my changes

@nscuro
Copy link
Member

nscuro commented Dec 6, 2022

@omerlh Sorry about that, #2241 should fix the build failure. If you rebase with master it should work again.

Signed-off-by: Omer Levi Hevroni <omer@goledge.com>
@omerlh
Copy link
Contributor Author

omerlh commented Dec 6, 2022

Ok, rebased

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 @omerlh! 🚀

@nscuro nscuro added this to the 4.7 milestone Dec 6, 2022
@nscuro nscuro added the enhancement New feature or request label Dec 6, 2022
@nscuro nscuro merged commit 15b2b20 into DependencyTrack:master Dec 6, 2022
mulder999 pushed a commit to mulder999/dependency-track that referenced this pull request Dec 23, 2022
Signed-off-by: Omer Levi Hevroni <omer@goledge.com>

Signed-off-by: Omer Levi Hevroni <omer@goledge.com>
Signed-off-by: mulder999 <nospam099-github@yahoo.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants