OpenAPITools / OpenAPITools/openapi-diff

Operation description change is detected as a change but it is not rendered by HtmlRender

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

还没有人认领这个 Issue。

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

描述

When the operation's description changes it is not rendered in the Html

In the following specifications the only difference when compared in text edit are their version and the operation's description

Image

sample-api_3.47.0_ALL.json
sample-api_3.48.0_ALL.json

The operation is detected as changed but renders nothing

testDiff.html

Report was generated by using the example code in home page by specifying rendering all changes i.e.
HtmlRender htmlRender = new HtmlRender("Changelog", "http://deepoove.com/swagger-diff/stylesheets/demo.css", true);

贡献指南

打开贡献指南

从这里开始

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

调研方向

从 HtmlRender 示例配置开始,并比较 sample-api_3.47.0_ALL.json 和 sample-api_3.48.0_ALL.json 在 testDiff.html 中的输出。跟踪已更改的操作描述是如何被处理和渲染的;完成的标准是,在渲染所有更改时,生成的 HTML 中能明显包含描述更改。

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

评估

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

把新 issue 发到你的邮箱

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