OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
[ ] [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
I am generating a Python client. I want to import some classes instead of generating them. The documentation says to use importMappings or schemaMappings. They don't work.
The importMappings are ignored. I found the code that clears them:
// clear import mapping (from default generator) as python does not use it
// at the moment
importMapping.clear();
The schemaMappings can be used to map the schema to something else (e.g. external objects/models outside of the package) according to the customization page. It is unclear how to set them when generating Python clients. They do not add import statements at the top of the generated file. Instead, they camelCase the values. I have used the schemaMappings successfully when generating Java clients for my API, but for Python client codegen they don't work.
I appreciate any advice. Thanks.
openapi-generator version
7.2.0
OpenAPI declaration file content or url
openapi: 3.0.3
info:
version: 2.7.0
title: Person API
tags:
- name: Person
description: Part of the Person API.
x-tag-expanded: false
paths:
/person:
get:
tags:
- Person
summary: Get a Person
operationId: getPerson
responses:
'200':
description: A person object.
content:
application/json:
schema:
$ref: '#/components/schemas/Person'
components:
schemas:
# The Address should be imported, not generated
Address:
type: object
properties:
full_address:
type: string
Person:
type: object
properties:
id:
type: string
first_name:
type: string
last_name:
type: string
age:
type: integer
address:
$ref: '#/components/schemas/Address'
Bug Report Checklist
Description
I am generating a Python client. I want to import some classes instead of generating them. The documentation says to use
importMappings
orschemaMappings
. They don't work.The
importMappings
are ignored. I found the code that clears them:The
schemaMappings
can be used to map the schema to something else (e.g. external objects/models outside of the package) according to the customization page. It is unclear how to set them when generating Python clients. They do not add import statements at the top of the generated file. Instead, they camelCase the values. I have used theschemaMappings
successfully when generating Java clients for my API, but for Python client codegen they don't work.I appreciate any advice. Thanks.
openapi-generator version
7.2.0
OpenAPI declaration file content or url
Generation Details
Steps to reproduce
Use the gradle plugin with these settings:
The result is the following code:
Related issues/PRs
Suggest a fix