-
Notifications
You must be signed in to change notification settings - Fork 0
/
coder-arguments-schema.json
96 lines (96 loc) · 2.2 KB
/
coder-arguments-schema.json
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
89
90
91
92
93
94
95
96
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "argspec-v1.0.2-coder",
"title": "Argument Specification Schema",
"type": "object",
"properties": {
"$schema": {
"type": "string",
"description": "The schema followed by the JSON file"
},
"program": {
"type": "string",
"description": "The name of the program"
},
"args": {
"type": "array",
"items": {
"type": "object",
"properties": {
"short": {
"type": "string",
"description": "Concise variant of the argument (eg. -v)"
},
"long": {
"type": "string",
"description": "Verbose variant of the argument (eg. --verbose)"
},
"dest": {
"type": "string",
"description": "Internal destination of the value"
},
"metaDest": {
"type": "string",
"description": "A user-friendly name for the value, e.g. 'verbosity_level'"
},
"type": {
"type": "string",
"enum": [
"string",
"char",
"int",
"flag",
"help"
],
"description": "The type of the value or 'help' to output a help message and exit"
},
"default": {
"type": "string",
"description": "If left unspecified, the value taken by the argument"
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"description": "A set of values which may be taken by the argument. If omitted, values are unbounded"
},
"mandatory": {
"type": "boolean",
"description": "Indicates whether a omitting this argument would invalidate a call to the program",
"default": false
},
"help": {
"type": "string",
"description": "A short description of the argument"
}
},
"required": [
"dest",
"default"
],
"anyOf": [
{
"required": [
"short"
]
},
{
"required": [
"long"
]
}
],
"additionalProperties": false
},
"uniqueItems": true,
"additionalProperties": false,
"description": "List of the arguments accepted by the program"
}
},
"required": [
"program",
"args"
],
"description": "A schema for generating argument-parsers for arbitrary programs"
}