OpenAPITools / OpenAPITools/openapi-diff
Support for detecting changes in webhooks
未关闭
还没有人认领这个 Issue。
OpenAP 3.1.0 Support
- 主要语言
- Java
- 星标
- 1.1k
- 派生
- 190
- PR 合并指标
- 30 天内没有已合并 PR
描述
It would be nice to support API changes in webhooks defined with OpenAPI 3.1, in particular:
- Detect if a webhook is removed
- Detect changes in the webhook payload
Unfortunately it looks like now this is not possible.
This can be reproduced by doing:
String oldSpec = Paths.get("webhook1.yml").toUri().toString();
String newSpec = Paths.get("webhook2.yml").toUri().toString();
ChangedOpenApi diff = OpenApiCompare.fromLocations(oldSpec, newSpec);
The content of boths specs are attached here (as .txt but they are .yml specs)
Note that no differences are found in this case
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先,使用随附的 webhook1.txt 和 webhook2.txt 规范运行 OpenApiCompare.fromLocations 复现。跟踪 OpenAPI 3.1 webhook 的比较方式,然后验证移除 webhook 和更改其 payload 是否会被报告为差异。对于所提供的规范,两种情况都产生差异后,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java, openapi
- 领域
- api
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100