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

Openapi3 upgrade #84

Open
wants to merge 20 commits into
base: master
Choose a base branch
from
Open

Openapi3 upgrade #84

wants to merge 20 commits into from

Conversation

fasblom
Copy link

@fasblom fasblom commented Feb 5, 2024 •
edited
Loading

Background of the PR:

  • Upgrade the dependency of the swagger-ui from 2.1.4 -> 5.11.1 as the previous package is old and with security issues
  • As a consequence implemented the OpenAPI 3 specification instead of OpenAPI 2

Consequences:

  • Updated outdated packages
  • Updated swagger.js to follow OpenAPI 3 specification
  • Removed outdated fields like produces, consumes from swagger.js and swagger-html
  • Updated way of generating the Swagger-HTML site based on swagger-iu

Some comments:

  • The full OpenAPI 3 spec is not implemented - but the core concepts that are in line with what has been implemented as per the previous release

Resolves #83 , Resolves #82 , Resolves #74 , Resolves #51

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Feb 5, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@fasblom fasblom mentioned this pull request Feb 5, 2024
Open
@fasblom
Copy link
Author

fasblom commented Feb 22, 2024

@knolleary - Have you had a chance to look at this PR for updating Swagger?

@knolleary
Copy link
Member

I have not looked. I do not actively use this node, but I will try to review it soon.

I suspect changing the format of the spec it generates warrants a major version bump as it could be considered a breaking change.

@fasblom
Copy link
Author

fasblom commented Apr 3, 2024

Major version bump sounds reasonable as it changes quite a lot given the new OpenAPI-spec. Have you had a chance to look at it yet @knolleary ? Kind regards

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@fasblom @knolleary