-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
1068 lines (1029 loc) · 30 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
swagger: "2.0"
info:
title: Pick And Drop App
description: This application serves individuals and companies who are into logistic businesses,
that is, the business of picking up an item and dropping it at a transport company Park for waybill
or the Home of the receiver if within the locality. The application allows companies/individuals to
create accounts and pick-up officers/offices. To create an order( request for pickup services),
the sender will fill out their details, the receiver's details, and the order details.
As the Order moves from one point to another, its status is updated.
version: 1.0.0
licence:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: https://pick-and-drop.onrender.com
description: Production Host
- url: http://localhost:5000
description: Local Host Server
contact:
name: Dozie Udeagha
email: dozie.udeagha@gmail.com
schemes: [https, http]
basePath: /api/v1
paths:
/auths/register/company:
post:
summary: Create a company
description: Create a logistic company to offer services
tags:
- Authentication
produces:
- application/json
consumes:
- application/json
parameters:
- name: company
in: body
description: Company Object
required: true
schema:
type: object
properties:
name:
type: string
description: Name of company
required: true
email:
type: string
description: Email of the company or the promoter
required: true
phoneNumber:
type: string
description: Phone number of the company or the promoter
required: true
city:
type: string
description: The city covered by the company or city located
required: true
state:
type: string
description: The state the company is located or covered
required: true
password:
type: string
description: The login password
required: true
confirmPassword:
type: string
description: Comfirm password
required: true
responses:
201:
description: Success
400:
description: Bad Request
500:
description: Internal Server Error
/auths/register/officer:
post:
summary: Register an Officer
description: Register an Officer by a Comapany Admin
tags:
- Authentication
produces:
- application/json
consumes:
- application/json
parameters:
- name: officer
in: body
description: officer account creation details
required: true
schema:
type: object
properties:
name:
type: string
description: name of officer
required: true
address:
type: string
description: officer address of officer
required: true
location:
type: string
description: office location
required: true
phoneNumber:
type: string
description: phone number of the officer
required: true
password:
type: string
description: password of the officer
required: true
confirmPassword:
type: string
description: comfirm password
company:
type: string
description: company ID of the company
required: true
responses:
201:
description: Success
400:
description: Bad Request
401:
description: You are not authorised to perform this action
500:
description: Internal Server Error
/auths/login:
post:
summary: Account login
description: Allows the company admin or officer to login
tags:
- Authentication
produces:
- application/json
consumes:
- application/json
parameters:
- name: login
in: body
description: email and password of company admin or phone number and pasword of officer
required: true
schema:
type: object
properties:
email:
type: string
description: email admin or officer
required: true
phoneNumber:
type: string
description: phone number of admin or officer
required: true
password:
type: string
description: password of the company admin or officer
required: true
responses:
200:
description: Success
schema:
oneOf:
- $ref: "#/definitions/Company"
- $ref: "#/definitions/Officer"
400:
description: Bad request
404:
description: Invalid Login Details
500:
description: Internal Server Error
/auths/password/company/{companyId}:
post:
summary: Update/change password for company
description: To change or update password for company admin
tags:
- Authentication
parameters:
- name: companyId
in: path
description: Unique ID of the company
required: true
- name: password
in: body
description: password object
required: true
schema:
type: object
properties:
currentPassword:
type: string
description: The current password to be changed
required: true
newPassword:
type: string
description: The new password
required: true
responses:
200:
description: Success
400:
description: Bad Request
401:
description: Invalid Login Details
500:
description: Internal Server Error
/auths/password/officer/{officerId}:
post:
summary: Update/change password for officer
description: To change or update password for officer
tags:
- Authentication
parameters:
- name: officerId
in: path
description: Unique ID of the officer
required: true
- name: password
in: body
description: password object
required: true
schema:
type: object
properties:
currentPassword:
type: string
description: The current password to be changed
required: true
newPassword:
type: string
description: The new password
required: true
responses:
200:
description: Success
400:
description: Bad Request
401:
description: Invalid Login Details
500:
description: Internal Server Error
/companies:
get:
summary: Get all companies
description: Retrieve records for all companies
tags:
- Company
responses:
200:
description: Success
schema:
type: array
items:
$ref: "#/definitions/Company"
400:
description: Bad request
500:
description: Internal Server error
/companies/{companyId}:
get:
summary: Get a company
description: Retrieve records for a company
tags:
- Company
parameters:
- name: companyId
in: path
description: Unique Id of the company
required: true
responses:
200:
description: Success
schema:
$ref: "#/definitions/Company"
400:
description: Bad request
500:
description: Internal Server Error
put:
summary: Update Company
description: Update records of a company
tags:
- Company
parameters:
- name: companyId
in: path
description: The unique ID of the company
required: true
- name: company object
in: body
description: Company object to be updated
required: true
schema:
type: object
properties:
name:
type: string
description: Name of company
email:
type: string
description: Email of the company or the promoter
phoneNumber:
type: string
description: Phone number of the company or the promoter
city:
type: string
description: The city covered by the company or city located
state:
type: string
description: The state the company is located or covered
responses:
200:
description: Success
schema:
$ref: "#/definitions/Company"
400:
description: Bad Request
500:
description: Internal Server Error
delete:
summary: delete a company
description: Delete company records
tags:
- Company
parameters:
- name: companyId
in: path
description: Unique ID of the company
required: true
responses:
200:
description: Success
400:
description: Bad request
500:
description: Internal Server Error
/officers/companies/{companyId}:
get:
summary: Get all company officers
description: Retrieves the record of all officers in a company
tags:
- Officer
parameters:
- name: companyId
in: path
description: The unique ID of the company where the officers belongs
required: true
responses:
200:
description: Success
schema:
type: array
items:
$ref: '#/definitions/Officer'
400:
description: Bad request
500:
description: Internal Server Error
/officers/{officerId}/companies/{companyId}:
get:
summary: Get records of an Officer
description: Retrieve the records of an officer
tags:
- Officer
parameters:
- name: officerId
in: path
description: The unique ID of the officer
required: true
- name: companyId
in: path
description: The unique ID of the company where the officer belongs
required: true
responses:
200:
description: Success
schema:
$ref: '#/definitions/Officer'
400:
description: Bad Request
500:
description: Internal Server Error
put:
summary: Update officer's records
description: Update officer's records by the officer or company Admin
tags:
- Officer
parameters:
- name: officerId
in: path
description: The unique ID of the officer
required: true
- name: companyId
in: path
description: The unique ID of the company where the officer belongs
required: true
- name: update details
in: body
description: The Object details of officer to be updated
required: true
schema:
type: object
properties:
name:
type: string
description: name of officer
address:
type: string
description: officer address of officer
location:
type: string
description: office location
phoneNumber:
type: string
description: phone number of the officer
responses:
200:
description: Success
schema:
$ref: "#/definitions/Officer"
400:
description: Bad Request
401:
description: You are not authorised to perform this action
500:
description: Internal Server Error
delete:
summary: Delete officer
desciption: Delete officer of a company
tags:
- Officer
parameters:
- name: officerId
in: path
description: The unique ID of officer to be deleted
required: true
- name: companyId
in: path
description: the Unique ID of the company where the officer belongs
required: true
responses:
200:
description: Success
400:
description: Bad Request
401:
description: You are not authorised to perform this action
500:
description: Internal Server Error
/senders:
post:
summary: Create a sender record
description: To create a record for a sender who books the order
tags:
- Sender
produces:
- application/json
consumes:
- application/json
parameters:
- name: sender
in: body
description: sender details
required: true
schema:
type: object
properties:
name:
type: string
description: Name of the Sender
required: true
phoneNumber:
type: string
description: The phone number of the sender
required: true
address:
type: string
description: The address of the sender
required: true
location:
type: string
description: The location of the address of the sender
required: true
responses:
200:
description: Success
schema:
$ref: '#/definitions/Sender'
400:
description: Bad Request
500:
description: Internal Server Error
/senders/{senderId}:
put:
summary: Update Sender Records
description: To update record of a sender
tags:
- Sender
parameters:
- name: senderId
in: path
description: The unique ID of the sender
required: true
- name: update details
in: body
description: The details to be updated
required: true
schema:
type: object
properties:
name:
type: string
description: Name of the Sender
phoneNumber:
type: string
description: The phone number of the sender
address:
type: string
description: The address of the sender
location:
type: string
description: The location of the address of the sender
responses:
200:
description: Success
schema:
$ref: '#/definitions/Sender'
400:
description: Bad Request
500:
description: Internal Server Error
get:
summary: Get sender details
description: To Retrieve the records of a sender with a sender ID
tags:
- Sender
parameters:
- name: senderId
in: path
description: The unique ID of the sender
required: true
responses:
200:
description: Success
schema:
$ref: "#/definitions/Sender"
400:
description: Bad Request
500:
description: Internal Server Error
/receivers/senders/{senderId}:
post:
summary: Create Reciever records
description: To create receiver of an order by sender
tags:
- Receiver
produces:
- application/json
consumes:
- application/json
parameters:
- name: senderId
in: path
description: The unique ID of the sender
required: true
- name: receiver details
in: body
description: The details of the receiver
required: true
schema:
type: object
properties:
name:
type: string
description: The name of the receiver
required: true
phoneNumber:
type: string
description: The phone number of the receiver
required: true
city:
type: string
description: the city where the receiver islocated
required: true
responses:
200:
description: Success
schema:
$ref: "#/definitions/Receiver"
400:
description: Bad Request
500:
description: Internal Server Error
/receivers/{receiverId}:
put:
summary: Update Receiver records
description: Update the record details of a receiver using the receiver unique ID
tags:
- Receiver
produces:
- application/json
consumes:
- application/json
parameters:
- name: receiverId
in: path
description: The unique ID of the receiver
required: true
- name: update details
in: body
description: The details of the receiver to be updated
schema:
type: object
properties:
name:
type: string
description: The name of the receiver
phoneNumber:
type: string
description: The phone number of the receiver
city:
type: string
description: the city where the receiver is located
responses:
200:
description: Success
schema:
$ref: '#/definitions/Receiver'
400:
description: Bad Request
500:
description: Internal Server Error
get:
summary: Get Receiver Records
description: Retrieve the records of Receiver
tags:
- Receiver
parameters:
- name: receiverId
in: path
description: The unique ID of the receiver
required: true
responses:
200:
description: Success
schema:
$ref: "#/definitions/Receiver"
400:
description: Bad Request
500:
description: Internal Server Error
/orders:
post:
summary: Create a new order
description: Create a new order by the sender
tags:
- Order
produces:
- application/json
consumes:
- application/json
parameters:
- name: Order details
in: body
description: The details of the new order to be created
required: true
schema:
type: object
properties:
content:
type: string
description: The item to be sent/delivered
required: true
company:
type: string
description: The unique ID of the delivery company
required: true
receiver:
type: string
description: The unique ID of the receiver
required: true
sender:
type: string
description: The unique ID of the sender
required: true
officer:
type: string
description: The unique ID of the receiver
required: true
deliveryPoint:
type: string
enum:
- Park
- Home
description: Specify whether order will be home delivery or park.
required: true
deliveryAddress:
type: string
description: Delivery address if home delivery or Park/transport company Name and location
required: true
serviceFee:
type: number
description: Service fee collected by company for delivery
required: true
RegisteredWaybill:
type: boolean
description: The sender state if the order would need to be registered offically with transport company
required: true
default: false
responses:
200:
description: Success
schema:
$ref: "#/definitions/Order"
400:
description: Bad Request
500:
description: Internal Server Error
/orders/{orderId}:
put:
summary: Update Order records
description: To update order records including status
tags:
- Order
parameters:
- name: orderId
in: path
description: The unique ID of the order
required: true
- name: update details
in: body
description: The details to be updated such as status
required: true
schema:
type: object
properties:
content:
type: string
description: The item to be sent/delivered
company:
type: string
description: The unique ID of the delivery company
receiver:
type: string
description: The unique ID of the receiver
sender:
type: string
description: The unique ID of the sender
officer:
type: string
description: The unique ID of the receiver
deliveryPoint:
type: string
enum:
- Park
- Home
description: Specify whether order will be home delivery or park.
deliveryAddress:
type: string
description: Delivery address if home delivery or Park/transport company Name and location
serviceFee:
type: number
description: Service fee collected by company for delivery
RegisteredWaybill:
type: boolean
description: The sender state if the order would need to be registered offically with transport company
responses:
200:
description: Success
schema:
$ref: "#/definitions/Order"
400:
description: Bad Request
500:
description: Internal Server Error
get:
summary: Get details of an Order
description: Retrieve details of an order using the order ID
tags:
- Order
parameters:
- name: orderId
in: path
description: The unique ID of the order
required: true
responses:
200:
description: Success
schema:
$ref: "#/definitions/Order"
400:
description: Bad Request
500:
description: Internal Server Error
/orders/companies/{companyId}:
get:
summary: Get orders with dates
descriptions: Retrieve orders using start date and end date
tags:
- Order
parameters:
- name: companyId
in: path
description: The Unique ID of the company
required: true
- name: startDate
in: query
description: Retrieve the start date to orders query
required: true
- name: endDate
in: query
description: (Optional) Retrieve the end date for order query
responses:
200:
description: Success
schema:
type: array
items:
$ref: "#/definitions/Order"
400:
descriptions: Bad Request
500:
descriptions: Internal Server Error
definitions:
Company:
type: object
properties:
_id:
type: string
description: Unique identifier for the company
name:
type: string
description: Name of the company
required: true
email:
type: string
description: Name of the company
required: true
phoneNumber:
type: string
description: Phone number of the company or the promoter
required: true
city:
type: string
description: City of coverage or located
required: true
state:
type: string
description: State company is located
required: true
password:
type: string
description: Login password
required: true
offices:
type: array
desctription: Pickup officers and their locations
items:
$ref: "#/definitions/Officer"
logo:
type: string
description: The company logo
rating:
type: number
description: The company rating over 5
isAdmin:
type: boolean
description: Admin user
Officer:
type: object
properties:
_id:
type: string
description: Unique identifier for officer
name:
type: string
description: Name of Officer
required: true
address:
type: string
description: Address of Officer
required: true
location:
type: string
description: office location of Officer
required: true
phoneNumber:
type: string
description: Phone number of Officer
required: true
company:
type: string
description: Unique ID of the company
required: true
statusCount:
type: object
properties:
pending:
type: number
description: Number of pending order
viewed:
type: number
description: Number of viewed order
picked:
type: number
description: Number of order picked/recieved by the officer
transit:
type: number
description: Number of order on transit to park or home
isAdmin:
type: boolean
description: Admin access to Officer
default: false
Sender:
type: object
properties:
_id:
type: string
description: Unique ID of the Sender
name:
type: string
description: The name of the sender
required: true
pnoneNumber:
type: string
description: The phone number of the sender
required: true
address:
type: string
description: The address ofthe sender
required: true
location:
type: string
description: The location of the address of the sender
required: true
customers:
type: array
items:
$ref: "#/definitions/Receiver"
description: All receivers the senders have created
Receiver:
type: object
properties:
_id:
type: string
description: Unique ID of the Receiver
name:
type: string
description: The name of the receiver
required: true
phoneNumber:
type: string
description: phone number of the order receipient
required: true
city:
type: string
description: The city of the receiver/recipient
required: true
Order:
type: object
properties:
_id:
type: string
description: The unique ID for any order booked
content:
type: string
description: The item to be sent/delivered