-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yaml
1193 lines (1186 loc) · 40.7 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
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.1.0
info:
version: 1.0.0
title: Reconstrua API
description: >-
A API do Reconstrua é uma plataforma inovadora que conecta pessoas em situação de rua ou afetadas por tragédias com voluntários dispostos a ajudar. Através de nossa API, é possível gerenciar empresas, voluntários, beneficiados e administradores, facilitando o processo de doação, alojamento e apoio emocional. Nossa missão é transformar vidas através da solidariedade e da tecnologia, proporcionando moradia e esperança para aqueles que mais precisam.
[Frontend Recontrua](https://reconstrua.netlify.app/)
tags:
- name: admin login
description: Esta rota permite que os administradores façam login na plataforma, garantindo acesso exclusivo a rotas e funcionalidades administrativas
- name: admin
description: Essas rotas permitem gerenciar os administradores
- name: beneficiary
description: Essas rotas permitem gerenciar os beneficiados cadastrados
- name: company
description: Essas rotas permitem gerenciar as empresas cadastradas
- name: voluntary
description: Essas rotas permitem gerenciar os voluntários cadastrados
paths:
# ADMIN LOGIN
/api/admins/login:
post:
tags:
- admin login
operationId: postLoginAdmin
summary: Autenticação de administradores
description: |
utilize o username: admin e password: admin para autenticar-se.
Após a autenticação bem-sucedida, o administrador receberá um token de acesso que pode ser usado para acessar rotas protegidas e gerenciar a plataforma.
requestBody:
description: Os dados necessários para autenticação de admin devem ser especificados usando o formato JSON no corpo da requisição.
$ref: "#/components/requestBodies/LoginAdmin"
responses:
"200":
description: Login realizado com sucesso e token de autenticação retornado no corpo da resposta.
$ref: "#/components/responses/Success/LoginAdmin"
"401":
description: Credenciais inválidas.
$ref: "#/components/responses/Error"
"422":
description: Pelo menos um dos valores enviado no corpo da requisição é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar autenticar administrador
$ref: "#/components/responses/Error"
# ADMIN GET
/api/admins:
get:
tags:
- admin
operationId: getAdmins
summary: Busca todos os administradores existentes
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
responses:
"200":
description: Administradores buscados com sucesso e retornados no corpo da resposta.
$ref: "#/components/responses/Success/GetAdmins"
"404":
description: Nenhum administrador encontrado.
$ref: "#/components/responses/Error"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"500":
description: O servidor encontrou um erro ao buscar administradores
$ref: "#/components/responses/Error"
# ADMIN UPDATE
/api/admins/{admin_id}:
put:
tags:
- admin
operationId: putAdmin
summary: Atualiza administrador
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
parameters:
- name: admin_id
in: path
description: ID do administrador a ser atualizado
required: true
schema:
type: string
format: uuid
requestBody:
description: Os dados necessários para atualização de admin devem ser especificados usando o formato JSON no corpo da requisição.
$ref: "#/components/requestBodies/UpdateAdmin"
responses:
"200":
description: Admin atualizado com sucesso.
$ref: "#/components/responses/Success/Default"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"422":
description: Pelo menos um dos valores enviado no corpo ou parâmetro da requisição é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar autenticar administrador
$ref: "#/components/responses/Error"
# VOLUNTARY
/api/voluntaries:
post:
tags:
- voluntary
operationId: postVoluntary
summary: Cadastra um voluntário
description: Cadastra um novo voluntário.
requestBody:
description: Os dados necessários para cadastro de voluntário devem ser especificados usando o formato JSON no corpo da requisição.
$ref: "#/components/requestBodies/Voluntary"
responses:
"201":
description: Voluntário cadastrado com sucesso.
$ref: "#/components/responses/Success/Default"
"409":
description: Voluntário já cadastrado.
$ref: "#/components/responses/Error"
"422":
description: Pelo menos um dos valores enviado no corpo da requisição é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar cadastrar um voluntário
$ref: "#/components/responses/Error"
get:
tags:
- voluntary
operationId: getAllVoluntaries
summary: Busca todos os voluntários existentes
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
responses:
"200":
description: Voluntários buscados com sucesso e retornados no corpo da resposta.
$ref: "#/components/responses/Success/GetVoluntaries"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"404":
description: Voluntários não encontrados.
$ref: "#/components/responses/Error"
"500":
description: O servidor encontrou um erro ao tentar cadastrar um voluntário
$ref: "#/components/responses/Error"
/api/voluntaries/{voluntary_id}:
get:
tags:
- voluntary
operationId: getVoluntaryById
summary: Busca um voluntário
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
parameters:
- name: voluntary_id
in: path
description: ID do voluntário a ser buscado
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Voluntário buscado com sucesso e retornado no corpo da resposta.
$ref: "#/components/responses/Success/GetVoluntary"
"404":
description: Voluntário não encontrado.
$ref: "#/components/responses/Error"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"422":
description: ID de voluntário fornecido é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar cadastrar um voluntário
$ref: "#/components/responses/Error"
put:
tags:
- voluntary
operationId: updateVoluntary
summary: Atualiza um voluntário
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
parameters:
- name: voluntary_id
in: path
description: ID do voluntário a ser atualizado
required: true
schema:
type: string
format: uuid
requestBody:
description: Os dados necessários para atualização de voluntário devem ser especificados usando o formato JSON no corpo da requisição.
$ref: "#/components/requestBodies/Voluntary"
responses:
"200":
description: Voluntário atualizado com sucesso.
$ref: "#/components/responses/Success/Default"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"404":
description: Voluntário não encontrado.
$ref: "#/components/responses/Error"
"422":
description: Pelo menos um dos valores enviado no corpo ou parâmetro da requisição é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar atualizar voluntário
$ref: "#/components/responses/Error"
delete:
tags:
- voluntary
operationId: deleteVoluntary
summary: Deleta um voluntário
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
parameters:
- name: voluntary_id
in: path
description: ID do voluntário a ser deletado
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Voluntário deletado com sucesso.
$ref: "#/components/responses/Success/Default"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"404":
description: Voluntário não encontrado.
$ref: "#/components/responses/Error"
"422":
description: ID do voluntário fornecido é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar deletar voluntário
$ref: "#/components/responses/Error"
# BENEFICIARY
/api/beneficiaries:
post:
tags:
- beneficiary
operationId: postBeneficiary
summary: Cadastra um beneficiado
description: Cadastra um novo beneficiado.
requestBody:
description: Os dados necessários para cadastro de beneficiado devem ser especificados usando o formato JSON no corpo da requisição.
$ref: "#/components/requestBodies/Beneficiary"
responses:
"201":
description: Beneficiado cadastrado com sucesso.
$ref: "#/components/responses/Success/Default"
"409":
description: Beneficiado já cadastrado.
$ref: "#/components/responses/Error"
"422":
description: Pelo menos um dos valores enviado no corpo da requisição é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar cadastrar um beneficiado.
$ref: "#/components/responses/Error"
get:
tags:
- beneficiary
operationId: getAllBeneficiaries
summary: Busca todos os beneficiados existentes
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
responses:
"200":
description: Voluntários buscados com sucesso e retornados no corpo da resposta.
$ref: "#/components/responses/Success/GetBeneficiaries"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"404":
description: Beneficiados não encontrados.
$ref: "#/components/responses/Error"
"500":
description: O servidor encontrou um erro ao tentar buscar beneficiados.
$ref: "#/components/responses/Error"
/api/beneficiaries/{beneficiary_id}:
get:
tags:
- beneficiary
operationId: getBeneficiaryById
summary: Busca um beneficiado
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
parameters:
- name: beneficiary_id
in: path
description: ID do beneficiado a ser buscado
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Beneficiado buscado com sucesso e retornado no corpo da resposta.
$ref: "#/components/responses/Success/GetBeneficiary"
"404":
description: Beneficiado não encontrado.
$ref: "#/components/responses/Error"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"422":
description: ID de beneficiado fornecido é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar buscar beneficiado.
$ref: "#/components/responses/Error"
put:
tags:
- beneficiary
operationId: updateBeneficiary
summary: Atualiza um beneficiado
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
parameters:
- name: beneficiary_id
in: path
description: ID do beneficiado a ser atualizado
required: true
schema:
type: string
format: uuid
requestBody:
description: Os dados necessários para atualização de beneficiado devem ser especificados usando o formato JSON no corpo da requisição.
$ref: "#/components/requestBodies/Beneficiary"
responses:
"200":
description: Beneficiado atualizado com sucesso.
$ref: "#/components/responses/Success/Default"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"404":
description: Beneficiado não encontrado.
$ref: "#/components/responses/Error"
"422":
description: Pelo menos um dos valores enviado no corpo ou parâmetro da requisição é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar atualizar beneficiado.
$ref: "#/components/responses/Error"
delete:
tags:
- beneficiary
operationId: deleteBeneficiary
summary: Deleta um beneficiado
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
parameters:
- name: beneficiary_id
in: path
description: ID do beneficiado a ser deletado
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Beneficiado deletado com sucesso.
$ref: "#/components/responses/Success/Default"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"404":
description: Beneficiado não encontrado.
$ref: "#/components/responses/Error"
"422":
description: ID do beneficiado fornecido é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar deletar beneficiado.
$ref: "#/components/responses/Error"
# COMPANY
/api/companies:
post:
tags:
- company
operationId: postCompany
summary: Cadastra uma empresa
description: Cadastra uma empresa parceira.
requestBody:
description: Os dados necessários para cadastro da empresa devem ser especificados usando o formato JSON no corpo da requisição.
$ref: "#/components/requestBodies/Company"
responses:
"201":
description: Empresa cadastrada com sucesso.
$ref: "#/components/responses/Success/Default"
"409":
description: Empresa já cadastrada.
$ref: "#/components/responses/Error"
"422":
description: Pelo menos um dos valores enviado no corpo da requisição é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar cadastrar uma empresa.
$ref: "#/components/responses/Error"
get:
tags:
- company
operationId: getAllCompanies
summary: Busca todas os empresas cadastradas
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
responses:
"200":
description: Empresas buscadas com sucesso e retornadas no corpo da resposta.
$ref: "#/components/responses/Success/GetCompanies"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"404":
description: Empresas não encontradas.
$ref: "#/components/responses/Error"
"500":
description: O servidor encontrou um erro ao tentar buscar empresas.
$ref: "#/components/responses/Error"
/api/companies/{company_id}:
get:
tags:
- company
operationId: getCompanyById
summary: Busca uma empresa
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
parameters:
- name: company_id
in: path
description: ID da empresa a ser buscada
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Empresa buscada com sucesso e retornada no corpo da resposta.
$ref: "#/components/responses/Success/GetCompany"
"404":
description: Empresa não encontrada.
$ref: "#/components/responses/Error"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"422":
description: ID de beneficiado fornecido é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar buscar uma empresa.
$ref: "#/components/responses/Error"
put:
tags:
- company
operationId: updateCompany
summary: Atualiza uma empresa
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
parameters:
- name: company_id
in: path
description: ID da empresa a ser atualizada
required: true
schema:
type: string
format: uuid
requestBody:
description: Os dados necessários para atualização da empresa devem ser especificados usando o formato JSON no corpo da requisição.
$ref: "#/components/requestBodies/Company"
responses:
"200":
description: Empresa atualizada com sucesso.
$ref: "#/components/responses/Success/Default"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"404":
description: Empresa não encontrada.
$ref: "#/components/responses/Error"
"422":
description: Pelo menos um dos valores enviado no corpo ou parâmetro da requisição é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar atualizar empresa.
$ref: "#/components/responses/Error"
delete:
tags:
- company
operationId: deleteCompany
summary: Deleta uma empresa
description: Para utilizar essa rota é preciso estar autenticado, realize o login e insira o token de autenticação no authorize.
security:
- bearerAuth: []
parameters:
- name: company_id
in: path
description: ID da empresa a ser deletada
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Empresa deletada com sucesso.
$ref: "#/components/responses/Success/Default"
"401":
description: Você não está autenticado como administrador.
$ref: "#/components/responses/Error"
"404":
description: Empresa não encontrada.
$ref: "#/components/responses/Error"
"422":
description: ID da empresa fornecido é inválido.
$ref: "#/components/responses/Error422"
"500":
description: O servidor encontrou um erro ao tentar deletar empresa.
$ref: "#/components/responses/Error"
components:
schemas:
# ADMIN
LoginAdmin:
type: object
properties:
username:
type: string
examples: [admin]
password:
type: string
examples: [admin]
required:
- username
- password
UpdateAdmin:
type: object
properties:
username:
type: string
examples: [string]
Admin:
type: object
properties:
id:
type: string
format: uuid
username:
type: string
format: string
examples: ["string"]
password:
type: string
format: string
examples: ["string"]
createdAt:
type: timestamp
format: timestamp
examples: ["2024-05-08T01:15:11.599Z"]
updatedAt:
type: timestamp
format: timestamp
examples: ["2024-05-08T01:15:11.599Z"]
required:
- id
- username
- password
- createdAt
- updatedAt
# VOLUNTARY
Voluntary:
type: object
properties:
first_name:
type: string
format: string
examples: ["Carlos"]
last_name:
type: string
format: string
examples: ["Silva"]
email:
type: string
format: string
examples: ["[email protected]"]
phone:
type: string
format: string
examples: ["11 987654321"]
description:
type: string
format: string
examples: ["Carlos Silva é um jovem engenheiro civil que sempre buscou fazer a diferença na vida das pessoas. Após ver as imagens das casas destruídas pelas tragédias recentes, ele sentiu a necessidade de contribuir de forma prática. Carlos quer ser um voluntário no projeto Reconstrua porque acredita na importância de reconstruir não apenas as casas físicas, mas também a confiança e a esperança nas pessoas que foram afetadas. Ele está ansioso para usar suas habilidades e conhecimentos para ajudar a reconstruir casas e, assim, ajudar a reconstruir vidas."]
required:
- first_name
- last_name
- email
- phone
- description
# BENEFICIARY
Beneficiary:
type: object
properties:
first_name:
type: string
format: string
examples: ["Maria"]
last_name:
type: string
format: string
examples: ["Fernandes"]
email:
type: string
format: string
examples: ["[email protected]"]
phone:
type: string
format: string
examples: ["11 987654321"]
cep:
type: string
format: string
examples: ["04547-000"]
street:
type: string
format: string
examples: ["Rua dos Três Pinos"]
neighborhood:
type: string
format: string
examples: ["Vila Mariana"]
city:
type: string
format: string
examples: ["São Paulo"]
state:
type: string
format: string
examples: ["São Paulo"]
address_number:
type: number
format: number
examples: [123]
description:
type: string
format: string
examples: ["Maria é uma jovem mãe de dois filhos pequenos que perdeu tudo em um incêndio doméstico. Ela está procurando por uma casa segura para seus filhos e está disposta a ajudar na limpeza e manutenção da nova residência. muito dedicada e trabalha em dois empregos para sustentar sua família. Ela sonha em dar uma vida melhor para seus filhos e está ansiosa para começar a nova fase em sua vida."]
required:
- first_name
- last_name
- email
- phone
- cep
- street
- neighborhood
- city
- state
- address_number
- description
# COMPANY
Company:
type: object
properties:
company_name:
type: string
format: string
examples: ["Construção Solidária"]
email:
type: string
format: string
examples: ["[email protected]"]
phone:
type: string
format: string
examples: ["11 987654321"]
website:
type: string
format: string
examples: ["https://www.construcaosolidaria.com.br"]
cep:
type: string
format: string
examples: ["04547-000"]
street:
type: string
format: string
examples: ["Avenida das Nações Unidas"]
neighborhood:
type: string
format: string
examples: ["Itaim Bibi"]
city:
type: string
format: string
examples: ["São Paulo"]
state:
type: string
format: string
examples: ["São Paulo"]
address_number:
type: number
format: number
examples: [456]
description:
type: string
format: string
examples: ["A Construção Solidária é uma organização sem fins lucrativos dedicada a reconstruir casas para pessoas em situação de rua ou afetadas por tragédias naturais. Com uma equipe de profissionais qualificados e voluntários, a empresa oferece serviços de construção, reparos e reformas, além de fornecer materiais de construção e assistência técnica. A missão da Construção Solidária é proporcionar moradia segura e digna para aqueles que mais precisam, promovendo a solidariedade e a inclusão social."]
required:
- company_name
- email
- phone
- website
- cep
- street
- neighborhood
- city
- state
- address_number
- description
# REQUESTS
requestBodies:
# ADMIN
LoginAdmin:
content:
application/json:
schema:
$ref: "#/components/schemas/LoginAdmin"
required: true
UpdateAdmin:
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateAdmin"
required: true
# VOLUNTARY
Voluntary:
content:
application/json:
schema:
$ref: "#/components/schemas/Voluntary"
required: true
# BENEFICARY
Beneficiary:
content:
application/json:
schema:
$ref: "#/components/schemas/Beneficiary"
required: true
# COMPANY
Company:
content:
application/json:
schema:
$ref: "#/components/schemas/Company"
required: true
# RESPONSES
responses:
# SUCESS
Success:
Default:
content:
application/json:
schema:
type: object
properties:
message:
type: string
examples: [<Mensagem de sucesso>.]
# ADMIN
LoginAdmin:
content:
application/json:
schema:
type: object
properties:
message:
type: string
examples: [<Mensagem de sucesso>.]
token:
type: string
examples: [token]
required:
- message
- token
GetAdmins:
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Admin"
# VOLUNTARY
GetVoluntaries:
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
first_name:
type: string
format: string
examples: ["string"]
last_name:
type: string
format: string
examples: ["string"]
email:
type: string
format: string
examples: ["string"]
phone:
type: string
format: string
examples: ["string"]
description:
type: string
format: string
examples: ["string"]
createdAt:
type: timestamp
format: timestamp
examples: ["2024-05-08T01:15:11.599Z"]
updatedAt:
type: timestamp
format: timestamp
examples: ["2024-05-08T01:15:11.599Z"]
GetVoluntary:
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
first_name:
type: string
format: string
examples: ["string"]
last_name:
type: string
format: string
examples: ["string"]
email:
type: string
format: string
examples: ["string"]
phone:
type: string
format: string
examples: ["string"]
description:
type: string
format: string
examples: ["string"]
createdAt:
type: timestamp
format: timestamp
examples: ["2024-05-08T01:15:11.599Z"]
updatedAt:
type: timestamp
format: timestamp
examples: ["2024-05-08T01:15:11.599Z"]
# BENEFICIARy
GetBeneficiaries:
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
first_name:
type: string
format: string
examples: ["string"]
last_name:
type: string
format: string
examples: ["string"]
email:
type: string
format: string
examples: ["string"]
phone:
type: string
format: string
examples: ["string"]
cep:
type: string
format: string
examples: ["string"]
street:
type: string
format: string
examples: ["string"]
neighborhood:
type: string
format: string
examples: ["string"]
city:
type: string
format: string
examples: ["string"]
state:
type: string
format: string
examples: ["string"]
address_number:
type: number
format: number
examples: [0]
description:
type: string
format: string
examples: ["string"]
createdAt:
type: timestamp
format: timestamp
examples: ["2024-05-06T18:43:14.681Z"]
updatedAt:
type: timestamp
format: timestamp
examples: ["2024-05-06T18:43:14.681Z"]
GetBeneficiary:
content:
application/json:
schema:
type: object
properties:
id:
type: string
format: uuid
first_name:
type: string
format: string
examples: ["string"]
last_name:
type: string
format: string
examples: ["string"]
email:
type: string
format: string
examples: ["string"]
phone:
type: string
format: string
examples: ["string"]
cep:
type: string
format: string
examples: ["string"]
street:
type: string
format: string
examples: ["string"]
neighborhood:
type: string
format: string
examples: ["string"]
city:
type: string
format: string
examples: ["string"]
state:
type: string
format: string
examples: ["string"]