OpenAPITools / OpenAPITools/openapi-diff
Output in text and markdown not equivalent (text output incomplete)
未关闭
还没有人认领这个 Issue。
enhancement
Render capabilities
- 主要语言
- Java
- 星标
- 1.1k
- 派生
- 190
- PR 合并指标
- 30 天内没有已合并 PR
描述
The text output which is printed by default by the CLI doesn't show all the information that the markdown output shows:
spec1.yaml
components:
schemas:
SomeDTO:
someProperty:
type: string
enum:
- ENUM_VALUE_1
- ENUM_VALUE_2
spec2.yaml
components:
schemas:
SomeDTO:
someProperty:
type: string
enum:
- ENUM_VALUE_1
- ENUM_VALUE_2
- ENUM_VALUE_3
markdown output
#### What's Changed
---
##### `GET` /resources1/{id}/resources2
###### Return Type:
Changed response : **200 OK**
> OK
* Changed content type : `application/json`
Changed items (object):
* Changed property `someProperty` (string)
Added enum value:
* `ENUM_VALUE_3`
text output
==========================================================================
== API CHANGE LOG ==
==========================================================================
API for Umetrics Core Project Management Service
--------------------------------------------------------------------------
-- What's Changed --
--------------------------------------------------------------------------
Return Type:
- Changed 200 OK
Media types:
- Changed application/json
Schema: Broken compatibility
- GET /resources1/{id}/resources2
API changes broke backward compatibility
--------------------------------------------------------------------------
text output tells nothing about what actually broke backwards compatibility, but since it's the stdout of the process it should show everything that's needed to determine the reason of the problem.
Alternative solution: give an option to decide which kind of output: text/markdown/json should be printed to stdout.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从生成所示文本输出的 CLI 路径开始,并将其与 markdown formatter 进行比较。使用提供的 spec1.yaml 和 spec2.yaml 示例,验证 stdout 是否标识了已更改的属性和 enum 值,或者是否提供了明确的输出格式选项。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java, openapi
- 领域
- api, cli
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 30/100