plangrid / flask-rebar

Flask-Rebar combines flask, marshmallow, and swagger for robust REST services.
MIT License
231 stars 38 forks source link

ACSBP-3718 Update to use openapi 3.1 #284

Closed auramix closed 1 year ago

auramix commented 1 year ago
These changes represent updating to use OpenApi 3.1, which will represent a major version bump for flask-rebar due to OpenApi's move away from semver in 3.1 and introduction of breaking changes. For a complete list of changes effecting our implementation of a v3 Generator, please see the attached ticket. JIRA Tickets
ACSBP-3718
gtmanfred commented 1 year ago

Looks like we still need to validate the new swaggerui code here? https://github.com/plangrid/flask-rebar/tree/master/flask_rebar/swagger_ui

auramix commented 1 year ago

Looks like we still need to validate the new swaggerui code here? https://github.com/plangrid/flask-rebar/tree/master/flask_rebar/swagger_ui

I could use a little context on that, as I'm not 100% clear on the function the swagger_ui directory serves. It appears to be home to static assets for generating a ui template that services can use to serve their swagger spec? I thought maybe you meant I should regenerate these static files, but after trying to create a blueprint with the provided function that didn't do what I expected.

gtmanfred commented 1 year ago

No, we just need to grab them from the dist directory in this release, and see if it can load correctly the swagger 3.1 artifacts https://github.com/swagger-api/swagger-ui/releases/tag/v5.0.0-alpha.13

gtmanfred commented 1 year ago

Here is a link to them in github https://github.com/swagger-api/swagger-ui/tree/v5.0.0-alpha.13/dist

gtmanfred commented 1 year ago

basically, the swagger-ui files vendored in flask-rebar right now haven't been updated in 5 years, we just need to update and vendor the new ones.

plangrid-chorus[bot] commented 1 year ago

Chorus detected one or more security issues with this pull request. See the Checks tab for more details.

As a reminder, please follow the secure code review process as part of the Secure Coding Non-Negotiable requirement.

gtmanfred commented 1 year ago

I think we are still in the alpha release stages right?