OpenAPITools/openapi-diff

`--state` option outputs `metadata`

Open

#508 opened on Apr 18, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (1,079 stars) (187 forks)user submission
good first issue

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Java basicsOpenAPI diff concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.
`--state` option outputs `metadata` · OpenAPITools/openapi-diff#508 | Good First Issue