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

Support OpenAPI v2 basePath #156

Open
twosigmajab opened this issue Jan 29, 2020 · 0 comments
Open

Support OpenAPI v2 basePath #156

twosigmajab opened this issue Jan 29, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@twosigmajab
Copy link
Contributor

twosigmajab commented Jan 29, 2020 •
edited
Loading

Flask-Rebar's support for OAIv3 servers is great, but unfortunately we're stuck on OAIv2 for the time being.

Currently, our Flask-Rebar-generated OAIv2 specs are not getting any basePath specified by default, and it doesn't seem possible for us to specify one.

One thing this could be immediately useful for is reducing the duplication across the generated endpoints in the spec, which currently all repeat the api_prefix at the beginning of every path.

What do you think of allowing SwaggerV2Generator to support setting a custom basePath, and also allowing users to turn off duplication of the api_prefix in each path?

This would enable Flask-Rebar's generated specs to better match those of alternative implementations of OAIv2 spec generation. (Specifically, one we interoperate with that's written in Java, using Swagger annotations.)
@Sytten Sytten added the enhancement New feature or request label Feb 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Sytten @twosigmajab