framework/src/test/resources/open-cli-schema/sample-test-schema.yaml

   1 # Copyright 2018 Huawei Technologies Co., Ltd.
   2 # Copyright 2020 Nokia
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 open_cli_schema_version: 1.0
  17 name: sample-test
  18 description: Oclip sample command to test the command features
  19 info:
  20   product: open-cli
  21   service: test
  22   type: cmd
  23   author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
  24   state: experimental
  25   metadata:
  26     release: honolulu
  27 parameters:
  28   - name: bool-param
  29     type: bool
  30     description: Oclip boolean param, by default its always false.
  31     short_option: b
  32     long_option: bool
  33     is_optional: true
  34     default_value: false
  35     is_include: true
  36   - name: secure-param
  37     type: string
  38     description: Oclip secure param such as password
  39     short_option: x
  40     long_option: secure
  41     is_secured: true
  42     is_optional: true
  43     default_value: pass123#
  44   - name: string-param
  45     type: string
  46     description: Oclip string param
  47     long_option: string-param
  48     short_option: c
  49     is_optional: true
  50     default_value: test
  51   - name: yaml-param
  52     type: json
  53     description: Oclip yaml file location param
  54     long_option: yaml-param
  55     short_option: y
  56     is_optional: true
  57   - name: json-param
  58     type: json
  59     description: Oclip json file location param
  60     long_option: json-param
  61     short_option: j
  62     is_optional: true
  63     is_secured: false
  64   - name: long-param
  65     type: digit
  66     description: Oclip long param
  67     short_option: l
  68     long_option: long-opt
  69     is_optional: true
  70     default_value: 10
  71   - name: url-param
  72     type: url
  73     description: Oclip url param
  74     short_option: r
  75     long_option: url
  76     is_optional: true
  77     default_value: http://localhost:8082/file.txt
  78   - name: env-param
  79     type: string
  80     description: Oclip env param.
  81     short_option: z
  82     long_option: env
  83     is_optional: true
  84     default_value: ${ENV_VAR}
  85   - name: positional-args
  86     type: string
  87     description: Oclip positional args, if no short option and no long option given for it
  88     is_optional: true
  89     default_value: http://localhost:8082/file.txt
  90   - name: array-param
  91     type: array
  92     description: list parameter
  93     long_option: list-param
  94     short_option: q
  95     is_optional: true
  96 results:
  97   direction: portrait
  98   attributes:
  99     - name: output-1
 100       description: Oclip output attribute marked in short
 101       scope: short
 102       type: string
 103       is_secured: true
 104       default_value: req-$s{uuid}
 105     - name: output-2
 106       description: Oclip output attribute marked in long
 107       scope: short
 108       is_secured: false
 109       type: string
 110       default_value: Hello ${string-param} !