aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2018-04-10 15:03:27 +0530
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>2018-04-10 15:03:27 +0530
commit2882e243599362663668994854e19507a98d430f (patch)
tree9a2a502949c8fd2560d6acf65ecc8d035ceaa7f7 /docs
parentc010b36072b610ec1815e92c39907e5ed1f822b6 (diff)
Remove duplication in the help docs
Issue-ID: CLI-100 Change-Id: I508c5f488ddd4b0e4719ba96122f2b1e7d3988bb Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/cmd_help.rst1
-rw-r--r--docs/cmd_help_onap_amsterdam.rst347
2 files changed, 1 insertions, 347 deletions
diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst
index cf912c84..d5f69024 100644
--- a/docs/cmd_help.rst
+++ b/docs/cmd_help.rst
@@ -11,6 +11,7 @@
open-cli
==========================
+
[1] schema-refresh
-----------------------------------------------
diff --git a/docs/cmd_help_onap_amsterdam.rst b/docs/cmd_help_onap_amsterdam.rst
index 873d9694..f71191cc 100644
--- a/docs/cmd_help_onap_amsterdam.rst
+++ b/docs/cmd_help_onap_amsterdam.rst
@@ -9,353 +9,6 @@
.. _cli_cmd_help:
-open-cli
-==========================
-
-
-[1] basic-login
------------------------------------------------
-
-
-usage: oclip basic-login
-
-basic login auth command
-
-Product: open-cli
-Service: basic-auth
-Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
-
-Options::
-
- [-m | --host-url] [-C | --no-catalog] [-h | --help]
- [-f | --format] [-t | --no-title] [-V | --verify]
- [-v | --version] [-d | --debug] [-s | --long]
- [-D | --context] [-u | --host-username] [-p | --host-password]
-
-where::
-
- -m | --host-url host url in http(s). It is of type URL. By
- default, it is read from environment variable
- OPEN_CLI_HOST_URL.
- -C | --no-catalog whether to use given host-url directly without
- looking into catalog, it will overrid the
- service->mode. It is of type BOOL. It is
- optional.
- -h | --help print help message. It is of type BOOL.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING.
- -t | --no-title whether to print title or not. It is of type BOOL.
- -V | --verify verify the command using available command sample
- file and mocking file. By default it goes with
- mock style. To enable the verification in real
- time, set DISABLE_MOCKING=true in the context
- param. It is of type BOOL. It is optional.
- -v | --version print service version. It is of type BOOL.
- -d | --debug Enable debug output. It is of type BOOL.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL.
- -D | --context command context. It is of type MAP. It is
- optional.
- -u | --host-username Host user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_HOST_USERNAME.
- -p | --host-password Host user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_HOST_PASSWORD. Secured.
-
-
-Results::
-
- Authorization Authorization and is of type STRING.
-
-
-Error::
-
- On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[2] basic-logout
------------------------------------------------
-
-
-usage: oclip basic-logout
-
-basic logout auth command
-
-Product: open-cli
-Service: basic-auth
-Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
-
-Options::
-
- [-m | --host-url] [-C | --no-catalog] [-h | --help]
- [-f | --format] [-t | --no-title] [-V | --verify]
- [-v | --version] [-d | --debug] [-s | --long]
- [-D | --context]
-
-where::
-
- -m | --host-url host url in http(s). It is of type URL. By
- default, it is read from environment variable
- OPEN_CLI_HOST_URL.
- -C | --no-catalog whether to use given host-url directly without
- looking into catalog, it will overrid the
- service->mode. It is of type BOOL. It is
- optional.
- -h | --help print help message. It is of type BOOL.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING.
- -t | --no-title whether to print title or not. It is of type BOOL.
- -V | --verify verify the command using available command sample
- file and mocking file. By default it goes with
- mock style. To enable the verification in real
- time, set DISABLE_MOCKING=true in the context
- param. It is of type BOOL. It is optional.
- -v | --version print service version. It is of type BOOL.
- -d | --debug Enable debug output. It is of type BOOL.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL.
- -D | --context command context. It is of type MAP. It is
- optional.
-
-
-Error::
-
- On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[3] catalog
------------------------------------------------
-
-
-usage: oclip catalog
-
-cli catalog command to find the base path for service.
-
-Product: open-cli
-Service: catalog
-Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
-
-Options::
-
- [-m | --host-url] [-C | --no-catalog] [-l | --catalog-service-name]
- [-h | --help] [-f | --format] [-t | --no-title]
- [-V | --verify] [-v | --version] [-d | --debug]
- [-s | --long] [-D | --context] [-i | --catalog-service-version]
-
-where::
-
- -m | --host-url host url in http(s). It is of type URL. By
- default, it is read from environment variable
- OPEN_CLI_HOST_URL.
- -C | --no-catalog whether to use given host-url directly without
- looking into catalog, it will overrid the
- service->mode. It is of type BOOL. It is
- optional.
- -l | --catalog-service-name service name registered in catalog service. It is
- of type STRING. By default, it is .
- -h | --help print help message. It is of type BOOL.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING.
- -t | --no-title whether to print title or not. It is of type BOOL.
- -V | --verify verify the command using available command sample
- file and mocking file. By default it goes with
- mock style. To enable the verification in real
- time, set DISABLE_MOCKING=true in the context
- param. It is of type BOOL. It is optional.
- -v | --version print service version. It is of type BOOL.
- -d | --debug Enable debug output. It is of type BOOL.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL.
- -D | --context command context. It is of type MAP. It is
- optional.
- -i | --catalog-service-version service version registered in catalog service. It
- is of type STRING. By default, it is .
-
-
-Results::
-
- catalog-service-host-url Service connection url and is of type STRING.
- catalog-service-base-path service base path, to append with host-url for
- connecting the service. and is of type STRING.
-
-
-Error::
-
- On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[4] sample-test-verify
------------------------------------------------
-
-
-usage: oclip sample-test-verify
-
-Oclip sample command to test the command features
-
-Product: open-cli
-Service: test
-Author: null
-
-Options::
-
- [-m | --host-url] [-C | --no-catalog] [-h | --help]
- [-f | --format] [-t | --no-title] [-V | --verify]
- [-v | --version] [-d | --debug] [-s | --long]
- [-D | --context] [-u | --host-username] [-a | --no-auth]
- [-p | --host-password]
-
-where::
-
- -m | --host-url host url in http(s). It is of type URL. By
- default, it is read from environment variable
- OPEN_CLI_HOST_URL.
- -C | --no-catalog whether to use given host-url directly without
- looking into catalog, it will overrid the
- service->mode. It is of type BOOL. It is
- optional.
- -h | --help print help message. It is of type BOOL.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING.
- -t | --no-title whether to print title or not. It is of type BOOL.
- -V | --verify verify the command using available command sample
- file and mocking file. By default it goes with
- mock style. To enable the verification in real
- time, set DISABLE_MOCKING=true in the context
- param. It is of type BOOL. It is optional.
- -v | --version print service version. It is of type BOOL.
- -d | --debug Enable debug output. It is of type BOOL.
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL.
- -D | --context command context. It is of type MAP. It is
- optional.
- -u | --host-username Host user name. It is of type STRING. By default,
- it is read from environment variable
- OPEN_CLI_HOST_USERNAME.
- -a | --no-auth whether to authenticate user or not. It is of
- type BOOL.
- -p | --host-password Host user password. It is of type STRING. By
- default, it is read from environment variable
- OPEN_CLI_HOST_PASSWORD. Secured.
-
-
-Results::
-
- cloud Onap cloud and is of type STRING.
- region Onap cloud region and is of type STRING.
- tenant Onap cloud tenat and is of type STRING.
- tenant-id Onap cloud tenat id and is of type STRING.
- customer Onap cloud customer and is of type STRING.
- service Onap cloud service and is of type STRING.
- resource-version Onap cloud resource version and is of type STRING.
-
-
-Error::
-
- On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[5] schema-refresh
------------------------------------------------
-
-
-usage: oclip schema-refresh
-
-Oclip command to refresh schemas stored in open-cli-schema folders.
-
-Product: open-cli
-Service: schema
-Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
-
-Options::
-
- [-s | --long] [-D | --context] [-h | --help]
- [-f | --format] [-t | --no-title] [-v | --version]
- [-d | --debug]
-
-where::
-
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL.
- -D | --context command context. It is of type MAP. It is
- optional.
- -h | --help print help message. It is of type BOOL.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING.
- -t | --no-title whether to print title or not. It is of type BOOL.
- -v | --version print service version. It is of type BOOL.
- -d | --debug Enable debug output. It is of type BOOL.
-
-
-Results::
-
- sr.no Serial Number and is of type STRING.
- command Command name and is of type STRING.
- product Command product version and is of type STRING.
- schema Schema name and is of type STRING.
- ocs-version Schema version and is of type STRING.
- type Command type and is of type STRING.
-
-
-Error::
-
- On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
-[6] schema-validate
------------------------------------------------
-
-
-usage: oclip schema-validate
-
-Oclip command to validate schema
-
-Product: open-cli
-Service: schema
-Author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
-
-Options::
-
- [-s | --long] [-D | --context] [-h | --help]
- [-f | --format] [-t | --no-title] [-b | --ocs-version]
- [-v | --version] [-d | --debug] [-l | --schema-location]
- [-i | --internal-schema]
-
-where::
-
- -s | --long whether to print all attributes or only short
- attributes. It is of type BOOL.
- -D | --context command context. It is of type MAP. It is
- optional.
- -h | --help print help message. It is of type BOOL.
- -f | --format Output formats, supported formats such as table,
- csv, json, yaml. It is of type STRING.
- -t | --no-title whether to print title or not. It is of type BOOL.
- -b | --ocs-version OCS version. It is of type STRING. It is optional.
- -v | --version print service version. It is of type BOOL.
- -d | --debug Enable debug output. It is of type BOOL.
- -l | --schema-location Schema file location. It is of type URL. By
- default, it is .
- -i | --internal-schema Validate existing schema file. It is of type BOOL.
-
-
-Results::
-
- sl-no Serial Number of error and is of type STRING.
- error Schema validation error and is of type STRING.
-
-
-Error::
-
- On error, it prints <STATUS CODE>::<ERROR CODE>::<ERROR MESSAGE>
-
-
-
onap-amsterdam
==========================