openapi-generators / openapi-generators/openapi-python-client
Missing references in API generation process
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 2k
- 派生
- 293
- 平均合并
- 34 分钟
- 30 天内合并 PR
- 1
描述
Describe the bug
While trying to generate the OpenAPI client, I come across a bug that not only modifies several files unnecessarily but also displays a warning message about endpoint generating, which root cause is unclear to me:
Warning(s) encountered while generating. Client was generated, but some pieces may be missing
WARNING parsing POST /index/create within index. Endpoint will not be generated.
Could not find reference in parsed models or enums
Unable to process schema /components/schemas/Index:
Value {'object_type': 'IndexParams', 'nlist': 128} is not valid, only None is allowed
Failure to process schema has resulted in the removal of:
/components/schemas/Index
/components/schemas/IndexInSpec
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=None, allOf=[], oneOf=[Reference(ref='#/components/schemas/IndexParams'), 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.NULL: 'null'>, allOf=[], oneOf=[], anyOf=[], schema_not=None, items=None, 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)], anyOf=[], schema_not=None, items=None, properties=None, additionalProperties=None, description=None, schema_format=None, default={'object_type': 'IndexParams', 'nlist': 128}, nullable=False, discriminator=Discriminator(propertyName='object_type', mapping=None), readOnly=None, writeOnly=None, xml=None, externalDocs=None, example=None, deprecated=None)
OpenAPI Spec File
A link to an OpenAPI document which produces this issue. Ideally, write a minimal reproduction only containing the problematic pieces.
Creating the new client: https://github.com/openapi-generators/openapi-python-client?tab=readme-ov-file#create-a-new-client
Desktop (please complete the following information):
- OS: Windows 11 Enterprise Version 22H2
- Python Version: 3.9.13
- openapi-python-client version: 0.17.2
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 issue 中链接的 create-a-new-client 说明开始,并使用报告的 OpenAPI 客户端生成流程重现该警告。调查为什么会删除对 Index、IndexInSpec 和 IndexParams 的引用,然后确认生成过程可以在没有该警告的情况下完成,并保留这些 schema。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- openapi, python
- 领域
- api, tooling
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 28/100