OpenAPITools / OpenAPITools/openapi-generator

upgrade generator language version for python

Open
#13,326 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: Python
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Description

The openApi generator for python supports a generator language version of >=3.6. I was wondering if there is a way for me to specify a version in my typescript generateClient() function or anywhere else.

export async function generateClient(app: INestApplication): Promise<void> {
  const documentBuilder = new DocumentBuilder()
    .setTitle("XXXXXX")
    .addApiKey({
      type: "apiKey",
      in: "header",
      name: "X-Api-Key",
      description: "Include API key in the X-Api-Key header when making requests",
    })
    .setDescription("API Client for XXXX, by XXXXX");

  return OpenApiNestFactory.configure(app, documentBuilder, {
    fileGeneratorOptions: {
      enabled: true,
      outputFilePath: "./openapi/api-spec.yml",
    },
    clientGeneratorOptions: {
      type: "python",
      enabled: true,
      outputFolderPath: "./openapi/clients/python",
      openApiFilePath: "./openapi/api-spec.yml",
      additionalProperties:
        "packageName=XXXX,packageVersion=0.1.0"
    },
  });
}
openapi-generator version

6.0.1

thank you in advance

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 the TypeScript generateClient() entry point and its clientGeneratorOptions.additionalProperties setting, then compare it with the Python generator documentation. Confirm whether a generator language-version option is exposed; done means the supported configuration is documented or implemented and verified for the shown setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, typescript
Domain
api, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.