open_cli_schema_version: 1.0
name: sample-test
description: Oclip sample command to test the command features
info:
  product: open-cli
  service: test
  type: cmd
  author: Kanagaraj Manickam kanagaraj.manickam@huawei.com
parameters:
  - name: bool-param
    type: bool
    description: Oclip boolean param, by default its always false.
    short_option: b
    long_option: bool
    is_optional: true
    default_value: false
    is_include: true
  - name: secure-param
    type: string
    description: Oclip secure param such as password
    short_option: x
    long_option: secure
    is_secured: true
    is_optional: true
    default_Value: pass123#
  - name: string-param
    type: string
    description: Oclip string param
    long_option: string-param
    short_option: c
    is_optional: true
    default_Value: test
  - name: yaml-param
    type: json
    description: Oclip yaml file location param
    long_option: yaml-param
    short_option: y
    is_optional: true
  - name: json-param
    type: json
    description: Oclip json file location param
    long_option: json-param
    short_option: j
    is_optional: true
    is_secured: false
  - name: long-param
    type: digit
    description: Oclip long param
    short_option: l
    long_option: long-opt
    is_optional: true
    default_value: 10
  - name: url-param
    type: url
    description: Oclip url param
    short_option: r
    long_option: url
    is_optional: true
    default_value: http://localhost:8082/file.txt
  - name: env-param
    type: string
    description: Oclip env param.
    short_option: z
    long_option: env
    is_optional: true
    default_value: ${ENV_VAR}
  - name: positional-args
    type: string
    description: Oclip positional args, if no short option and no long option given for it
    is_optional: true
    default_value: http://localhost:8082/file.txt
results:
  direction: portrait
  attributes:
    - name: output-1
      description: Oclip output attribute marked in short
      scope: short
      type: string
      is_secured: true
      default_value: req-$s{uuid}
    - name: output-2
      description: Oclip output attribute marked in long
      scope: short
      is_secured: false
      type: string
      default_value: Hello ${string-param} !