-
Notifications
You must be signed in to change notification settings - Fork 1
/
api.yaml
566 lines (527 loc) · 14.2 KB
/
api.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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
---
openapi: 3.0.0
info:
title: API do app pixel
description: API do app pixel
contact:
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0
servers:
# Added by API Auto Mocking Plugin
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/lucas832/pixel_api/1.0.0
- url: localhost:3001
description: Instância local do pixel server
tags:
- name: comuns
description: Rotas que não exigem token
- name: trancadas
description: Rotas que exigem o token de login
paths:
/health:
get:
tags:
- comuns
summary: obtém status do servidor
description: |
Essa rota permite verificar se o servidor está em execução
operationId: searchInventory
responses:
"200":
description: O servidor está online
content:
application/json:
schema:
$ref: "#/components/schemas/HealthData"
"400":
description: bad input parameter
/login:
post:
tags:
- comuns
summary: efetua o login
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/LoginRequest"
responses:
"200":
description: usuário fez login
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/LoginResult"
/pixel/new:
post:
tags:
- trancadas
summary: cria um novo pixel
parameters:
- in: header
name: X-Access-Token
description: token de usuário obtido após fazer login
schema:
type: string
required: true
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/CreatePixelRequest"
responses:
"200":
description: o pixel foi criado
/features:
get:
tags:
- comuns
summary: obtém a lista de todos as características dos pixels
description: Retorna a lista de características possíveis de editar em um pixel
responses:
"200":
description: a lista de características foi obtida com sucesso
content:
application/json:
schema:
$ref: "#/components/schemas/FeedPixelBody"
"500":
description: erro interno do servidor. verifique se o banco de dados está funcionando
content:
application/json:
schema:
$ref: "#/components/schemas/GenericError"
/pixel/by-user:
get:
tags:
- comuns
summary: retorna os pixels de um usuário
parameters:
- in: query
name: mail
schema:
type: string
required: true
responses:
"200":
description: O usuário possui um pixel associado a ele
"400":
description: a requisição está inválida (nenhum parâmetro de busca foi passado)
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/GenericError"
"404":
description: usuário não foi encontrado/usuário não possui nenhum pixel
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/GenericError"
/pixel/{pixelId}/feed:
post:
tags:
- comuns
summary: alimenta um pixel pelo id
description: Pesquisa por um pixel com um determinado id e alimenta-o
parameters:
- name: "pixelId"
in: "path"
description: "id do pixel a ser alimentado"
required: true
content:
application/json:
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/FeedPixelBody"
responses:
"200":
description: o pixel foi alimentado
content:
application/json:
schema:
$ref: "#/components/schemas/FeedPixelBody"
"404":
description: o pixel não foi encontrado
content:
application/json:
schema:
$ref: "#/components/schemas/GenericError"
/register:
post:
tags:
- comuns
summary: cria um usuário
description: Cria um novo usuário no sisema
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/LoginRequest"
responses:
"200":
description: "usuário criado com sucesso"
content:
application/json:
schema:
$ref: "#/components/schemas/RegisterUserResponse"
"500":
description: "falha ao criar usuário (usuário já existe ou banco pode estar fora do ar)"
content:
application/json:
schema:
$ref: "#/components/schemas/GenericError"
/pixel/{pixelId}/features:
get:
tags:
- comuns
summary: obtém as características de um pixel
parameters:
- in: path
name: pixelId
schema:
type: integer
description: ID do pixel
required: true
responses:
"200":
description: as características foram obtidas com sucesso
content:
application/json:
schema:
$ref: "#/components/schemas/FeedPixelBody"
"404":
description: o pixel não existe
content:
application/json:
schema:
$ref: "#/components/schemas/GenericError"
/pixel/{pixelId}/feature/{featId}/enable:
post:
tags:
- comuns
summary: habilita/desabilita uma característica do pixel
parameters:
- in: path
name: pixelId
description: ID do pixel
schema:
type: integer
required: true
- in: path
name: featId
description: ID da característica
schema:
type: integer
required: true
responses:
"200":
description: as características foram atualizadas com sucesso
content:
application/json:
schema:
$ref: "#/components/schemas/FeaturesList"
"404":
description: pixel ou característica não foi encontrada
content:
application/json:
schema:
$ref: "#/components/schemas/GenericError"
/team/new:
post:
tags:
- comuns
summary: cria um novo time
responses:
"200":
description: o time foi criado com sucesso
content:
application/json:
schema:
$ref: "#/components/schemas/TeamCreated"
/team/{teamId}/pixel:
get:
tags:
- comuns
summary: obtém o pixel de um time
parameters:
- in: path
name: teamId
description: ID do time
schema:
type: integer
required: true
responses:
"204":
description: o time não possui pixel associado
"200":
description: o pixel foi obtido com sucesso
content:
application/json:
schema:
$ref: "#/components/schemas/PixelModel"
/team/{teamId}/pixel/{pixelId}/associate:
post:
tags:
- comuns
summary: associa um pixel a um time
parameters:
- in: path
name: teamId
description: ID do time de destino do pixel
schema:
type: integer
required: true
- in: path
name: pixelId
description: ID do pixel a ser associado
schema:
type: integer
required: true
responses:
"200":
description: o pixel foi associado com sucesso
content:
application/json:
schema:
$ref: "#/components/schemas/PixelModel"
"404":
description: pixel ou time não foram localizados
content:
application/json:
schema:
$ref: "#/components/schemas/GenericError"
"400":
description: o time já possui um pixel associado
content:
application/json:
schema:
$ref: "#/components/schemas/GenericError"
/teams:
get:
tags:
- comuns
summary: obtém a lista de times disponíveis
responses:
"200":
description: "a lista de times foi obtida com sucesso"
/pixel/:id/history:
get:
tags:
- trancadas
summary: obtém o histórico de alimentação do pixel
parameters:
- in: header
name: X-Access-Token
description: token de usuário obtido após fazer login
schema:
type: string
required: true
responses:
"200":
description: "O histórico de alimentação foi obtido com sucesso. Poderá retornar um array vazio caso o pixel não tenha sido alimentado anteriormente"
content:
application/json:
schema:
$ref: "#/components/schemas/FeedingHistoryData"
"404":
description: "O pixel em questão não existe"
content:
application/json:
schema:
$ref: "#/components/schemas/GenericError"
"511":
description: "Não foi possível autenticar o token"
components:
schemas:
FeedingHistoryData:
type: object
properties:
feature_name:
type: string
description: "Nome da característica do pixel"
fed_at:
type: string
description: "Data de alimentação do pixel"
fed_by:
type: integer
description: "ID do usuário que alimentou o pixel"
active:
type: boolean
description: "Contém flag para saber o estado da característica (ativada ou desativada)"
PixelModel:
type: object
properties:
id:
type: integer
name:
type: string
example: "pixel 15"
eye:
type: string
color:
type: string
example: "#00ff00"
createdAt:
type: string
example: "2022-02-16T01:36:00.678Z"
updatedAt:
type: string
example: "2022-02-17T01:36:00.678Z"
team_id:
type: integer
user_id:
type: integer
FeaturesList:
type: object
properties:
id:
type: integer
name:
type: string
value:
type: integer
active:
type: boolean
feeding_date:
type: string
TeamCreated:
type: object
properties:
id:
type: integer
description: ID do time criado
createdAt:
type: string
description: data de criação
updatedAt:
type: string
description: data de atualização
RegisterUserResponse:
type: object
properties:
id:
type: integer
description: ID do usuário criado
example: 1
registration:
type: string
description: matrícula do usuário criado
example: [email protected]
GenericError:
type: object
properties:
error:
type: string
description: mensagem de erro
example: "mensagem de erro qualquer"
HealthData:
type: object
properties:
message:
type: string
description: mensagem contendo o PID do servidor
example: server running with pid 10
LoginRequest:
required:
- registration
- password
type: object
properties:
registration:
type: string
description: matrícula do usuário
example: [email protected]
password:
type: string
description: senha do usuário
example: test1234@
LoginResult:
required:
- registration
- id
type: object
properties:
id:
type: integer
description: id do usuário criado
registration:
type: string
description: matrícula do usuário criado
CreatePixelRequest:
required:
- name
- eye
- color
type: object
properties:
name:
type: string
example: pixel 1
eye:
type: string
example: olho 1
color:
type: string
example: "#ff0011"
FeedPixelBody:
required:
- visibility
- match
- control
- consistence
- recognition
- efficiency
- minimalism
- error_prevention
properties:
visibility:
type: integer
description: visibilidade
example: 0
match:
type: integer
description: correspondência
example: 10
control:
type: integer
description: controle
example: 1
consistence:
type: integer
description: consistência
example: 2
recognition:
type: integer
description: reconhecimento
example: 3
efficiency:
type: integer
description: eficiência
example: 0
minimalism:
type: integer
description: minimalismo
example: 0
error_prevention:
type: integer
description: prevenção de erros
example: 0