Skip to content

Conversation

@fasblom
Copy link

@fasblom fasblom commented Feb 5, 2024

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

linux-foundation-easycla bot commented Feb 5, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@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

Labels

None yet

Projects

None yet

2 participants