Skip to content

Commit

Permalink
add fail_on_breaking to CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
jayk-u committed Aug 1, 2024
1 parent 5dbac6b commit 8c52820
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/_help/continuous-integration/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 8c52820

Please sign in to comment.