OpenAPITools / OpenAPITools/openapi-diff

ExtensionDiff in renderers (just tried console and html)

未关闭
#839 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

enhancement Render capabilities
主要语言
Java
星标
1.1k
派生
190
PR 合并指标
30 天内没有已合并 PR

描述

I'm implementing ExtensionDiffs, but it seems they don't make it into the renderers, or at least I don't see how they would.
I.e. I'm only using console and html.

The console renderer just lists the route as changed and says there were backward incompatible changes in the spec but no further detail.

The html renderer lists the route under "What's Changed" with an empty <ul> with class detail which then renders as a thick gray line.

It would be nice if the renderers would be able to display details about the extension differences, especially when they are breaking, but also the non-breaking ones would be interesting.

In the html renderer result there is not even an indication whether there were breaking changes or not if the breaking changes come from an extension diff.

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先跟踪 ExtensionDiff 从比较输出到控制台和 HTML 渲染器的流程,重点关注现有的路由变更和详细列表渲染。完成的标准是两个渲染器都显示扩展差异的详细信息,并指出这些差异是 breaking 还是 non-breaking。

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

评估

技术栈
java
领域
api
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。