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

Generator creates enum property types that can collide with user-defined types, causing generation failures

オープン
#1,167 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Python
スター
2k
フォーク
293
平均マージ
34分
マージ済み PR(30日)
1

説明

Describe the bug

When the generator creates a new Python type to represent a schema property's enum type it can sometimes get unlucky by generating the name of a user-defined type that already exists in the schema.

When this happens, the generator gives up and issues a warning. The Python type for the enum property and the generated API client are only partially generated as a result. This warning manifests as a runtime error in the Python client when affected endpoints are accessed by the generated Python code. I have so far been unable to figure out any configuration-based way of working around the issue.

OpenAPI Spec File

This issue can be reproduced deterministically by running:

openapi-python-client generate --url https://raw.githubusercontent.com/EvanBacon/App-Store-Connect-OpenAPI-Spec/refs/heads/main/specs/3.6.0.json --overwrite

Relevant warning output is in the "Additional context" section below.

Desktop (please complete the following information):

  • OS: macOS 15.1.1
  • Python Version: 3.12.1
  • openapi-python-client version 0.21.6

Additional context

We discovered this "in the wild" while attempting to generate a Python client for the Apple App Store Connect API.

When we ran the generator on version 3.6.0 of the App Store Connect OpenAPI schema, we saw this (among other) warnings:

Unable to process schema /components/schemas/Certificate:

Found conflicting enums named CertificateType with incompatible values.

Failure to process schema has resulted in the removal of:
/components/schemas/Certificate
/components/schemas/CertificatesWithoutIncludesResponse
/components/schemas/CertificatesResponse
/components/schemas/CertificateResponse

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=['certificates'], 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)

This was happening because the generator was attempting to create a type called "CertificateType" when it was traversing the properties of the "Certificate" object, who had a child enum property called "type", excerpt below:

      "Certificate": {
        "type": "object",
        "title": "Certificate",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "certificates"
            ]

The generator took the name of the parent, and concatenated it with the name of the property to create the name "CertificateType".

Sadly, as noted above, that type name was already taken in the API by a separate user-defined "CertificateType", excerpted below:

"CertificateType": {
        "type": "string",
        "enum": [
          "IOS_DEVELOPMENT",
          "IOS_DISTRIBUTION",

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

提供された openapi-python-client generate コマンドと App Store Connect 3.6.0 スキーマを使って失敗を再現し、Certificate オブジェクトの type enum がどのように CertificateType になり、既存のスキーマ型と競合するのかを追跡します。これらのエンドポイントにアクセスしたときに、生成によって影響を受けるスキーマが削除されなくなり、実行時に失敗するクライアントが生成されなくなれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
openapi, python
領域
tooling
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。