OpenAPITools/openapi-diff

`--state` option outputs `metadata`

Open

#508 建立於 2023年4月18日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Java (1,079 star) (187 fork)user submission
good first issue

描述

From help,

    --state                     Only output diff state: no_changes,
                                incompatible, compatible

this doesn't align with reality. We had a case where the state outputted metadata.

Caused by this line: https://github.com/OpenAPITools/openapi-diff/blob/1de574d3ca447bc463740bc10c37851702974a00/cli/src/main/java/org/openapitools/openapidiff/cli/Main.java#L203

We can simply https://github.com/OpenAPITools/openapi-diff/blob/1de574d3ca447bc463740bc10c37851702974a00/core/src/main/java/org/openapitools/openapidiff/core/model/DiffResult.java#L5

to include something like

public DiffResult toStateDiff() {
  if (this.isUnchanged()) {
    return DiffResult.UNCHANGED;
  }

 if (this.isCompatible()) {
    return DiffResult.COMPATIBLE;
 }

 return DiffResult.INCOMPATIBLE;
}

貢獻者指南

技術棧
java
領域
cliapi
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Java basicsOpenAPI diff concepts
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
The issue identifies a bug where the ` state` option outputs 'metadata' instead of the expected diff state. The problem is in Main.java line 203, where the output is incorrectly sourced. The suggested fix is to add a method `toStateDiff()` in DiffResult.java that maps results to UNCHANGED, COMPATIBLE, or INCOMPATIBLE. The contributor should implement this method and update the CLI logic to use it. Test the change by running the ` state` option on sample OpenAPI specs to verify correct output.