OpenAPITools / OpenAPITools/openapi-diff

In openapi-diff-cli add old and new filenames to the output

未关闭 适合新手
#506 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

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

描述

When using openapi-diff-cli we need to give and filenames.
It will be cool to have those filenames in the report output.

Before:

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                           API Name API
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
...

After:

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                           API Name API
--------------------------------------------------------------------------
old file: xxx.json
new file: yyy.json
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
...

贡献指南

打开贡献指南

从这里开始

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

调研方向

从 openapi-diff-cli 报告输出的入口点开始,跟踪旧输入文件名和新输入文件名如何传递到报告生成过程中。使用 issue 的旧 JSON 输入和新 JSON 输入运行 CLI,然后验证报告在所示部分中包含这两个文件名,同时不更改现有的变更日志。

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

评估

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

把新 issue 发到你的邮箱

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