OpenAPITools/openapi-diff

`--state` option outputs `metadata`

Open

#508 aperta il 18 apr 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Java (187 fork)user submission
good first issue

Metriche repository

Star
 (1079 star)
Metriche merge PR
 (Merge medio 38g 22h) (15 PR mergiate in 30 g)

Descrizione

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

Guida contributor