This repository has been archived by the owner on Jan 23, 2023. It is now read-only.
/
openapi.yaml
319 lines (319 loc) · 8.22 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
317
318
319
openapi: 3.0.0
info:
title: "PG Reloaded Control Plane API"
description: "An API to control a PG Reloaded instance"
version: 0.1.0
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
paths:
/environment:
get:
operationId: GetEnvironment
summary: Get the environment variables for running pg_reloaded
tags:
- system
responses:
'200':
description: Environment variables
/servers:
get:
summary: Get all registered servers
operationId: GetAllServers
responses:
'200':
description: servers response
content:
application/json:
schema:
$ref : '#/components/schemas/Server'
post:
summary: Register a server on pg_reloaded
operationId: RegisterServer
requestBody:
description: Server to add to the configuration
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Server'
responses:
'201':
description: server registered
content:
application/json:
schema:
$ref : '#/components/schemas/Server'
/servers/{name}:
get:
summary: Get server with specified name, name is case sensitive
operationId: GetServer
parameters:
- name: name
in: path
description: Name of Server to fetch
required: true
schema:
type: string
# format: underscore-lowercase
responses:
'201':
description: server registered
content:
application/json:
schema:
$ref : '#/components/schemas/Server'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
put:
summary: Update server configuration
operationId: UpdateServer
responses:
'200':
description: server updated
content:
application/json:
schema:
$ref : '#/components/schemas/Server'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
summary: Remove the server with the given name
operationId: DeleteServer
responses:
'200':
description: serer deleted response
/servers/{name}/password:
patch:
summary: Change the password associated with a server with the given name
operationId: UpdateServerPassword
requestBody:
description: Password for the server configuration
required: true
content:
text/plain:
schema:
required:
- password
properties:
password:
type: string
responses:
'200':
description: password changed
/databases:
get:
summary: Fetch all databases
operationId: FetchAllDatabases
responses:
'200':
description: All databases
content:
application/json:
schema:
$ref: '#/components/schemas/Databases'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
summary: Register Database
operationId: RegisterDatabase
responses:
'201':
description: Database registered
content:
application/json:
schema:
$ref: '#/components/schemas/Database'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/databases/{name}:
get:
summary: Fetch database with specified name
operationId: FetchDatabase
responses:
'200':
description: Database fetched
content:
application/json:
schema:
$ref: '#/components/schemas/Database'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
put:
summary: Update Database configuration
operationId: UpdateDatabaseConfig
responses:
'200':
description: Database updated
content:
application/json:
schema:
$ref: '#/components/schemas/Database'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
summary: Remove database from configuraiton
operationId: UnregisterDatabase
responses:
'200':
description: Database unregistered
content:
application/json:
schema:
properties:
message:
type: string
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/databases/{name}/files:
post:
summary: Upload files to use for database restoration
operationId: UploadFiles
responses:
'200':
description: Files uploaded
content:
application/json:
schema:
properties:
message:
type: string
default:
description: unexpected error uploading files
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/databases/{name}/restoration:
post:
summary: Perform restoration on database immediately
operationId: RestoreDatabaseNow
responses:
'201':
description: Operation started
content:
application/json:
schema:
properties:
message:
type: string
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/logs:
get:
summary: get logs
operationId: get logs from program
responses:
'200':
description: tail from the logs
content:
text/plain:
schema:
properties:
logline:
type: string
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
message:
type: string
code:
type: integer
Server:
type: object
required:
- name
- host
- port
- username
properties:
name:
type: string
host:
type: string
port:
type: integer
username:
type: string
password:
type: string
Servers:
type: array
items:
$ref: '#/components/schemas/Server'
Database:
type: object
required:
- name
- server
- schedule
- source
properties:
name:
type: string
server:
type: string
schedule:
type: string
source:
$ref: '#/components/schemas/Source'
Databases:
type: array
items:
$ref: '#/components/schemas/Database'
Source:
type: object
required:
- type
properties:
type:
type: string
file:
type: string
schema:
type: integer
files:
type: array
items:
type: string
format: File path