summaryrefslogtreecommitdiffstats
path: root/main/src/test/resources/open-cli-schema/sample-test-schema.yaml
blob: 584eec879ec25b19fb9c0039066a0e76ddf0b0e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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
  - 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
  - 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}
    default_value: http://localhost:8082/file.txt
  - 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
  - name: text-param
    type: text
    description: Oclip text file location param
    long_option: text-param
    short_option: e
    is_optional: true
results:
  direction: portrait
  attributes:
    - name: output-1
      description: Oclip output attribute marked in short
      scope: short
      type: string
    - name: output-2
      description: Oclip output attribute marked in long
      scope: short
      type: string