openapi-generators / openapi-generators/openapi-python-client
Quotes in Content-Type cause syntax errors
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2k
- Forks
- 293
- Avg merge
- 34m
- Merged PRs (30d)
- 1
Description
Describe the bug
Running openapi-python-client generate --path api.yml on the input file below fails with:
Generating /tmp/example-client
Error(s) encountered while generating, client was not created
ruff failed
example_client/api/default/put_object.py:34:62: SyntaxError: Simple statements must be separated by newlines or semicolons
|
33 | _kwargs["json"] = _body
34 | headers["Content-Type"] = "application/ld+json; profile="https://www.w3.org/ns/activitystreams""
| ^
35 |
36 | _kwargs["headers"] = headers
|
[...]
Quotes in the Content-Type should be escaped so that the generated result is legal Python code.
OpenAPI Spec File
openapi: "3.0.0"
info:
version: 0.0.1
title: example
paths:
/object:
put:
requestBody:
content:
"application/ld+json; profile=\"https://www.w3.org/ns/activitystreams\"":
schema:
type: string
responses:
'200':
description: OK
Desktop (please complete the following information):
- OS: Debian 13
- Python Version: 3.12.11
- openapi-python-client version: 0.24.3
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the failure with openapi-python-client generate --path api.yml using the OpenAPI example in the issue, then trace where the Content-Type value becomes the generated headers assignment. Done means quoted Content-Type parameters produce legal Python and generation completes without the reported Ruff syntax error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100