Skip to content
GitLab

[BUG][PYTHON] Do not set Content-Type for GET, HEAD or DELETE requests

Merged Administrator requested to merge github/fork/johnboyes/python-fix-content-type-bug into master

Created by: johnboyes

This commit ensures that the Python generator no longer sets a default Content-Type ofapplication/json for GET, HEAD and DELETE requests.

Fixes #9831 (closed)

Related issues/PRs: #476, #1061, #5941, #6167

Having the Content-Type set for these requests was causing issues with other tools which insist that GET, HEAD and DELETE requests do not have a Content-Type (as per the OpenAPI 3 specification).

An example of the problem that this commit fixes is when using Prism as a validation proxy.

Prism rejects any GET request that has a Content-Type.

Here is an example of the problem manifesting itself.

To validate the fix in this commit:

  1. Start with any OpenAPI3 spec e.g. the Petstore example at https://editor.swagger.io/
  2. Generate Python client code for the spec
  3. Look at the generated rest.py e.g. in the standard sample in this repo and see that the Content-Type defaults to application/json for all HTTP methods (including GET, HEAD and DELETE), rather than there being no Content-Type for GET, HEAD and DELETE.

cc @taxpon, @frol, @mbohlool, @cbornet, @kenjones-cisco, @tomplus, @Jyhess, @arun-nalla, @spacether

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package 
./bin/generate-samples.sh
./bin/utils/export_docs_generators.sh
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.