OpenAPITools / OpenAPITools/openapi-diff
Bug: no details when securitySchemes.*.name changes
未关闭
还没有人认领这个 Issue。
OpenAP 3.1.0 Support
- 主要语言
- Java
- 星标
- 1.1k
- 派生
- 190
- PR 合并指标
- 30 天内没有已合并 PR
描述
Description
When a change is introduced solely to the name property of an apiKey securitySchemes object in an OpenAPI 3.1 specification, openapi‑diff merely reports that a change occurred without providing any line‑level detail (path, field changed, old and new values).In addition, there appears to be no way to disable this rule via the usual options. (incompatible.security.scheme.scheme.change:false)
==========================================================================
== API CHANGE LOG ==
==========================================================================
**** Restful API
--------------------------------------------------------------------------
-- What's Changed --
--------------------------------------------------------------------------
- GET /rest/v1/info
--------------------------------------------------------------------------
-- Result --
--------------------------------------------------------------------------
API changes are backward compatible
--------------------------------------------------------------------------
Thanks for your help!
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先比较附带的 old.json 和 new.json 规范,然后跟踪 securitySchemes apiKey 名称变更的处理方式以及 incompatible.security.scheme.scheme.change 选项。修复应报告发生变更的路径、字段以及旧值和新值,同时允许禁用该规则;请验证 API 变更日志反映了这些详细信息。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java
- 领域
- api
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100