OpenAPITools/openapi-diff

`--state` option outputs `metadata`

オープン

#508 opened on 2023/04/18

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Java (187 件のフォーク)user submission
good first issue

Repository metrics

Stars
 (1,079 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

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;
}

コントリビューターガイド