OpenAPITools / OpenAPITools/openapi-diff
`--state` option outputs `metadata`
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
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
to include something like
public DiffResult toStateDiff() {
if (this.isUnchanged()) {
return DiffResult.UNCHANGED;
}
if (this.isCompatible()) {
return DiffResult.COMPATIBLE;
}
return DiffResult.INCOMPATIBLE;
}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in cli/src/main/java/org/openapitools/openapidiff/cli/Main.java at the --state handling, then read core/src/main/java/org/openapitools/openapidiff/core/model/DiffResult.java and its state values. Confirm that --state reports only no_changes, compatible, or incompatible, and verify that a metadata result is no longer emitted.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100