aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/main/resources/open-cli-schema/default_input_parameters.yaml
blob: aab749867f3fb67db45a8907edae4ca2d663dd32 (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
# Copyright 2018 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.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

open_cli_schema_version: 1.0

parameters:
  - name: help
    type: bool
    description: print help message
    short_option: h
    long_option: help
    default_value: false
    is_default_param: true
  - name: version
    type: bool
    description: print service version
    short_option: v
    long_option: version
    default_value: false
    is_default_param: true
  - name: debug
    type: bool
    description: Enable debug output
    short_option: d
    long_option: debug
    default_value: false
    is_default_param: true
  - name: format
    type: string
    description: Output formats, supported formats such as table, csv, json, yaml
    short_option: f
    long_option: format
    default_value: table
    is_default_param: true
  - name: long
    type: bool
    description: whether to print all attributes or only short attributes
    short_option: s
    long_option: long
    default_value: false
    is_default_param: true
  - name: no-title
    type: bool
    description: whether to print title or not
    short_option: t
    long_option: no-title
    default_value: false
    is_default_param: true
  - 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.
    short_option: V
    long_option: verify
    default_value: false
    is_default_param: true
    is_include: false
    is_optional: true
  - name: context
    type: map
    description: command context
    short_option: D
    long_option: context
    is_default_param: true
    is_optional: true
    is_optional: true