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.

Sign up for GitHub

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

Jump to bottom

control-service: migrate from springfox to springdocs #1424

Merged
merged 22 commits into from
Dec 12, 2022
Merged

control-service: migrate from springfox to springdocs #1424

merged 22 commits into from
Dec 12, 2022

Conversation

murphp15
Copy link
Collaborator

@murphp15 murphp15 commented Dec 8, 2022 •
edited
Loading

Why?

As described in the ticket(#1414) springfox is making it impossible to upgrade most of our dependencies.

What?

Migrate from springfox to springdocs

How was this tested?

Integration tests, unit tests and also I opened the swagger endpoint and it all looks correct

2 very small changes:

  1. When providing auth details to swagger now you provide just the token.
    Where as before hand you needed to provide 'Bearer '
  2. Responses aren't included for 'obvious' responses 404,401,403,500 etc. previously the information we were returning was useless. e,g. for 404 the comment was not found.

closes #1414

@murphp15 murphp15 marked this pull request as draft December 8, 2022 15:58
@murphp15 murphp15 changed the title [draft] migrate from springfox to springdocs Control-service migrate from springfox to springdocs Dec 8, 2022
@murphp15 murphp15 changed the title Control-service migrate from springfox to springdocs control-service migrate from springfox to springdocs Dec 8, 2022
@murphp15 murphp15 marked this pull request as ready for review December 8, 2022 16:44
@murphp15 murphp15 changed the title control-service migrate from springfox to springdocs control-service: migrate from springfox to springdocs Dec 8, 2022
@antoniivanov
Copy link
Collaborator

I opened the swagger endpoint and it all looks correct

Can you please make a screenshot and upload it in test done So that review can verify as well.

antoniivanov
antoniivanov approved these changes Dec 11, 2022
View reviewed changes
Copy link
Collaborator

@antoniivanov antoniivanov left a comment

Choose a reason for hiding this comment

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

Thanks for taking this. I've been wanting to upgrade swagger for some time.

@murphp15
Copy link
Collaborator Author

New screens:
Screenshot 2022-12-12 at 13 37 53
Screenshot 2022-12-12 at 13 38 18
Screenshot 2022-12-12 at 13 38 46

Old screens:
Screenshot 2022-12-12 at 13 42 01
Screenshot 2022-12-12 at 13 42 19
Screenshot 2022-12-12 at 13 42 34

@murphp15
Copy link
Collaborator Author

There are two template files added that will be deleted in the future when a newer version of openapi generator is released.

@mivanov1988
Copy link
Collaborator

Good job!

@murphp15 murphp15 merged commit 97e713c into main Dec 12, 2022
@murphp15 murphp15 deleted the person/murphp15/springfox_upgrade branch December 12, 2022 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@antoniivanov antoniivanov antoniivanov approved these changes

@mivanov1988 mivanov1988 mivanov1988 approved these changes

Assignees
No one assigned
Labels
cla-not-required
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Migrate from springfox to springdocs
4 participants
@murphp15 @antoniivanov @mivanov1988 @vmwclabot