Skip to content

fix #508: list all --state values in CLI help #932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mmatokovic wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix #508: list all --state values in CLI help #932

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ usage: openapi-diff <old> <new>
--off No information printed
--query <property=value> use query param for authorisation
--state Only output diff state: no_changes,
incompatible, compatible
metadata, compatible, unknown,
incompatible
--text <file> export diff as text in given file
--trace be extra verbose
--version print the version information and exit
Expand Down Expand Up @@ -125,7 +126,8 @@ usage: openapi-diff <old> <new>
--off No information printed
--query <property=value> use query param for authorisation
--state Only output diff state: no_changes,
incompatible, compatible
metadata, compatible, unknown,
incompatible
--fail-on-incompatible Fail only if API changes broke backward compatibility
--fail-on-changed Fail if API changed but is backward compatible
--config-file Config file to override default behavior. Supported file formats: .yaml
Expand Down
9 changes: 8 additions & 1 deletion cli/src/main/java/org/openapitools/openapidiff/cli/Main.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@
import java.io.File;
import java.io.FileOutputStream;
import java.io.OutputStreamWriter;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
Expand All @@ -19,6 +21,7 @@
import org.openapitools.openapidiff.core.OpenApiCompare;
import org.openapitools.openapidiff.core.compare.OpenApiDiffOptions;
import org.openapitools.openapidiff.core.model.ChangedOpenApi;
import org.openapitools.openapidiff.core.model.DiffResult;
import org.openapitools.openapidiff.core.output.AsciidocRender;
import org.openapitools.openapidiff.core.output.ConsoleRender;
import org.openapitools.openapidiff.core.output.HtmlRender;
Expand All @@ -42,7 +45,11 @@ public static void main(String... args) {
options.addOption(
Option.builder()
.longOpt("state")
.desc("Only output diff state: no_changes, incompatible, compatible")
.desc(
"Only output diff state: "
+ Arrays.stream(DiffResult.values())
.map(DiffResult::getValue)
.collect(Collectors.joining(", ")))
.build());
options.addOption(
Option.builder()
Expand Down