The `deprecated` field from OpenAPI operations is parsed but not exposed to templates

未关闭

#1,412 创建于 2026年3月11日 1 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 2/5
预计耗时: 1-3 小时
新手友好度: 58/100

Issue 类型: 缺陷
描述清晰度: 描述清楚
活跃度: 停滞
技术栈: python
领域: tooling

调研方向

从 openapi_python_client/schema/openapi_schema_pydantic/operation.py 中的 Operation 模型，以及 openapi_python_client/parser/openapi.py 中的 Endpoint 数据类和构造函数开始。跟踪 operation 数据如何到达传递给 Jinja 模板的 Endpoint，然后验证 deprecated operation 会公开 endpoint.deprecated，并且在未指定时默认为 false。

由索引模型根据 Issue 内容生成。

描述

Describe the bug

The deprecated field on OpenAPI operation objects is parsed into the Operation schema model (operation.py#L31), but it is never carried over to the Endpoint dataclass that is passed to Jinja templates (openapi.py#L132-L152).

This means there is no way to check endpoint.deprecated in a custom template to conditionally emit deprecation warnings, docstring annotations, or @deprecated decorators.

The Endpoint dataclass is missing a deprecated: bool field, and the constructor at openapi.py#L419-L427 does not pass data.deprecated through.

Expected behavior

The Endpoint dataclass should include a deprecated: bool = False field, populated from data.deprecated during construction, so that templates can use {% if endpoint.deprecated %} to customize output for deprecated operations.

OpenAPI Spec File

Any spec with a deprecated operation, for example:

paths:
  /example:
    get:
      operationId: getExample
      deprecated: true
      responses:
        '200':
          description: OK

Desktop (please complete the following information):

OS: macOS 26.3
Python Version: 3.9.6
openapi-python-client version: 0.28.2

主要语言: Python
星标: 2k
派生: 293
平均合并: 34 分钟
30 天内合并 PR: 1

贡献指南

打开贡献指南

从这里开始

先读完整个 Issue，再读项目的贡献指南。
在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
Fork 仓库，在一个分支上完成修改。
提交 Pull Request，并在描述里引用这个 Issue 编号。

openapi-generators/openapi-python-client 的其他 Issue

typing_extensions should be declared as dependency 未关闭

难度 2/5 1-3 小时新手友好度 68/100

openapi-generators/openapi-python-client#1481 · 2026年8月20日创建
Skip setting 'Content-Type' on file upload, when multiple bodies are supported 未关闭

难度 2/5 1-3 小时新手友好度 65/100

openapi-generators/openapi-python-client#947 · 2024年1月23日创建
Multi-body endpoints with required requestBody emit `| Unset` without importing `Unset` 未关闭

难度 3/5 1-2 天新手友好度 72/100

openapi-generators/openapi-python-client#1451 · 1 条评论 · 2026年6月18日创建
_build_response crashes with ValueError on non-IANA HTTP status codes (520, 561, etc.) 未关闭

难度 3/5 1-2 天新手友好度 52/100

openapi-generators/openapi-python-client#1442 · 2026年5月29日创建
Generator fails on type: array without items even though it's valid in JSON Schema 2020-12 / OpenAPI 3.1 未关闭

难度 3/5 1-2 天新手友好度 64/100

openapi-generators/openapi-python-client#1435 · 1 条评论 · 2026年5月15日创建

查看 openapi-generators/openapi-python-client 的全部 Issue

相似的 Issue

issue: imported chats all show as unread in the sidebar 未关闭

bug confirmed issue

难度 2/5 1-3 小时新手友好度 75/100

open-webui/open-webui#30750 · 1 条评论 · 2026年9月24日创建
OGS AmBe example has no source.timing block, so every event sits at time zero 未关闭

难度 2/5 1-3 小时新手友好度 75/100

lanl/ScintiPix#61 · 2026年9月24日创建
Make Liquid Glass the default theme for the Research build 未关闭

enhancement

难度 2/5 1-3 小时新手友好度 75/100

OpenwaterHealth/openmotion-bloodflow-app#604 · 1 条评论 · 2026年9月24日创建
tests/puppeteer/test_openai_api_key_ui.js targets controls that do not exist and is run by no workflow 未关闭

难度 2/5 1-3 小时新手友好度 70/100

LearningCircuit/local-deep-research#6766 · 2026年9月23日创建
Delete unused args argument from main() in Python files 未关闭

good first issue

难度 1/5 1 小时以内新手友好度 90/100

ros2/launch#1014 · 2026年9月23日创建

更多 Python Issue