diff --git a/README.md b/README.md index 8538d1e7..c2844e85 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,8 @@ usage: openapi-diff --off No information printed --query use query param for authorisation --state Only output diff state: no_changes, - incompatible, compatible + metadata, compatible, unknown, + incompatible --text export diff as text in given file --trace be extra verbose --version print the version information and exit @@ -125,7 +126,8 @@ usage: openapi-diff --off No information printed --query 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 diff --git a/cli/src/main/java/org/openapitools/openapidiff/cli/Main.java b/cli/src/main/java/org/openapitools/openapidiff/cli/Main.java index 85f125d7..79d94e6e 100644 --- a/cli/src/main/java/org/openapitools/openapidiff/cli/Main.java +++ b/cli/src/main/java/org/openapitools/openapidiff/cli/Main.java @@ -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; @@ -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; @@ -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()