forked from bottlerocket-os/bottlerocket
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
316 lines (303 loc) · 9.17 KB
/
openapi.yaml
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
openapi: "3.0.2"
info:
version: "0.1.0"
title: "Bottlerocket API"
description: "The API for the Bottlerocket OS"
license:
name: "Apache-2.0 OR MIT"
url: "https://github.com/bottlerocket-os/bottlerocket/blob/develop/COPYRIGHT"
servers:
- url: file:https:///run/api.sock
description: The production API server
paths:
/settings:
get:
summary: "Get current settings"
operationId: "get_settings"
parameters:
- in: query
name: keys
description: "Specific keys to query. Takes precedence over 'prefix' if both query parameters are supplied"
schema:
type: array
items:
type: string
# `style: form` and `explode: false` format parameters as such: /settings?keys=foo,bar,baz
style: form
explode: false
required: false
- in: query
name: prefix
description: "Specific key prefix to query. This parameter will be ignored if 'keys' is also supplied"
schema:
type: string
required: false
responses:
200:
description: "Successful request"
content:
application/json:
schema:
$ref: "Settings"
500:
description: "Server error"
patch:
summary: "Update settings"
operationId: "set_settings"
parameters:
- in: query
name: tx
description: "Transaction in which to update settings; defaults to user 'default' transaction"
schema:
type: string
required: false
requestBody:
required: true
content:
application/json:
schema:
$ref: "Settings"
responses:
204:
description: "Settings successfully staged for update"
400:
description: "Invalid body"
500:
description: "Server error"
/tx:
get:
summary: "Get pending settings in a transaction"
operationId: "get_tx"
parameters:
- in: query
name: tx
description: "Transaction for which to retrieve pending settings; defaults to user 'default' transaction"
schema:
type: string
required: false
responses:
200:
description: "Successful request"
content:
application/json:
schema:
$ref: "Settings"
500:
description: "Server error"
delete:
summary: "Delete transaction"
operationId: "delete_tx"
parameters:
- in: query
name: tx
description: "Transaction to delete; defaults to user 'default' transaction"
schema:
type: string
required: false
responses:
200:
description: "Successful deleted pending settings - deleted keys are returned"
500:
description: "Server error"
/tx/list:
get:
summary: "List names of pending transactions"
operationId: "list_tx"
responses:
200:
description: "Successful request"
content:
application/json:
schema:
type: array
items:
type: string
500:
description: "Server error"
/tx/commit:
post:
summary: "Commit pending settings, without applying changes to config files or restarting services"
operationId: "commit_tx"
parameters:
- in: query
name: tx
description: "Transaction to commit; defaults to user 'default' transaction"
schema:
type: string
required: false
responses:
200:
description: "Successfully Staged settings - changed keys are returned"
500:
description: "Server error"
/tx/apply:
post:
summary: "Apply changes to config files and restart services"
operationId: "apply"
parameters:
- in: query
name: keys
description: "Apply changes only if related to these keys; if not specified, applies for all known keys"
schema:
type: array
items:
type: string
# `style: form` and `explode: false` format parameters as such: /tx/apply?keys=settings.foo,settings.bar
style: form
explode: false
required: false
responses:
204:
description: "Successfully started settings applier"
500:
description: "Server error"
/tx/commit_and_apply:
post:
summary: "Commit transaction, and apply any committed changes to relevant config files and services"
operationId: "commit_tx_and_apply"
parameters:
- in: query
name: tx
description: "Transaction to commit; defaults to user 'default' transaction"
schema:
type: string
required: false
responses:
200:
description: "Successful settings update, committed keys are returned"
500:
description: "Server error"
/os:
get:
summary: "Get OS information such as version, variant, and architecture"
operationId: "get_os_info"
responses:
200:
description: "Successful request"
content:
application/json:
# The response is a hashmap of string to string. Example:
# { "arch": "x86_64" }
schema:
type: object
additionalProperties:
type: string
500:
description: "Server error"
/metadata/affected-services:
get:
summary: "Get affected services"
operationId: "get_affected_services"
parameters:
- in: query
name: keys
description: "Specific keys to query"
schema:
type: array
items:
type: string
# `style: form` and `explode: false` format parameters as such: /metadata/affected-services?keys=settings.foo,settings.bar
style: form
explode: false
required: true
responses:
200:
description: "Successful request"
content:
application/json:
# The response is a hashmap of string to array of strings. Example:
# { "settings.foo": [ "service1", "service2" ] }
schema:
type: object
additionalProperties:
type: array
items:
type: string
400:
description: "Missing required query parameter: 'keys'"
500:
description: "Server error"
/metadata/setting-generators:
get:
summary: "Get programs needed to generate settings"
operationId: "get_setting_generators"
responses:
200:
description: "Successful request"
content:
application/json:
# The response is a hashmap of string to string. Example:
# { "settings.foobar": "/usr/bin/foobar" }
schema:
type: object
additionalProperties:
type: string
500:
description: "Server error"
/metadata/templates:
get:
summary: "Get template strings for dynamically generated settings"
operationId: "get_templates"
responses:
200:
description: "Successful request"
content:
application/json:
# The response is a hashmap of string to string. Example:
# { "settings.foobar": "hi {{ key }}" }
schema:
type: object
additionalProperties:
type: string
500:
description: "Server error"
/services:
get:
summary: "Get service data"
operationId: "get_services"
parameters:
- in: query
name: names
description: "Specific services to query"
schema:
type: array
items:
type: string
# `style: form` and `explode: false` format parameters as such: /services?names=foo,bar,baz
style: form
explode: false
required: false
responses:
200:
description: "Successful request"
content:
application/json:
schema:
$ref: "Services"
500:
description: "Server error"
/configuration-files:
get:
summary: "Get configuration file data"
operationId: "get_config_files"
parameters:
- in: query
name: names
description: "Specific configuration files to query"
schema:
type: array
items:
type: string
# `style: form` and `explode: false` format parameters as such: /configuration-files?names=file1,file2
style: form
explode: false
required: false
responses:
200:
description: "Successful request"
content:
application/json:
schema:
$ref: "ConfigurationFiles"
500:
description: "Server error"