swagger-api / swagger-api/swagger-codegen

[Python] Incorrect case for true generated in docs

Open
#8,863 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

In the docs for the kubernetes python client, the .md files generated have the default True values written as true as can be seen here. This is not an issue with the .py files though. It should say True not true.

Swagger-codegen version

2.0

Swagger declaration file content or url

https://raw.githubusercontent.com/kubernetes-client/python/master/kubernetes/swagger.json.unprocessed

Command line used for generation

--

Steps to reproduce
Related issues/PRs
Suggest a fix/enhancement

I'm not sure how to fix it but could be something in the PythonClientCodegen.java file. If anyone has any ideas to fix it, I'd be happy to implement the fix.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PythonClientCodegen.java and compare the generated Python .md and .py files using the linked Kubernetes swagger declaration. Confirm where the default True value is rendered, then verify that generated documentation uses True consistently with the Python files.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, python
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.