forked from vascoG/feup-lbaw
-
Notifications
You must be signed in to change notification settings - Fork 0
/
a7_openapi.yaml
1806 lines (1755 loc) · 60 KB
/
a7_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
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
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
version: '0.1'
title: 'LBAW FinJet Web API'
description: 'Recursos web (A7) para FinJet'
servers:
- url: http://lbaw2191.lbaw.fe.up.pt
description: 'Servidor de Produção'
externalDocs:
url: https://git.fe.up.pt/lbaw/lbaw2122/lbaw2191/-/wikis/home
description: 'Encontre mais informação na wiki'
tags:
- name: 'M01: Autenticação e perfil individual'
- name: 'M02: Administração de utilizadores e páginas estáticas'
- name: 'M03: Visualização, votação, pesquisa e resposta a questões'
- name: 'M04: Criação e edição de questões. Edição de respostas e comentários'
paths:
#MO1
/login:
get:
operationId: R101
summary: 'R101: Formulário de Login'
description: 'Providencia um formulário de login. Acesso: PUB'
tags:
- 'M01: Autenticação e perfil individual'
responses:
'200':
description: 'Ok. Mostra formulário de login'
post:
operationId: R102
summary: 'R102: Ação de Login'
description: 'Processa a submissão do formulário de login. Acesso: PUB'
tags:
- 'M01: Autenticação e perfil individual'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
email:
type: string
password:
type: string
required:
- email
- password
responses:
'302':
description: 'Redirecionar depois de processar as credenciais de login'
headers:
Location:
schema:
type: string
examples:
302Sucesso:
description: 'Autenticação sucedida. Redirecção para a homepage'
value: '/'
302SucessoBanido:
description: 'Autenticação sucedida. Utilizador banido.'
value: '/perfil/{nomeUtilizador}'
302Erro:
description: 'Autenticação falhou. Redirecção para a página de login'
value: '/login'
/recuperacao:
get:
operationId: 'R103'
summary: 'R103: Formulário de recuperação de password'
description: 'Providencia um formulário para recuperar o acesso à conta. Acesso: PUB'
tags:
- 'M01: Autenticação e perfil individual'
responses:
'200':
description: 'Ok. Mostra formulário de recuperação'
post:
operationId: 'R104'
summary: 'R104: Submissão de dados de recuperação'
description: 'Processa a submissão de dados de recuperação'
tags:
- 'M01: Autenticação e perfil individual'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
email:
type: string
required:
- email
responses:
'302':
description: 'Redirecção depois da submissão dos dados da conta'
headers:
Location:
schema:
type: string
examples:
302Sucesso:
description: 'Dados submetidos. Se a conta existir será recebido um email com dados de recuperação.'
value: '/login'
/logout:
post:
operationId: R105
summary: 'R105: Ação de logout'
description: 'Faz o logout do utilizador autenticado. Acesso: USR, MOD, ADM'
tags:
- 'M01: Autenticação e perfil individual'
responses:
'302':
description: 'Redirecção depois de processar o logout.'
headers:
Location:
schema:
type: string
examples:
302Sucesso:
description: 'Logout efetuado com sucesso'
value: '/'
'403':
description: 'O utilizador não estava autenticado.'
/login/registo:
get:
operationId: R106
summary: 'R106: Página de registo do utilizador'
description: 'Providencia a página de registo de utilizador. Acesso: PUB'
tags:
- 'M01: Autenticação e perfil individual'
responses:
'200':
description: 'Ok. Mostra página de registo'
post:
operationId: R107
summary: 'R107: Ação de registo'
description: 'Processa os dados da nova conta fornecidos pelo utilizador. Acesso: PUB'
tags:
- 'M01: Autenticação e perfil individual'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
nomeUtilizador:
type: string
nome:
type: string
dataNascimento:
type: string
format: date
example: '02-09-2001'
email:
type: string
password:
type: string
required:
- nomeUtilizador
- nome
- dataNascimento
- email
- password
responses:
'302':
description: 'Redirecção depois de processar dados fornecidos'
headers:
Location:
schema:
type: string
examples:
302Sucesso:
description: 'A conta foi corretamente criada'
value: '/perfil/{userName}'
302Erro:
description: 'Os dados fornecidos pelo cliente não são válidos.'
value: '/login/registo'
/perfil/{nomeUtilizador}:
get:
operationId: R108
summary: 'R108: Perfil do utilizador'
description: 'Mostra a informação do perfil de um utilizador. Acesso: PUB'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
responses:
'200':
description: 'Ok. Mostra o perfil do utilizador'
'302':
description: 'O utilizador autenticado não tem permissões suficientes. Por isso é redirecionado à página de login.'
headers:
Location:
schema:
type: string
examples:
302Sucesso:
description: 'Redireção à página de login'
value: '/login'
'404':
description: 'ID não existe. Mostra página de erro'
patch:
operationId: R109
summary: 'R109: Submete dados editados'
description: 'Processa os dados de perfil que foram editados pelo utilizador. Acesso: OWN'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
nome:
type: string
email:
type: string
dataNascimento:
type: string
format: date
example: '02-09-2001'
descricao:
type: string
password:
type: string
responses:
'302':
description: 'Redirecção ao processar dados enviados'
headers:
Location:
schema:
type: string
examples:
302Sucesso:
description: 'Dados alterados com sucesso'
value: '/perfil/{nomeUtilizador}'
303Erro:
description: 'Email duplicado'
value: '/perfil/{nomeUtilizador}/editar'
'404':
description: 'ID do utilizador não existe. Mostra erro.'
'403':
description: 'O utilizador autenticado não tem permissões suficientes.'
delete:
operationId: R110
summary: 'R110: Eliminar perfil'
description: 'Elimina o perfil. Acesso: OWN, ADM'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
responses:
'200':
description: 'Redirecionando após eliminar perfil.'
content:
application/json:
schema:
type: object
properties:
sucesso:
type: boolean
description: 'Indica se a eliminação foi bem sucedida.'
localizacao:
type: string
description: 'Caminho para o qual o utilizador deve ser redirecionado.'
'404':
description: 'Nome utilizador não existe.'
'403':
description: 'O utilizador não tem permissões suficientes.'
/perfil/{nomeUtilizador}/editar:
get:
operationId: R111
summary: 'R111: Edição do perfil do utilizador'
description: 'Mostra a página de edição do perfil de um utilizador. Acesso: OWN'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
responses:
'200':
description: 'Ok. Mostra a página de edição do perfil do utilizador'
'404':
description: 'ID do utilizador não existe. Mostra erro.'
'403':
description: 'ID encontrado, mas cliente não tem permissões de alteração'
/perfil/{nomeUtilizador}/imagem:
put:
operationId: R112
summary: 'R112: Alteração de imagem de perfil do utilizador'
description: 'Altera a imagem de perfil do utilizador para a imagem enviada. Acesso: OWN'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
imagem_perfil:
type: string
format: binary
responses:
'200':
description: 'Ok. Mostra o perfil do utilizador'
'404':
description: 'ID do utilizador não existe. Mostra erro.'
'403':
description: 'ID encontrado, mas cliente não tem permissões de alteração'
delete:
operationId: R113
summary: 'R113: Eleminação da página imagem de perfil'
description: 'Elimina a imagem de perfil de um utilizador. Acesso: OWN'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
responses:
'200':
description: 'Ok. Mostra o perfil do utilizador'
'404':
description: 'ID do utilizador não existe. Mostra erro.'
'403':
description: 'ID encontrado, mas cliente não tem permissões de alteração'
/perfil/{nomeUtilizador}/etiquetas:
get:
operationId: R114
summary: 'R114: Mostra a lista completa de etiquetas de um utilizador'
description: 'Mostra uma página com as etiquetas seguidas por um utilizador. Acesso: USR'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
responses:
200:
description: 'Ok. A página é mostrada.'
404:
description: 'O nome de utilizador referido não foi encontrado.'
302:
description: 'Redirecção ao verificar que utilizador não está autenticado'
headers:
Location:
schema:
type: string
examples:
302Login:
description: 'Página de Login'
value: '/login'
/perfil/{nomeUtilizador}/questoes:
get:
operationId: R115
summary: 'R115: Mostra a lista completa de questões de um utilizador'
description: 'Mostra uma página com as questões publicadas por um utilizador. Acesso: USR'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
responses:
200:
description: 'Ok. A página é mostrada.'
404:
description: 'O nome de utilizador referido não foi encontrado.'
302:
description: 'Redirecção ao verificar que utilizador não está autenticado'
headers:
Location:
schema:
type: string
examples:
302Login:
description: 'Página de Login'
value: '/login'
/perfil/{nomeUtilizador}/respostas:
get:
operationId: R116
summary: 'R116: Mostra a lista completa de questões respondidas por um utilizador'
description: 'Mostra uma página com as questões respondidas por um utilizador. Acesso: USR'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
responses:
200:
description: 'Ok. A página é mostrada.'
404:
description: 'O nome de utilizador referido não foi encontrado.'
302:
description: 'Redirecção ao verificar que utilizador não está autenticado'
headers:
Location:
schema:
type: string
examples:
302Login:
description: 'Página de Login'
value: '/login'
/perfil/{nomeUtilizador}/apelos:
get:
operationId: R117
summary: 'R117: Lista os apelos do utilizador.'
description: 'Mostra uma página com os apelos do utilizador. Se este puder fazer mais apelos é apresentado um formulário de apelos. Acesso: BAN'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
responses:
'200':
description: 'Ok. Mostra a página.'
'403':
description: 'O utilizador não está banido ou autenticado.'
post:
operationId: R118
summary: 'R118: Cria um novo apelo de desbloqueio.'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: nomeUtilizador
schema:
type: string
required: true
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
texto:
type: string
responses:
'302':
description: 'Redirecção ao processar dados enviados'
headers:
Location:
schema:
type: string
examples:
302Sucesso:
description: 'Apelo feito com sucesso'
value: '/perfil/{nomeUtilizador}/apelos'
303Erro:
description: 'Não são permitidos mais apelos'
value: '/perfil/{nomeUtilizador}/apelos'
/seguidos/etiqueta/{idEtiqueta}:
patch:
operationId: R119
summary: 'R119: Altera o estado da etiqueta em relação a um utilizador'
description: 'Se o utilizador referido seguir a etiqueta então deixará de a seguir, se não a seguir acontece o contrário. Acesso: OWN (em relação ao perfil)'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: idEtiqueta
schema:
type: integer
required: true
responses:
200:
description: 'A requisição foi processada com sucesso.'
content:
application/json:
schema:
type: object
properties:
novoEstado:
type: string
enum: [SEGUE, NAO_SEGUE]
description: 'Retorna o novo estado após processamento da requisição'
403:
description: 'A requisição foi rejeitada porque o utilizador não está autenticado.'
404:
description: 'A etiqueta não foi encontrada.'
/notificacoes:
get:
operationId: R120
summary: 'R120: Vista de Notificações'
description: 'Retorna código HTML equivalente à colocada no menu de notificações'
tags:
- 'M01: Autenticação e perfil individual'
responses:
403:
description: 'Utilizador não autenticado, não pode aceder a notificações'
200:
description: 'Retorna a vista de notificações.'
delete:
operationId: R121
summary: 'R121: Marca todas como lidas'
description: 'Marca todas as notificações do utilizador autenticado como lidas'
tags:
- 'M01: Autenticação e perfil individual'
responses:
403:
description: 'Utilizador não autenticado, não pode marcar notificações como lidas'
200:
description: 'Retorna a vista de notificações.'
/notificacao/{idNotificacao}:
delete:
operationId: R122
summary: 'R122: Marca notificação referida como lida'
description: 'Marca a notificação mencionada no path como lida'
tags:
- 'M01: Autenticação e perfil individual'
parameters:
- in: path
name: idNotificacao
schema:
type: integer
required: true
responses:
200:
description: 'Notificação marcada como lida'
403:
description: 'O utilizador não está autenticado ou não tem permissões sobre a notificação'
404:
description: 'Notificação referida não encontrada'
#M02
/sobrenos:
get:
operationId: R201
summary: 'R201: Sobre nós'
description: 'Mostra a página Sobre nós. Acesso: PUB'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
responses:
'200':
description: 'Ok. Mostra a página Sobre nós'
/contactos:
get:
operationId: R202
summary: 'R202: Contactos'
description: 'Mostra a página Contactos. Acesso: PUB'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
responses:
'200':
description: 'Ok. Mostra a página Contactos'
/faq:
get:
operationId: R203
summary: 'R203: FAQ'
description: 'Mostra a página FAQ. Acesso: PUB'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
responses:
'200':
description: 'Ok. Mostra a página FAQ'
/admin/moderadores:
get:
operationId: R204
summary: 'R204: Administração de moderadores do sistema'
description: 'Mostra a página de administração de moderadores do sistema. Acesso: ADM'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
responses:
'200':
description: 'Ok. Mostra a página de administração dos moderadores do sistema.'
content:
application/json:
schema:
type: array
items:
type: object
properties:
idUtilizador:
type: integer
'403':
description: 'O utilizador autenticado não tem permissões suficientes.'
/admin/moderadores/editar/{idUtilizador}:
patch:
operationId: R205
summary: 'R205: Alteração de permissões de moderador através do path'
description: 'Adiciona ou remove moderadores ao sistema. Acesso: ADM'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
parameters:
- in: path
name: idUtilizador
schema:
type: integer
required: true
responses:
200:
description: 'A requisição foi processada com sucesso.'
content:
application/json:
schema:
type: object
properties:
novoEstado:
type: string
enum: [MODERADOR, NAO_MODERADOR]
description: 'Retorna o novo estado após processamento da requisição'
403:
description: 'A requisição foi rejeitada porque o utilizador não tem permissão.'
404:
description: 'O utilizador não foi encontrado.'
/admin/banimento:
get:
operationId: R206
summary: 'R206: Administração de moderadores do sistema'
description: 'Mostra a página de apelos de banimento. Acesso: ADM'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
responses:
'200':
description: 'Ok. Mostra a página de apelos de banimento.'
content:
application/json:
schema:
type: array
items:
type: object
properties:
idApelo:
type: integer
'403':
description: 'O utilizador autenticado não tem permissões suficientes.'
post:
operationId: R207
summary: 'R207: Bloqueia contas'
description: 'Bloqueia contas. Acesso: ADM'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
idUtilizador:
type: integer
responses:
'302':
description: 'Redirecionando após bloquear a conta'
headers:
Location:
schema:
type: string
examples:
302Sucesso:
description: 'Bloqueio feito com sucesso. Redirecionando para a página de banimento'
value: '/admin/banimento'
302Erro:
description: 'Bloqueio de conta rejeitado. Redirecionando para a página de banimento'
value: '/admin/banimento'
/bloqueio/{idUtilizador}:
post:
operationId: R208
summary: '208: Bane um utilizador.'
description: 'Quando é feita com sucesso, o utilizador é banido. Acesso: ADM'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
parameters:
- in: path
name: idUtilizador
schema:
type: integer
required: true
responses:
'403':
description: 'O utilizador autenticado não tem permissões suficientes.'
'404':
description: 'O utilizador fornecido não existe.'
'302':
description: 'Redirecionando após bloquear ou desbloquear a conta'
headers:
Location:
schema:
type: string
examples:
302Sucesso:
description: 'Bloqueio feito com sucesso. Redirecionando o perfil.'
value: '/perfil/{idUtilizador}'
302Erro:
description: 'Bloqueio de conta rejeitado. Redirecionando o perfil.'
value: '/perfil/{idUtilizador}'
delete:
operationId: R209
summary: 'R209: Desbloqueia utilizador'
description: 'Quando é feito o pedido, o utilizador anteriormente banido é desbloqueado.'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
parameters:
- in: path
name: idUtilizador
schema:
type: integer
required: true
responses:
'403':
description: 'O utilizador autenticado não tem permissões suficientes.'
'404':
description: 'O utilizador fornecido não existe.'
'302':
description: 'Redirecionando após bloquear ou desbloquear a conta'
headers:
Location:
schema:
type: string
examples:
302Sucesso:
description: 'Bloqueio feito com sucesso. Redirecionando o perfil.'
value: '/perfil/{idUtilizador}'
302Erro:
description: 'Bloqueio de conta rejeitado. Redirecionando o perfil.'
value: '/perfil/{idUtilizador}'
/admin/etiquetas:
get:
operationId: R210
summary: 'R210: Apresenta a pagina de manuseio de etiquetas'
description: 'Apresenta a página de manuseio de etiquetas.'
parameters:
- in: query
name: query
description: 'Pesquisa de etiquetas por full-text search do seu nome'
schema:
type: string
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
responses:
'200':
description: 'Ok. Realiza as operações descritas'
'403':
description: 'O utilizador não tem permissoes para manusear etiquetas.'
post:
operationId: R211
summary: 'R211: Regista uma nova etiqueta'
description: 'Permite criar uma nova etiqueta. Acesso: ADM'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
nome:
type: string
required:
- nome
responses:
'200':
description: 'Ok. Realiza as operações descritas'
content:
application/json:
schema:
type: object
properties:
sucesso:
type: boolean
description: 'Descreve se a ação foi bem sucedida. Neste caso é sempre verdade.'
'400':
description: 'Os dados de input enviados são inválidos'
content:
application/json:
schema:
type: object
properties:
sucesso:
type: boolean
description: 'Descreve se a ação foi bem sucedida. Neste caso é sempre falso.'
erro:
type: object
properties:
nome:
type: array
items:
type: string
description: 'Lista com strings que informam o utilizador dos erros que ocorreram na validação.'
'403':
description: 'O utilizador não tem permissoes para manusear etiquetas.'
/admin/etiqueta/{id}:
patch:
operationId: R212
summary: 'R212: Altera a etiqueta referenciada no path.'
description: 'Permite alterar o texto de uma etiqueta existente. Acesso: ADM'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
parameters:
- in: path
name: id
schema:
type: integer
required: true
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
nome:
type: string
required:
- nome
responses:
'200':
description: 'Ok. Realiza as operações descritas'
content:
application/json:
schema:
type: object
properties:
sucesso:
type: boolean
description: 'Descreve se a ação foi bem sucedida. Neste caso é sempre verdade.'
'400':
description: 'Os dados de input enviados são inválidos'
content:
application/json:
schema:
type: object
properties:
sucesso:
type: boolean
description: 'Descreve se a ação foi bem sucedida. Neste caso é sempre falso.'
erro:
type: object
properties:
nome:
type: array
items:
type: string
description: 'Lista com strings que informam o utilizador dos erros que ocorreram na validação.'
'403':
description: 'O utilizador não tem permissoes para manusear etiquetas.'
'404':
description: 'A etiqueta referida não foi encontrada.'
delete:
operationId: R213
summary: 'R213: Apaga a etiqueta referenciada no path.'
description: 'Permite apagar uma etiqueta existente. Acesso: ADM'
tags:
- 'M02: Administração de utilizadores e páginas estáticas'
parameters:
- in: path
name: id
schema:
type: integer
required: true
responses:
'200':
description: 'Ok. Realiza as operações descritas'
content:
application/json:
schema:
type: object
properties:
sucesso:
type: boolean
description: 'Descreve se a ação foi bem sucedida. Neste caso é sempre verdade.'
'403':
description: 'O utilizador não tem permissoes para manusear etiquetas.'
'404':
description: 'A etiqueta referida não foi encontrada.'
#M03
/questao/{idQuestao}:
get:
operationId: R301
summary: 'R301: Visualização de questões.'
description: 'Mostra a página que apresenta a página de uma questão com as suas respostas e comentários. Acesso: PUB'
tags:
- 'M03: Visualização, votação, pesquisa e resposta a questões'
parameters:
- in: path
name: idQuestao
schema:
type: integer
required: true
responses:
'200':
description: 'Ok. Mostra a página da questão'
'404':
description: 'Erro. Questão com determinado id não encontrada'
/votar/questao/{idQuestao}:
get:
operationId: R302
summary: 'R302: Número de votos em questões. '
description: 'Retorna o número de votos numa questão. Acesso: PUB'
tags:
- 'M03: Visualização, votação, pesquisa e resposta a questões'
parameters:
- in: path
name: idQuestao
schema:
type: integer
required: true
responses:
'200':
description: 'Ok. Retorna os votos numa questão'
content:
application/json:
schema:
type: array
items:
type: object
properties:
nVotos:
type: integer
votada:
type: boolean
description: 'Representa se determinado utilizador votou na questão. Se o utilizador não estiver autenticado é sempre falso.'
'404':
description: 'Erro. Questão com determinado id não encontrada'
patch:
operationId: R303
summary: 'R303: Votação em questões.'
description: 'Processa um pedido de voto em determinada questão. Se a questão tiver o voto de quem fez o pedido o voto é retirado senão é colocado. Acesso: USR'
tags:
- 'M03: Visualização, votação, pesquisa e resposta a questões'
parameters:
- in: path
name: idQuestao
schema:
type: integer
required: true
responses:
'200':
description: 'Voto pôde ser processado. Retorna o novo estado do voto na questão'
content:
application/json:
schema: