diff options
Diffstat (limited to 'profiles/http/src')
4 files changed, 17 insertions, 10 deletions
diff --git a/profiles/http/src/main/resources/open-cli-schema/http/basic-login.yaml b/profiles/http/src/main/resources/open-cli-schema/http/basic-login.yaml index a3e63af5..b3b5149b 100644 --- a/profiles/http/src/main/resources/open-cli-schema/http/basic-login.yaml +++ b/profiles/http/src/main/resources/open-cli-schema/http/basic-login.yaml @@ -1,4 +1,4 @@ -# Copyright 2018 Huawei Technologies Co., Ltd. +# Copyright 2017-18 Huawei Technologies Co., Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -16,7 +16,8 @@ open_cli_schema_version: 1.0 name: basic-login -description: basic login auth command +description: | + Provides HTTP basic authorization support. info: product: open-cli diff --git a/profiles/http/src/main/resources/open-cli-schema/http/basic-logout.yaml b/profiles/http/src/main/resources/open-cli-schema/http/basic-logout.yaml index d89b6a49..3590f264 100644 --- a/profiles/http/src/main/resources/open-cli-schema/http/basic-logout.yaml +++ b/profiles/http/src/main/resources/open-cli-schema/http/basic-logout.yaml @@ -1,4 +1,4 @@ -# Copyright 2018 Huawei Technologies Co., Ltd. +# Copyright 2017-18 Huawei Technologies Co., Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -16,7 +16,8 @@ open_cli_schema_version: 1.0 name: basic-logout -description: basic logout auth command +description: | + Provides HTTP basic authorization support. As part of logout, it invalidate authoirzation key generated while login. info: product: open-cli diff --git a/profiles/http/src/main/resources/open-cli-schema/http/catalog.yaml b/profiles/http/src/main/resources/open-cli-schema/http/catalog.yaml index e8b0718f..9cb6b7bd 100644 --- a/profiles/http/src/main/resources/open-cli-schema/http/catalog.yaml +++ b/profiles/http/src/main/resources/open-cli-schema/http/catalog.yaml @@ -1,4 +1,4 @@ -# Copyright 2018 Huawei Technologies Co., Ltd. +# Copyright 2017-18 Huawei Technologies Co., Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -16,7 +16,10 @@ open_cli_schema_version: 1.0 name: catalog -description: cli catalog command to find the base path for service. +description: | + Provides catalog discovery support to find the base api path for given service from product's catalog service. + Any product want to support catalog, it could derive from this command. Currently ONAP uses it and create + derived command by using ONAP MSB service. info: product: open-cli diff --git a/profiles/http/src/main/resources/open-cli-schema/http/default_input_parameters_http.yaml b/profiles/http/src/main/resources/open-cli-schema/http/default_input_parameters_http.yaml index 2f7999a2..585aebbe 100644 --- a/profiles/http/src/main/resources/open-cli-schema/http/default_input_parameters_http.yaml +++ b/profiles/http/src/main/resources/open-cli-schema/http/default_input_parameters_http.yaml @@ -1,4 +1,4 @@ -# Copyright 2018 Huawei Technologies Co., Ltd. +# Copyright 2017-18 Huawei Technologies Co., Ltd. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -42,14 +42,14 @@ parameters: is_default_param: true - name: no-auth type: bool - description: whether to authenticate user or not + description: Whether to authenticate user or not short_option: a long_option: no-auth default_value: false is_default_param: true - name: no-catalog type: bool - description: whether to use given host-url directly without looking into catalog, it will override the service->mode. + description: Whether to use given host-url directly or discover it from catalog, it will override the service->mode. short_option: C long_option: no-catalog is_optional: true @@ -57,7 +57,9 @@ parameters: default_value: false - name: verify type: bool - description: 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. + description: | + Helps to verify the command using samples provides under open-cli-samples directory. By default, it goes with mock. + To enable the verification of samples in real time, set DISABLE_MOCKING=true in the context parameter. default_value: false is_include: true is_optional: true
\ No newline at end of file |