/
swagger.yaml
342 lines (342 loc) · 8.17 KB
/
swagger.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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
openapi: 3.0.1
info:
title: Artemis Web API
description:
"This is the documentation of the Artemis REST API accessible to normal\
\ users.\n \n In order to authenticate for the API: \n - Use the session cookie\
\ (get it with /api/auth/login/credentials or /api/auth/login/ldap) \n - The x-artemis-api-key\
\ header is used to circumvent the csrf protection."
version: 1.0.0
servers:
- url: https://artemis.grserver.gr/
tags:
- name: login
description: API for credentials and LDAP authentication
- name: user account
description: API related to the user's account
- name: session
description: API for handling the session state
- name: data
description: API for retrieving miscellaneous application data
paths:
/api/auth/login/credentials:
post:
tags:
- login
summary: User logs in with credentials (email/password).
operationId: credentials
parameters:
- name: x-artemis-api-key
in: header
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/loginBody"
required: true
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/user"
x-codegen-request-body-name: body
/api/auth/login/ldap:
post:
tags:
- login
summary: User logs in with her ldap credentials (email/password).
operationId: ldap
parameters:
- name: x-artemis-api-key
in: header
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/loginBody"
required: true
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/user"
x-codegen-request-body-name: body
/api/auth/logout:
delete:
tags:
- login
summary: User logout
operationId: logoutp
parameters:
- name: x-artemis-api-key
in: header
required: true
schema:
type: string
format: uuid
- in: cookie
name: sid
required: true
schema:
type: string
responses:
204:
description: User logged out.
content: {}
/api/auth/change-password:
put:
tags:
- user account
summary: Change user's password
operationId: changePass
parameters:
- name: x-artemis-api-key
in: header
required: true
schema:
type: string
format: uuid
- in: cookie
name: sid
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/passBody"
required: true
responses:
200:
description: Your password has been updated.
content: {}
300:
description: Old password is wrong or password missmatch.
content: {}
x-codegen-request-body-name: body
/api/auth/jwt:
get:
tags:
- session
summary: Retrieve JWT.
operationId: jwt
parameters:
- name: x-artemis-api-key
in: header
required: true
schema:
type: string
format: uuid
- in: cookie
name: sid
required: true
schema:
type: string
responses:
200:
description: JWT retrieved.
content:
application/json:
schema:
$ref: "#/components/schemas/jwt"
/api/auth/signup:
post:
tags:
- user account
summary: Create new account
operationId: signup
parameters:
- name: x-artemis-api-key
in: header
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/signupBody"
required: true
responses:
200:
description: user created
content: {}
400:
description: missing fields or invalid email.
content: {}
403:
description: The email has already been used.
content: {}
x-codegen-request-body-name: body
/api/auth/userinfo:
get:
tags:
- user account
summary: Get user information
operationId: userifo
parameters:
- name: x-artemis-api-key
in: header
required: true
schema:
type: string
format: uuid
- in: cookie
name: sid
required: true
schema:
type: string
responses:
200:
description: user
content:
application/json:
schema:
$ref: "#/components/schemas/user"
/api/configs:
get:
tags:
- data
summary: Get the configuration data
operationId: configinfo
parameters:
- name: x-artemis-api-key
in: header
required: true
schema:
type: string
format: uuid
- in: cookie
name: sid
required: true
schema:
type: string
responses:
200:
description: configs
content:
application/json:
schema:
$ref: "#/components/schemas/configs"
/api/download_tables:
post:
tags:
- data
summary: Get data for the table described in the action field, in json format
operationId: downloadtable
parameters:
- name: x-artemis-api-key
in: header
required: true
schema:
type: string
format: uuid
- in: cookie
name: sid
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/tableBody"
required: true
responses:
200:
description: table
content:
application/json:
schema:
$ref: "#/components/schemas/table"
x-codegen-request-body-name: body
components:
schemas:
loginBody:
type: object
properties:
email:
type: string
password:
type: string
rememberMe:
type: boolean
signupBody:
type: object
properties:
email:
type: string
password:
type: string
name:
type: string
tableBody:
type: object
properties:
action:
type: string
parameters:
type: string
jwt:
type: object
properties:
accessToken:
type: string
passBody:
type: object
properties:
old_password:
type: string
new_password:
type: string
user:
type: object
properties:
user:
type: object
properties:
_id:
type: string
name:
type: string
email:
type: string
role:
type: string
lastLogin:
type: string
sessionId:
type: string
configs:
type: object
properties:
configs:
type: array
items:
type: object
properties:
raw_config:
type: string
comment:
type: string
time_modified:
type: string
table:
type: array
items:
type: object
properties: {}