From 7bfd62bbdff8ac3386e935730a83a80b79c91c21 Mon Sep 17 00:00:00 2001 From: "omri.s" Date: Tue, 16 May 2023 13:15:03 +0300 Subject: [PATCH 1/3] Update the documentation of version command --- docs/reference/cli/README.mdx | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/reference/cli/README.mdx b/docs/reference/cli/README.mdx index d6e576d15..173a0e9e7 100644 --- a/docs/reference/cli/README.mdx +++ b/docs/reference/cli/README.mdx @@ -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. @@ -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 From e10b0af181212f4dcb09a06db1dfe748253cc854 Mon Sep 17 00:00:00 2001 From: Uri Sarid Date: Tue, 16 May 2023 12:06:23 -0700 Subject: [PATCH 2/3] Update README.mdx Tiny tweaks. --- docs/reference/cli/README.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/cli/README.mdx b/docs/reference/cli/README.mdx index 173a0e9e7..4df67df45 100644 --- a/docs/reference/cli/README.mdx +++ b/docs/reference/cli/README.mdx @@ -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. @@ -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 From 26f61ff1b288a8a73d1ac77a8211ff68cb6ba2a3 Mon Sep 17 00:00:00 2001 From: Uri Sarid Date: Tue, 16 May 2023 12:07:37 -0700 Subject: [PATCH 3/3] Update README.mdx Fix typo. --- docs/reference/cli/README.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/cli/README.mdx b/docs/reference/cli/README.mdx index 4df67df45..89b57ddda 100644 --- a/docs/reference/cli/README.mdx +++ b/docs/reference/cli/README.mdx @@ -209,7 +209,7 @@ Prints the CLI build version, and queries the Otterize Cloud for the current Clo #### Returns -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. +Returns the version of this 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.