From 8c52820d3cfd3bd8faaf49be1bbc8e057926aa49 Mon Sep 17 00:00:00 2001 From: Jay Cormier Date: Thu, 1 Aug 2024 11:56:41 +0200 Subject: [PATCH] add fail_on_breaking to CLI --- src/_help/continuous-integration/cli.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/_help/continuous-integration/cli.md b/src/_help/continuous-integration/cli.md index 2e0e3c2b..c879b370 100644 --- a/src/_help/continuous-integration/cli.md +++ b/src/_help/continuous-integration/cli.md @@ -247,6 +247,12 @@ _Note: you can also apply the overlay during the [`bump deploy` command](#bump-d bump deploy api-document.yaml --doc my-doc --token my-token --overlay overlay-file.yaml ``` +### Optional imputs + +#### `fail_on_breaking` + +Mark the action as failed when a breaking change is detected with the diff command. This is only valid with diff command. + ## Compatible specification types We currently support [OpenAPI](https://github.com/OAI/OpenAPI-Specification) from 2.0 (called Swagger) to 3.1 and [AsyncAPI 2.x](https://www.asyncapi.com/docs/reference/specification/latest) specification file types. Both YAML or JSON file formats are accepted file inputs to the CLI.