ACSBP-3718 Update to use openapi 3.1 #284
Conversation
|
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. |
|
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 |
|
Here is a link to them in github https://github.com/swagger-api/swagger-ui/tree/v5.0.0-alpha.13/dist |
|
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. |
|
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. |
|
I think we are still in the alpha release stages right? |
| run the following from the root of the project. | ||
|
|
||
| .. code-block:: | ||
| curl -L https://api.github.com/repos/swagger-api/swagger-ui/tarball | tar -xv --directory=flask_rebar/swagger_ui/static --strip-components=2 "*/dist/" |
This reverts commit 8474029.
.flake8
Outdated
| select = B950 | ||
| extend-ignore = E501 |
There was a problem hiding this comment.
I don't have a problem with us switching to B950 instead of E501, but this change should be made in a separate PR.
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.