Skip to content

Commit

Permalink
Update README.mdx
Browse files Browse the repository at this point in the history
Tiny tweaks.
  • Loading branch information
usarid committed May 16, 2023
1 parent 7bfd62b commit e10b0af
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/reference/cli/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -205,11 +205,11 @@ To change your organization selection, log-in again with --switch-org.

### `otterize version`

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).
Prints the CLI build version, and queries the Otterize Cloud for the current Cloud REST API version (e.g. `v1`) and revision (hash of the current Cloud REST API definition).

#### Returns

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.
Returns the version of CLI and the current version and revision of the Otterize Cloud 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 @@ -218,7 +218,7 @@ If only the Cloud API has changed since the CLI was built (revisions don't match

If also the Cloud API version is later than the CLI version, some CLI commands might fail.

Beta version of the Cloud API (e.g. `v1beta`) are volatile: they can change and break backwards compatibility until they are out of beta.
Beta versions of the Cloud API (e.g. `v1beta`) are volatile: they may change and break backwards compatibility until they are out of beta.

```shell
Version: v0.1.1
Expand Down

0 comments on commit e10b0af

Please sign in to comment.