products/sample/src/main/resources/open-cli-schema/hello-world-http.yaml

   1 # Copyright 2017-18 Huawei Technologies Co., Ltd.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 open_cli_schema_version: 1.0
  16
  17 name: hello-world-http
  18
  19 description: |
  20    First cmd hello world using http runing under
  21    lighttpd in cli at http://<cli-ip>:8080/version.json
  22
  23 info:
  24   product: sample-helloworld
  25   service: hello-world
  26   author: ONAP CLI Team onap-discuss@lists.onap.org
  27
  28 parameters:
  29     - name: name
  30       description: name of the person
  31       long_option: name
  32       short_option: b
  33       default_value: ${DEMO_NAME}
  34       type: string
  35       is_optional: false
  36
  37 results:
  38     direction: landscape
  39     attributes:
  40       - name: output
  41         description: hello world output
  42         type: string
  43         scope: short
  44
  45 http:
  46     service:
  47         name: sample-service
  48         version: 1.0.0
  49         auth: none
  50         mode: direct
  51
  52     request:
  53         uri: /version.json
  54         method: GET
  55     success_codes:
  56         - 200
  57         - 201
  58     result_map:
  59         output: Hello ${name}, You are running on $b{$.name} $b{$.version}
  60
  61     sample_response:
  62         body: {"name": "oclip", "version": "1.0"}