Skip to content

Commit

Permalink
Update the documentation of version command
Browse files Browse the repository at this point in the history
  • Loading branch information
omris94 committed May 16, 2023
1 parent 25fe453 commit 7bfd62b
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/reference/cli/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -201,15 +201,15 @@ To change your organization selection, log-in again with --switch-org.

```

## API version
## Version

### `otterize api-version`
### `otterize version`

Queries the Otterize Cloud for the current API version (e.g. `v1`) and revision (hash of the current API definition).
Prints the CLI build version, and queries the Otterize Cloud for the current API version (e.g. `v1`) and revision (hash of the current API definition).

#### Returns

Returns the current version and revision of the Otterize REST API, as well as the version and revision against which this CLI is built.
Returns the version of CLI and the current version and revision of the Otterize REST API, as well as the version and revision against which this CLI is built.

Note that the Otterize CLI is mostly a thin but useful utility for invoking the Otterize Cloud REST API.
API versions that differ by version number may break backwards compatibility, while those that only differ by revision are backwards compatible: revisions add functionality or documentation but preserve all previous functionality.
Expand All @@ -221,6 +221,7 @@ If also the Cloud API version is later than the CLI version, some CLI commands m
Beta version of the Cloud API (e.g. `v1beta`) are volatile: they can change and break backwards compatibility until they are out of beta.

```shell
Version: v0.1.1
Current Cloud API:
version: v1
revision: 465ba4174008682f54f99e37d0b7791148aade14
Expand Down

0 comments on commit 7bfd62b

Please sign in to comment.