openapi-generators / openapi-generators/openapi-python-client

Attempted to generate duplicate models with name "TypenameFieldnameItem"

Aberta
#1,375 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
Python
Estrelas
2k
Forks
293
Merge médio
34min
PRs com merge (30d)
1

Descrição

Describe the bug
I stumbled on a weirdly specific bug that causes the generator to attempt to generate duplicate models.

Apparently we need:

  • a OneOf type (A), which references an Object type (B)
  • An object type (B) with an array-of-object field
  • An Object type (C) for the array-of-object field
  • array-of-C and C must be declared inline inside B

OpenAPI Spec File

This works

openapi: 3.0.3
info:
  title: Minimal example for error "Attempted to generate duplicate models"
  version: 1.0.0

components:
  schemas:
    Result:
      oneOf:
        - $ref: "#/components/schemas/ResultA"
      discriminator:
        propertyName: type
        mapping:
          "A": "#/components/schemas/ResultA"

    ResultA:
      type: object
      properties:
        things:
          type: array
          items:
            $ref: "#/components/schemas/ResultAThingsItem"

    ResultAThingsItem:
      type: object
      properties:
        name:
          type: string

paths:
  /something:
    get:
      summary: Returns a list of users.
      responses:
        '200':
          description: A successful response returning the list of users.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'

This should be the same, but doesn't work:

openapi: 3.0.3
info:
  title: Minimal example for error "Attempted to generate duplicate models"
  version: 1.0.0

components:
  schemas:
    Result:
      oneOf:
        - $ref: "#/components/schemas/ResultA"
      discriminator:
        propertyName: type
        mapping:
          "A": "#/components/schemas/ResultA"

    ResultA:
      type: object
      properties:
        things:
          type: array
          items:
            type: object
            properties:
              name:
                type: string

paths:
  /something:
    get:
      summary: Returns a list of users.
      responses:
        '200':
          description: A successful response returning the list of users.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'

Output:

$ pipx run openapi-python-client generate --path=example.yaml --overwrite
Generating <...>/minimal-example-for-error-attempted-to-generate-duplicate-models-client
Warning(s) encountered while generating. Client was generated, but some pieces may be missing

WARNING parsing GET /something within default.

Cannot parse response for status code 200 (Could not find reference in parsed models or enums), response will be omitted from generated client

Reference(ref='#/components/schemas/Result')

Unable to process schema /components/schemas/Result:

Attempted to generate duplicate models with name "ResultAThingsItem"

Failure to process schema has resulted in the removal of:
/components/schemas/ResultA
/components/schemas/Result

Schema(title=None, multipleOf=None, maximum=None, exclusiveMaximum=None, minimum=None, exclusiveMinimum=None, maxLength=None, minLength=None, pattern=None, maxItems=None, minItems=None, uniqueItems=None, maxProperties=None, minProperties=None, required=None, enum=None, const=None, type=<DataType.OBJECT: 'object'>, allOf=[], oneOf=[], anyOf=[], schema_not=None, items=None, prefixItems=[], properties={'name': Schema(title=None, multipleOf=None, maximum=None, exclusiveMaximum=None, minimum=None, exclusiveMinimum=None, maxLength=None, minLength=None, pattern=None, maxItems=None, minItems=None, uniqueItems=None, maxProperties=None, minProperties=None, required=None, enum=None, const=None, type=<DataType.STRING: 'string'>, allOf=[], oneOf=[], anyOf=[], schema_not=None, items=None, prefixItems=[], properties=None, additionalProperties=None, description=None, schema_format=None, default=None, nullable=False, discriminator=None, readOnly=None, writeOnly=None, xml=None, externalDocs=None, example=None, deprecated=None)}, additionalProperties=None, description=None, schema_format=None, default=None, nullable=False, discriminator=None, readOnly=None, writeOnly=None, xml=None, externalDocs=None, example=None, deprecated=None)

If you believe this was a mistake or this tool is missing a feature you need, please open an issue at https://github.com/openapi-generators/openapi-python-client/issues/new/choose



**Desktop (please complete the following information):**
 - OS: Ubuntu 25.04
 - Python Version: 3.12.3
 - openapi-python-client version: 0.28.0

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece executando openapi-python-client generate --path=example.yaml --overwrite com os dois schemas da issue e, em seguida, rastreie o ponto de entrada da geração de modelos que lida com o item de array inline e o modelo referenciado. A tarefa estará concluída quando a forma inline não relatar mais um modelo ResultAThingsItem duplicado e a resposta GET for mantida no cliente gerado.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
openapi, python
Domínio
api, tooling
Tipo de issue
Bug
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
55/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.