Skip to content
GitLab

[Python][Flask] pythonic params

Merged Administrator requested to merge github/fork/tomghyselinck/python-flask-pythonic_params into master

Created by: tomghyselinck

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh, ./bin/security/{LANG}-petstore.sh and ./bin/openapi3/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language. -- @wing328 @taxpon @frol @mbohlool @cbornet @kenjones-cisco @tomplus @Jyhess

Description of the PR

We have an OpenAPI spec file with camelCase (query and path) parameters. When generating a Python (connexion-based) server those parameters are converted to ("pythonic") snake_case parameters.

During generation of the supporting files there is also an OpenAPI spec file generated for use with connexion. This spec file does not match the original one regarding parameter names.

Especially when defining "query" parameters, the REST interface will be different than the one defined in the original OpenAPI spec file. Such (query) parameters are incompatible with generated clients (and other server implementations)

Fixes #1671 (closed)

We have been using this fix some time on a local checkout for generating python-flask server implementations without issues.

Notes

  1. This PR also updates the python-aiohttp but it is untested. Please feel free to try it out.

  2. These changes do not limit on query or path parameters and should also work on header and cookie parameters.