OpenAPITools/openapi-diff

`--state` option outputs `metadata`

Open

#508 geöffnet am 18. Apr. 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (1.079 Stars) (187 Forks)user submission
good first issue

Beschreibung

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

Contributor Guide

Tech Stack
java
Domain
cliapi
Issue Type
bug
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Java basicsOpenAPI diff concepts
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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.