-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdataWarehouse.yaml
1659 lines (1644 loc) · 48.5 KB
/
dataWarehouse.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.3
info:
title: Data Warehouse
description: |-
Este proyecto plantea la creación de un sistema de manejo y administracion de todos los contactos que tiene una empresa con sus clientes.
<br>
Poner en funcionamiento las partes necesarias para montar una REST API que permite realizar altas, bajas, modificaciones y obtención de información sobre una estructura de datos que podría consumir un cliente.
Algunos links útiles:
- [Data Warehouse](https://github.com/swagger-api/swagger-petstore)
- [The source API definition for the Data Warehouse](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
contact:
email: 1992savg@gmail.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0
servers:
- url: to be defined
tags:
- name: auth
description: Operaciones para el ingreso/egreso y autorizacion de la aplicación.
- name: users
description: Operaciones sobre los usuarios. __*Necesita Bearer authentication (token otorgado en el login).*__
- name: regions
description: Operaciones sobre las regiones. __*Necesita Bearer authentication (token otorgado en el login).*__
- name: countries
description: Operaciones sobre los paises. __*Necesita Bearer authentication (token otorgado en el login).*__
- name: cities
description: Operaciones sobre los ciudades. __*Necesita Bearer authentication (token otorgado en el login).*__
- name: companies
description: Operaciones sobre los empresas. __*Necesita Bearer authentication (token otorgado en el login).*__
- name: contacts
description: Operaciones sobre los contactos. __*Necesita Bearer authentication (token otorgado en el login).*__
- name: channels
description: Operaciones sobre los canales. __*Necesita Bearer authentication (token otorgado en el login).*__
- name: contactChannels
description: Operaciones sobre los canales de contacto. __*Necesita Bearer authentication (token otorgado en el login).*__
paths:
/login:
post:
tags:
- auth
summary: Ingreso del usuario al sistema
description: ''
operationId: loginUser
parameters:
- name: email
in: query
description: El email para el ingreso
required: true
schema:
type: string
- name: contraseña
in: query
description: La contraseña para el ingreso
required: true
schema:
type: string
responses:
'200':
description: operación exitosa
headers:
X-Rate-Limit:
description: calls per hour allowed by the user
schema:
type: integer
format: int32
X-Expires-After:
description: date in UTC when token expires
schema:
type: string
format: date-time
content:
application/xml:
schema:
type: string
application/json:
schema:
type: string
'400':
description: Email o contraseña ingresada incorrecta
/logout:
delete:
tags:
- auth
summary: Finaliza sesion del ususario
description: ''
operationId: logoutUser
parameters: []
responses:
default:
description: operación exitosa
/users/register:
post:
security:
- bearerAuth: []
tags:
- users
summary: Crear usuario. Se debe ser "Admin"
description: Trae datos del token. <br> Si el usuario es __"Admin"__, podra crear un nuevo usuario.<br>Si el usuario es "User", obtendra mensaje de no autorizado.
operationId: createUser
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- in: body
name: body
description: 'Datos necesarios para crear usuario'
required: true
schema:
$ref: '#/components/schemas/Users'
requestBody:
description: Created user object
content:
application/json:
schema:
$ref: '#/components/schemas/Users'
application/xml:
schema:
$ref: '#/components/schemas/Users'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Users'
responses:
'201':
description: Usuario creado
content:
application/json:
schema:
$ref: '#/components/schemas/Users'
application/xml:
schema:
$ref: '#/components/schemas/Users'
'400':
description: Error al crear usuario
'401':
description: No autorizado para crear usuario
'409':
description: Email ya existe o en uso
/users:
get:
security:
- bearerAuth: []
tags:
- users
summary: Obtiene una lista de todos los usuarios
description: 'Trae datos del token. <br> Si el usuario es "Admin", obtendra una lista de todos los usuarios.<br>Si el usuario es "User", obtendra los datos de su propio usuario.'
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: header
description: 'Sera usado el "idUser" para traer datos de usuario; en cado caso del usuario ser "User" traera sus propios datos.'
required: true
type: string
responses:
'200':
description: Listado de usuarios
content:
application/json:
schema:
$ref: '#/components/schemas/Users'
application/xml:
schema:
$ref: '#/components/schemas/Users'
'206':
description: Datos de usuario
content:
application/json:
schema:
$ref: '#/components/schemas/Users'
application/xml:
schema:
$ref: '#/components/schemas/Users'
'400':
description: Error al listar usuarios
'401':
description: No Autorizado para ver la lista de usuarios
/users/{idUser}:
get:
security:
- bearerAuth: []
tags:
- users
summary: Trae datos de usuario por "idUser". Se debe ser "Admin"
description: 'Trae datos del token. <br> Si el usuario es __"Admin"__, obtendra los datos del usuario consultado.<br>Si el usuario es "User", obtendra mensaje de no autorizado a menos que el "idUser" sea su propio.'
operationId: getUserById
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: path
description: 'Sera usado el "idUser" para traer los datos del usuario a consultar.'
required: true
type: string
responses:
'200':
description: Datos del usuario
content:
application/json:
schema:
$ref: '#/components/schemas/Users'
application/xml:
schema:
$ref: '#/components/schemas/Users'
'206':
description: Informacion de usuario
content:
application/json:
schema:
$ref: '#/components/schemas/Users'
application/xml:
schema:
$ref: '#/components/schemas/Users'
'400':
description: Error al listar usuario
'401':
description: No Autorizado para ver los detalles del usuario
schema:
$ref: '#/definitions/Error'
put:
security:
- bearerAuth: []
tags:
- users
summary: Modificacion de datos de userio
description: Trae datos del token. Si el usuario es __"Admin"__, podra hacer cambios en caulquier "idUser".<br>Si el usuario es "User", solo podra hacer cambios en su propias datos (nombre, apellido, contraseña).
operationId: updateUser
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: path
description: Sera usado el para traer los datos del usuario a modificar
required: true
type: string
- in: body
name: body
description: Datos del usuario a modificar. <br> Si es "Admin", podra modificar los datos (nombre, apellido, email, contraseña, profile) del "idUser" indicado. <br> Si es "User", solo podra modificar sus propios datos (nombre, apellido, contraseña) usando su propio "idUser".
required: true
schema:
$ref: '#/components/schemas/Users'
responses:
'201':
description: Usuario modificado
content:
application/json:
schema:
$ref: '#/components/schemas/Users'
application/xml:
schema:
$ref: '#/components/schemas/Users'
'400':
description: Error al modificar usuario
'401':
description: No Autorizado para modificar los detalles del usuario
delete:
security:
- bearerAuth: []
tags:
- users
summary: Borra usuario
description: Trae datos del token. <br> Solo puede ser realizada por un __"Admin"__ para poder borrar un usuario.
operationId: deleteUser
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: path
description: Sera usado el "idUser" para traer los datos del usuario a eliminar
required: true
type: string
responses:
'200':
description: Usuario borrado
'400':
description: Error al eliminar usuario
schema:
$ref: '#/definitions/Error'
'401':
description: No Autorizado para borrar usuario
/regions:
post:
security:
- bearerAuth: []
tags:
- regions
summary: Crear una region.
description: Trae datos del token.
operationId: createUser
parameters:
- in: body
name: body
description: 'Datos necesarios para crear una region'
required: true
schema:
$ref: '#/components/schemas/Regions'
requestBody:
description: Created region object
content:
application/json:
schema:
$ref: '#/components/schemas/Regions'
application/xml:
schema:
$ref: '#/components/schemas/Regions'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Regions'
responses:
'201':
description: Region creada
content:
application/json:
schema:
$ref: '#/components/schemas/Regions'
application/xml:
schema:
$ref: '#/components/schemas/Regions'
'400':
description: Error al crear region
get:
security:
- bearerAuth: []
tags:
- regions
summary: Obtiene una lista de todas las regiones
description: 'Trae datos del token. '
produces:
- application/json
responses:
'200':
description: Listado de regiones
content:
application/json:
schema:
$ref: '#/components/schemas/Regions'
application/xml:
schema:
$ref: '#/components/schemas/Regions'
'400':
description: Error al listar regiones
schema:
$ref: '#/definitions/Error'
/regions/{idRegion}:
get:
security:
- bearerAuth: []
tags:
- regions
summary: Trae datos de region.
description: Trae datos del token.
operationId: getRegionById
produces:
- application/json
parameters:
- name: idUser
in: path
description: 'Sera usado el "idRegion" para traer los datos de la region a consultar.'
required: true
type: string
responses:
'200':
description: Datos de la region
content:
application/json:
schema:
$ref: '#/components/schemas/Regions'
application/xml:
schema:
$ref: '#/components/schemas/Regions'
'400':
description: Error al encontrar region
put:
security:
- bearerAuth: []
tags:
- regions
summary: Modificacion de datos de region. Se debe ser "Admin".
description: Trae datos del token. <br> Si el usuario es __"Admin"__, podra hacer cambios en caulquier "idUser".<br>Si el usuario es "User", no podra hacer cambios.
operationId: updateRegion
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: path
description: Sera usado el "idRegion" para traer los datos del usuario a modificar
required: true
type: string
- in: body
name: body
description: Datos del usuario a modificar ("isAdmin", solo lo puede modificar por un "Admin")
required: true
schema:
$ref: '#/components/schemas/Regions'
responses:
'201':
description: Region modificada
content:
application/json:
schema:
$ref: '#/components/schemas/Regions'
application/xml:
schema:
$ref: '#/components/schemas/Regions'
'400':
description: Error al modificar region
'401':
description: No autorizado para modificar region
delete:
security:
- bearerAuth: []
tags:
- regions
summary: Borra region. Se debe ser "Admin".
description: Trae datos del token. <br> Solo puede ser realizada por un __"Admin"__ para poder borrar una region.
operationId: deleteRegion
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: path
description: Sera usado el "idRegion" para traer los datos de la region a eliminar
required: true
type: string
responses:
'200':
description: Region eliminada
'400':
description: Error al eliminar region
'401':
description: No autorizado para eliminar region
/countries:
post:
security:
- bearerAuth: []
tags:
- countries
summary: Crear un pais.
description: 'Trae datos del token.'
operationId: createCountry
parameters:
- in: body
name: body
description: 'Datos necesarios para crear un pais'
required: true
schema:
$ref: '#/components/schemas/Countries'
requestBody:
description: Created region object
content:
application/json:
schema:
$ref: '#/components/schemas/Countries'
application/xml:
schema:
$ref: '#/components/schemas/Countries'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Countries'
responses:
'201':
description: Pais creado
content:
application/json:
schema:
$ref: '#/components/schemas/Countries'
application/xml:
schema:
$ref: '#/components/schemas/Countries'
'400':
description: Error al crear pais
get:
security:
- bearerAuth: []
tags:
- countries
summary: Obtiene una lista de todos los paises
description: 'Trae datos del token.'
produces:
- application/json
responses:
'200':
description: Listado de paises
content:
application/json:
schema:
$ref: '#/components/schemas/Countries'
application/xml:
schema:
$ref: '#/components/schemas/Countries'
'400':
description: Error al listar paises
/countries/{idCountry}:
get:
security:
- bearerAuth: []
tags:
- countries
summary: Trae datos de pais.
description: 'Trae datos del token.'
operationId: getCountryById
produces:
- application/json
parameters:
- name: idCountry
in: path
description: 'Sera usado el "idCountry" para traer los datos del pais a consultar.'
required: true
type: string
responses:
'200':
description: Datos del pais
content:
application/json:
schema:
$ref: '#/components/schemas/Countries'
application/xml:
schema:
$ref: '#/components/schemas/Countries'
'400':
description: Error al obtener pais
put:
security:
- bearerAuth: []
tags:
- countries
summary: Modificacion de datos del pais. Se debe ser "Admin".
description: Trae datos del token. <br> Si el usuario es __"Admin"__, podra hacer cambios en caulquier "idCountry". <br> Si el usuario es "User", no podra hacer cambios.
operationId: updateCountry
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: path
description: Sera usado el "idCountry" para traer los datos del pais a consultar
required: true
type: string
- in: body
name: body
required: true
schema:
$ref: '#/components/schemas/Countries'
responses:
'201':
description: Pais modificado
content:
application/json:
schema:
$ref: '#/components/schemas/Countries'
application/xml:
schema:
$ref: '#/components/schemas/Countries'
'400':
description: Error al modificar pais
'401':
description: No autorizado para modificar pais
delete:
security:
- bearerAuth: []
tags:
- countries
summary: Borra pais. Se debe ser "Admin".
description: Trae datos del token. <br> Solo puede ser realizada por un __"Admin"__ para poder eliminar un pais.
operationId: deleteCountries
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: path
description: Sera usado el para traer los datos del pais a eliminar
required: true
type: string
responses:
'200':
description: Pais borrado
'400':
description: Error al eliminar pais
'401':
description: No Autorizado para borrar pais
/cities:
post:
security:
- bearerAuth: []
tags:
- cities
summary: Crear una ciudad.
description: 'Trae datos del token.'
operationId: createCity
parameters:
- in: body
name: body
description: 'Datos necesarios para crear una ciudad'
required: true
schema:
$ref: '#/components/schemas/Cities'
requestBody:
description: Created city object
content:
application/json:
schema:
$ref: '#/components/schemas/Cities'
application/xml:
schema:
$ref: '#/components/schemas/Cities'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Cities'
responses:
'201':
description: Ciudad creada
content:
application/json:
schema:
$ref: '#/components/schemas/Cities'
application/xml:
schema:
$ref: '#/components/schemas/Cities'
'400':
description: Error al crear ciudad
get:
security:
- bearerAuth: []
tags:
- cities
summary: Obtiene una lista de todas las ciudades
description: 'Trae datos del token.'
produces:
- application/json
responses:
'200':
description: Listado de ciudades
content:
application/json:
schema:
$ref: '#/components/schemas/Cities'
application/xml:
schema:
$ref: '#/components/schemas/Cities'
'400':
description: Error al listar ciudades
/cities/{idCity}:
get:
security:
- bearerAuth: []
tags:
- cities
summary: Trae datos de la ciudad.
description: Trae datos del token.
operationId: getCityById
produces:
- application/json
parameters:
- name: idCity
in: path
description: 'Sera usado el para traer los datos de la ciudad a consultar.'
required: true
type: string
responses:
'200':
description: Datos de la ciudad
content:
application/json:
schema:
$ref: '#/components/schemas/Cities'
application/xml:
schema:
$ref: '#/components/schemas/Cities'
'400':
description: Error al listar ciudad
put:
security:
- bearerAuth: []
tags:
- cities
summary: Modificacion de datos de la ciudad. Se debe ser "Admin".
description: Trae datos del token. <br> Si el usuario es __"Admin"__, podra hacer cambios en caulquier "idCity".
operationId: updateCity
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: path
description: Sera usado el "idCity" para traer los datos de la ciudad a modificar
required: true
type: string
- in: body
name: body
description: Datos de la ciudad a modificar.
required: true
schema:
$ref: '#/components/schemas/Cities'
responses:
'201':
description: Ciudad modificada
content:
application/json:
schema:
$ref: '#/components/schemas/Cities'
application/xml:
schema:
$ref: '#/components/schemas/Cities'
'400':
description: Error al actualizar ciudad
'401':
description: No autorizado para actualizar ciudad
delete:
security:
- bearerAuth: []
tags:
- cities
summary: Borra ciudad. Se debe ser "Admin".
description: Trae datos del token. <br> Solo puede ser realizada por un __"Admin"__ para poder borrar una region.
operationId: deleteCity
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: path
description: Sera usado el para traer los datos de la ciudad a eliminar
required: true
type: string
responses:
'200':
description: Ciudad eliminada
schema:
$ref: '#/components/schemas/Cities'
'400':
description: Error al eliminar ciudad
'401':
description: No Autorizado para eliminar ciudad
/Companies:
post:
security:
- bearerAuth: []
tags:
- companies
summary: Crear una compañia.
description: 'Trae datos del token.'
operationId: createCity
parameters:
- in: body
name: body
description: 'Datos necesarios para crear una compañia'
required: true
schema:
$ref: '#/components/schemas/Companies'
requestBody:
description: Created company object
content:
application/json:
schema:
$ref: '#/components/schemas/Companies'
application/xml:
schema:
$ref: '#/components/schemas/Companies'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Companies'
responses:
'201':
description: Compañia creada
content:
application/json:
schema:
$ref: '#/components/schemas/Companies'
application/xml:
schema:
$ref: '#/components/schemas/Companies'
'400':
description: Error al crear compañia
get:
security:
- bearerAuth: []
tags:
- companies
summary: Obtiene una lista de todas las compañias
description: 'Trae datos del token.'
produces:
- application/json
responses:
'200':
description: Listado de compañias
content:
application/json:
schema:
$ref: '#/components/schemas/Companies'
application/xml:
schema:
$ref: '#/components/schemas/Companies'
'400':
description: Error al listar compañias
/Companies/{idCompany}:
get:
security:
- bearerAuth: []
tags:
- companies
summary: Trae datos de la compañia.
description: Trae datos del token.
operationId: getCompanyById
produces:
- application/json
parameters:
- name: idCompany
in: path
description: 'Sera usado el "idCompany" para traer los datos de la compañia a consultar.'
required: true
type: string
responses:
'200':
description: Datos de la compañia
content:
application/json:
schema:
$ref: '#/components/schemas/Companies'
application/xml:
schema:
$ref: '#/components/schemas/Companies'
'400':
description: Error al encontrar compañia
put:
security:
- bearerAuth: []
tags:
- companies
summary: Modificación de datos de la compañia. Se debe ser "Admin".
description: Trae datos del token.
operationId: updateCity
produces:
- application/json
parameters:
- name: idUser
in: path
description: Sera usado el para traer los datos de la compañia a modificar
required: true
type: string
- in: body
name: body
description: Datos de la compañia a modificar.
required: true
schema:
$ref: '#/components/schemas/Companies'
responses:
'201':
description: Compañia modificada
content:
application/json:
schema:
$ref: '#/components/schemas/Companies'
application/xml:
schema:
$ref: '#/components/schemas/Companies'
'400':
description: Error al actualizar compañia
delete:
security:
- bearerAuth: []
tags:
- companies
summary: Borra compañia. Se debe ser "Admin".
description: Trae datos del token. <br> Solo puede ser realizada por un __"Admin"__ para poder borrar una compañia.
operationId: deleteCompany
produces:
- application/json
parameters:
- in: header
name: role
type: string
required: true
description: "Admin or User"
- name: idUser
in: path
description: Sera usado el "idCompany" para traer los datos de la compañia a eliminar
required: true
type: string
responses:
'200':
description: Compañia borrada
'400':
description: Error al eliminar compañia
'401':
description: No Autorizado para eliminar compañia
/Contacts:
post:
security:
- bearerAuth: []
tags:
- contacts
summary: Crear un contacto.
description: Trae datos del token.
operationId: createContact
parameters:
- in: body
name: body
description: 'Datos necesarios para crear un contacto'
required: true
schema:
$ref: '#/components/schemas/Contacts'
requestBody:
description: Created company object
content:
application/json:
schema:
$ref: '#/components/schemas/Contacts'
application/xml:
schema:
$ref: '#/components/schemas/Contacts'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Contacts'
responses:
'201':
description: Contacto creado
content:
application/json:
schema:
$ref: '#/components/schemas/Contacts'
application/xml:
schema:
$ref: '#/components/schemas/Contacts'
'400':
description: Error al crear contacto
get:
security:
- bearerAuth: []
tags:
- contacts
summary: Obtiene una lista de todos los contactos
description: 'Trae datos del token. '
produces:
- application/json
responses:
'200':
description: Listado de contactos
content:
application/json:
schema:
$ref: '#/components/schemas/Contacts'
application/xml:
schema:
$ref: '#/components/schemas/Contacts'