OpenAPITools / OpenAPITools/openapi-generator
[BUG] [Python] [Documentation] Incorrect supported library listed in Documentation for the python Generator
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator (example)?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
The generated documentation in https://openapi-generator.tech/docs/generators/python/ is incorrect. In the documentation, it is listed that the library supports library template (sub-template) to use: asyncio, tornado, urllib3. However, the generator only supports urllib3 (https://github.com/OpenAPITools/openapi-generator/blob/fea42b547ed61dcfdfc479cab6f68a601ec5adde/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonClientCodegen.java#L202).
openapi-generator version
OpenAPI declaration file content or url
Generation Details
Steps to reproduce
Related issues/PRs
Suggest a fix
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
Start with the Python generator documentation at openapi-generator.tech/docs/generators/python/ and compare its listed library templates with PythonClientCodegen.java, linked in the issue. Update the documentation so the supported-library list matches the generator, with urllib3 as the listed option, then verify the rendered page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100