Skip to content

feat(apigw-manager): 支持资源级弃用说明自动化导入 - #317

Open
robot-wklken wants to merge 2 commits into
TencentBlueKing:masterfrom
robot-wklken:codex/dd-316-apigw-manager-resource-deprecated-import
Open

robot-wklken wants to merge 2 commits into
TencentBlueKing:masterfrom
robot-wklken:codex/dd-316-apigw-manager-resource-deprecated-import

Conversation

@robot-wklken

Copy link
Copy Markdown
Collaborator

DRF 资源可通过 extend_schema(deprecated=True) 标记弃用,并使用新增的 gen_apigateway_resource_config(deprecated_note=...) 生成 x-bk-apigateway-resource.deprecatedNote。默认空说明省略该扩展字段,原有配置输出保持兼容。

补充 YAML 和 DRF 配置示例,说明取消弃用、完整同步省略字段会清空配置,以及创建资源版本并发布后的生效规则。现有同步链路原样传递 OpenAPI 的 deprecated 和弃用说明。

验证:

  • 新增 19 项用例,覆盖空说明、中文说明、2048 字符边界、真实 schema 生成及 OpenAPI 2.0 / 3.0 / 3.1 请求内容透传;新增助手和 schema 用例在实现前出现预期失败。
  • Python 3.11.6 / Django 5.2.14 下,完整 apigw-manager 测试:341 passed。
  • 修改文件的 Ruff 导入顺序、规则、格式检查及 mypy 均通过;同步修正资源配置助手原有的 any 返回类型为 Any。
  • wheel 构建、文档示例校验和 diff 检查通过。

网关请求使用模拟端点验证,未连接真实网关;其他 Python 版本和操作系统由后续 CI 验证。

Fixes #316

@wklken

wklken commented Nov 4, 2026

Copy link
Copy Markdown
Collaborator

@robot-wklken

  1. #### 1.2.1 资源弃用配置 不要单独列一段, 把对应字段放入原先的 yaml示例和说明即可;(这两个字段不重要,是普通字段并且大部分人不关注)
  2. drf 中的配置, 如果当前项目有地方说明,加,没有的话不用处理(另一个bk-apigateway-framework其文档会说明这些字段)

@robot-wklken

Copy link
Copy Markdown
Collaborator Author

已按要求调整文档:

  1. 删除独立的「1.2.1 资源弃用配置」小节,将 deprecated 和 x-bk-apigateway-resource.deprecatedNote 并入原有 YAML 字段示例,以行内注释说明字段含义和说明长度限制。
  2. 检查了本次改动之前的项目文档,未找到 DRF 资源配置的使用说明入口,因此删除本 PR 新增的独立 DRF 示例。

验证通过:git diff --check;YAML 解析与字段位置、类型检查;原有配置值与前后章节保持一致;8 个相对文档引用有效。此次仅修改文档,未运行 Python 测试套件。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

apigw-manager 增加资源级 deprecated 自动化导入

2 participants