forked from kimchi-project/ginger
-
Notifications
You must be signed in to change notification settings - Fork 0
/
API.json
100 lines (100 loc) · 3.26 KB
/
API.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
97
98
99
100
{
"$schema": "http://json-schema.org/draft-03/schema#",
"title": "Ginger Plugin API",
"description": "JSON schema for Kimchi's Ginger Plugin API",
"type": "object",
"properties": {
"firmware_update": {
"type": "object",
"properties": {
"path": {
"description": "The full path to the firmware archive",
"type": "string",
"required": true
}
}
},
"powerprofile_update": {
"type": "object",
"properties": {
"active": {
"description": "State of the profile",
"type": "boolean",
"required": true
}
}
},
"users_create": {
"type": "object",
"error": "GINUSER0001E",
"properties": {
"name": {
"description": "The login name of the new user",
"type": "string",
"required": true,
"error": "GINUSER0002E"
},
"password": {
"description": "The new user password",
"type": "string",
"required": true,
"error": "GINUSER0003E"
},
"group": {
"description": "The group name of the new user",
"type": "string",
"required": true,
"error": "GINUSER0004E"
},
"profile": {
"description": "The profile of the new user",
"type": "string",
"pattern": "^kimchiuser|virtuser|admin$",
"required": true,
"error": "GINUSER0005E"
}
}
},
"network_update": {
"type": "object",
"properties": {
"nameservers": {
"description": "DNS Servers",
"type": "array",
"items": {
"type": "string",
"format": "ip-address"
},
"minItems": 1,
"uniqueItems": true,
"error": "GINNET0005E"
}
}
},
"interface_update": {
"type": "object",
"properties": {
"ipaddr": {
"description": "Interface IP address",
"type": "string",
"format": "ip-address",
"required": true,
"error": "GINNET0006E"
},
"netmask": {
"description": "Interface netmask",
"type": "string",
"format": "ip-address",
"required": true,
"error": "GINNET0007E"
},
"gateway": {
"description": "Network gateway",
"type": "string",
"format": "ip-address",
"error": "GINNET0008E"
}
}
}
}
}