-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
1185 lines (1183 loc) · 31.4 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.0.1
info:
title: Donate Care
description: This is a model for online healthcare microservices server.
termsOfService: http://swagger.io/terms/
contact:
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0
externalDocs:
description: Find out more about Swagger
url: http://swagger.io
servers:
- url: /
- url: /
tags:
- name: practitioner
description: All about healthcare practitioners of the co-operative.
- name: beneficiary
description: All about heathcare beneficiaries of the co-operative
- name: scheduling
description: Access to practitioners free scheduling microservice
- name: booking
description: Access to consultation booking microservice
- name: members
description: Access to member's profile and authentication
paths:
/practitioner:
put:
tags:
- practitioner
summary: Update the practitioner information in the registries
operationId: update_profile
requestBody:
description: Practitioner information to be updated in the registries
content:
application/json:
schema:
$ref: '#/components/schemas/Practitioner'
required: true
responses:
"200":
description: Success operation
content: {}
"400":
description: Invalid ID supplied
content: {}
"404":
description: Practitioner not found
content: {}
"405":
description: Validation exception
content: {}
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.practitioner_controller
post:
tags:
- practitioner
summary: Register a new practitioner in the co-operative
operationId: create_practitioner_profile
requestBody:
description: Practitioner's information that use for registration.
content:
application/json:
schema:
$ref: '#/components/schemas/Practitioner'
required: true
responses:
"405":
description: Invalid input
content: {}
security:
- donatecare_auth:
- write:practs
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.practitioner_controller
servers:
- url: https://registration.donate.care/v2
description: Registration microservice server
- url: http://registration.donate.care/v2
/practitioner/{publicId}/licences:
get:
tags:
- practitioner
summary: List all registered licences of a practitioner
operationId: list_licences
parameters:
- name: access_token
in: header
required: true
style: simple
explode: false
schema:
type: string
- name: publicId
in: path
description: Practitioner public id
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: Successful operation
content: {}
"401":
description: Unauthorized
content: {}
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.practitioner_controller
put:
tags:
- practitioner
summary: Add or update practioner's licences
operationId: add_license
parameters:
- name: access_token
in: header
description: Authentication token
required: true
style: simple
explode: false
schema:
type: string
- name: publicId
in: path
description: Practitioner's id in the registries
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: License records to be added
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/License'
responses:
"200":
description: Successful operation
content: {}
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.practitioner_controller
servers:
- url: https://registration.donate.care/v2
/practioner/{publicId}/specialities:
put:
tags:
- practitioner
summary: Update practioner's specialities
operationId: update_specialty
parameters:
- name: access_token
in: header
description: Authentication token
required: true
style: simple
explode: false
schema:
type: string
- name: publicId
in: path
description: Practitioner's public id in the registries
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: Speciality information to be update
content:
application/json:
schema:
$ref: '#/components/schemas/Speciality'
responses:
"200":
description: Successful speciality update
content: {}
x-openapi-router-controller: swagger_server.controllers.practitioner_controller
post:
tags:
- practitioner
summary: Add practioner's specialities
operationId: add_specialty
parameters:
- name: access_token
in: header
description: Authentication token
required: true
style: simple
explode: false
schema:
type: string
- name: publicId
in: path
description: Practitioner's public id in the registries
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: Speciality information to be update
content:
application/json:
schema:
$ref: '#/components/schemas/Speciality'
responses:
"200":
description: Successful speciality update
content: {}
"400":
description: Invalid input
content: {}
"401":
description: Unauthorized
content: {}
x-openapi-router-controller: swagger_server.controllers.practitioner_controller
servers:
- url: https://registration.donate.care/v2
x-codegen-request-body-name: body
/practitioner/findByCriteria:
get:
tags:
- practitioner
summary: Finds practitioners by status
description: Single status value shall be provided
operationId: find_practtioners_by_criteria
parameters:
- name: criteria
in: query
description: Criteria values that need to be considered for filter
required: true
style: form
explode: true
schema:
type: array
items:
type: string
default: speciality-only
enum:
- speciality-only
- location-only
- mode-only
- speciality-location
- speciality-location-mode
- none
- name: speciality
in: query
description: practitioner speciality
required: false
style: form
explode: true
schema:
type: string
- name: location
in: query
description: pratitioner location
required: false
style: form
explode: true
schema:
type: string
- name: mode
in: query
description: "consultation mode: video or presential "
required: false
style: form
explode: true
schema:
type: string
responses:
"200":
description: successful operation
content:
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Practitioner'
x-content-type: application/xml
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Practitioner'
"400":
description: Invalid criteria value
content: {}
security:
- api_key: []
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.practitioner_controller
servers:
- url: https://registration.donate.care/v2
/practitioner/findByAvailability:
description: This operation will be available in future versions
get:
tags:
- practitioner
summary: Finds practitioner by availabality
description: "For availability based search date and time parameters are required,\
\ alongside speciality, location or mode"
operationId: find_practitoners_by_date_time
parameters:
- name: date
in: query
description: Tags to filter by
required: true
style: form
explode: true
schema:
type: array
items:
type: string
responses:
"200":
description: successful operation
content:
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Practitioner'
x-content-type: application/xml
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Practitioner'
"400":
description: Invalid tag value
content: {}
deprecated: true
security:
- donatecare_auth:
- write:practs
- read:practs
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.practitioner_controller
/practitioner/uploadLicenseCertificate:
post:
tags:
- practitioner
summary: Help practitioner registration operation to upload certificates
operationId: upload_certificate
parameters:
- name: publicId
in: cookie
description: practitioner temporary public Id after login
required: true
style: form
explode: true
schema:
type: string
- name: access_token
in: cookie
description: temporary authorization token after login
required: true
style: form
explode: true
schema:
type: string
requestBody:
description: Certificate copy
content:
application/octet-stream:
schema:
type: object
format: base64
responses:
"200":
description: Success operation
content: {}
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.practitioner_controller
servers:
- url: https://registration.donate.care/v2
- url: http://registration.donate.care/v2
/beneficiary:
put:
tags:
- beneficiary
summary: Update beneficiary entity
operationId: update_beneficiary_profile
requestBody:
description: Beneficiary information to update
content:
application/json:
schema:
$ref: '#/components/schemas/Beneficiary'
responses:
"200":
description: Success operation
"403":
description: Invalid input
security:
- donatecare_auth:
- write:benefs
- read:benefs
- jwt_token:
- access_token
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.beneficiary_controller
post:
tags:
- beneficiary
summary: Create a beneficiary entity in the registries
operationId: create_beneficiary_profile
requestBody:
description: Beneficiary personal information
content:
application/json:
schema:
$ref: '#/components/schemas/Beneficiary'
responses:
"200":
description: Success operation
"403":
description: Invalid input
security:
- donatecare_auth:
- write:benefs
- read:benefs
- jwt_token:
- access_token
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.beneficiary_controller
servers:
- url: https://registration.donate.care/v2
- url: http://registration.donate.care/v2
/booking/makeAppointment:
post:
tags:
- booking
summary: Make appointment
operationId: make_appointment
requestBody:
description: Appointment for consultation
content:
'*/*':
schema:
$ref: '#/components/schemas/Appointment'
required: true
responses:
"200":
description: successful operation
content:
application/xml:
schema:
$ref: '#/components/schemas/Appointment'
application/json:
schema:
$ref: '#/components/schemas/Appointment'
"400":
description: Invalid Order
content: {}
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.booking_controller
servers:
- url: http://booking.donate.care/v2
/appointment/findByName:
get:
tags:
- booking
summary: "Returns appointments by entity role, name and status"
description: Returns a map of status codes to quantities
operationId: find_appointments_by_name
parameters:
- name: role
in: query
required: true
style: form
explode: true
schema:
type: string
enum:
- doctor
- patient
- name: name
in: query
required: true
style: form
explode: true
schema:
type: string
- name: status
in: query
required: true
style: form
explode: true
schema:
type: string
enum:
- open
- delivered
- cancelled
responses:
"200":
description: successful operation
content:
application/json:
schema:
type: object
additionalProperties:
type: integer
format: int32
x-content-type: application/json
security:
- api_key: []
x-openapi-router-controller: swagger_server.controllers.booking_controller
/appointment/{appointmentId}':
get:
tags:
- booking
summary: Find appointment by ID
description: For valid response try integer IDs with value >= 1 and <= 10. Other
values will generated exceptions
operationId: get_order_by_id
parameters:
- name: appointmentId
in: path
description: ID of an appointment that needs to be fetched
required: true
style: simple
explode: false
schema:
maximum: 10
minimum: 1
type: integer
format: int64
responses:
"200":
description: successful operation
content:
application/xml:
schema:
$ref: '#/components/schemas/Appointment'
application/json:
schema:
$ref: '#/components/schemas/Appointment'
"400":
description: Invalid ID supplied
content: {}
"404":
description: Order not found
content: {}
x-openapi-router-controller: swagger_server.controllers.booking_controller
delete:
tags:
- booking
summary: Delete appointment by ID
description: For valid response try integer IDs with positive integer value. Negative
or non-integer values will generate API errors
operationId: delete_order
parameters:
- name: appointmentId
in: path
description: ID of the appointment that needs to be deleted
required: true
style: simple
explode: false
schema:
minimum: 1
type: integer
format: int64
responses:
"400":
description: Invalid ID supplied
content: {}
"404":
description: Order not found
content: {}
x-openapi-router-controller: swagger_server.controllers.booking_controller
/members/createCredentials:
post:
tags:
- members
summary: Create a member's credentials to reference the profile
operationId: create_credentials
requestBody:
description: Member information to create a credentials
content:
application/json:
schema:
$ref: '#/components/schemas/Member'
responses:
"200":
description: Successful operation
content: {}
"400":
description: Invalid input
content: {}
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.members_controller
/members/login:
post:
tags:
- members
summary: Logs user into the system
operationId: login_user
parameters:
- name: username
in: query
description: The user name for login
required: true
style: form
explode: true
schema:
type: string
- name: password
in: query
description: The password for login in clear text
required: true
style: form
explode: true
schema:
type: string
responses:
"200":
description: successful operation
headers:
X-Rate-Limit:
description: calls per hour allowed by the user
style: simple
explode: false
schema:
type: integer
format: int32
X-Expires-After:
description: date in UTC when token expires
style: simple
explode: false
schema:
type: string
format: date-time
content:
application/json:
schema:
type: string
x-content-type: application/json
"400":
description: Invalid username/password supplied
content: {}
x-openapi-router-controller: swagger_server.controllers.members_controller
/members/logout:
get:
tags:
- members
summary: Logs out current logged in user session
operationId: logout_user
responses:
default:
description: successful operation
content: {}
x-openapi-router-controller: swagger_server.controllers.members_controller
/members/{username}:
get:
tags:
- members
summary: Get user by user name
operationId: get_user_by_name
parameters:
- name: username
in: path
description: 'The name that needs to be fetched. '
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: successful operation
content:
application/xml:
schema:
$ref: '#/components/schemas/Member'
application/json:
schema:
$ref: '#/components/schemas/Member'
"400":
description: Invalid username supplied
content: {}
"404":
description: User not found
content: {}
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.members_controller
put:
tags:
- members
summary: Update user
description: This can only be done by the logged in user.
operationId: update_user
parameters:
- name: username
in: path
description: name that need to be updated
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: Updated user object
content:
'*/*':
schema:
$ref: '#/components/schemas/Member'
required: true
responses:
"400":
description: Invalid user supplied
content: {}
"404":
description: User not found
content: {}
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.members_controller
delete:
tags:
- members
summary: Delete user
description: This can only be done by the logged in user.
operationId: delete_user
parameters:
- name: username
in: path
description: The name that needs to be deleted
required: true
style: simple
explode: false
schema:
type: string
responses:
"400":
description: Invalid username supplied
content: {}
"404":
description: User not found
content: {}
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.members_controller
servers:
- url: https://authentication.donate.care/v2
/members/profile/{publicId}/uploadImage:
post:
tags:
- members
summary: uploads profile image
operationId: upload_profile_image
parameters:
- name: publicId
in: path
description: ID of pet to update
required: true
style: simple
explode: false
schema:
type: integer
format: int64
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/publicId_uploadImage_body'
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- donatecare_auth:
- write:pets
- read:pets
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.members_controller
/scheduling/addSchedule:
post:
tags:
- scheduling
summary: Place availability schedule
operationId: add_schedule
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Schedule'
responses:
"200":
description: Success operation
content: {}
security:
- donatecare_auth:
- write:schedules
- read:schedules
x-codegen-request-body-name: body
x-openapi-router-controller: swagger_server.controllers.scheduling_controller
servers:
- url: https://scheduling.donate.care/v2
- url: http://scheduling.donate.care/v2
components:
schemas:
Appointment:
required:
- beneficiaryId
- consultationDate
- practitionerId
- remarks
- speciality
- status
type: object
properties:
id:
type: integer
format: int64
practitionerId:
type: integer
format: int64
speciality:
type: string
consultationDate:
type: string
format: date-time
beneficiaryId:
type: integer
format: int64
remarks:
type: string
status:
type: string
description: Appointment Status
enum:
- open
- delivered
- cancelled
complete:
type: boolean
default: false
example:
speciality: speciality
consultationDate: 2000-01-23T04:56:07.000+00:00
id: 0
complete: false
practitionerId: 6
remarks: remarks
beneficiaryId: 1
status: open
Address:
required:
- city
- country
- number
- postalCode
- state
- street
type: object
properties:
id:
type: integer
format: int64
street:
type: string
number:
type: string
postalCode:
type: string
city:
type: string
state:
type: string
country:
type: string
example:
number: number
country: country
city: city
street: street
postalCode: postalCode
id: 5
Speciality:
type: object
properties:
id:
type: integer
format: int64
title:
type: string
example: Nutritionist
description:
type: string
example:
description: description
id: 6
title: Nutritionist
Member:
required:
- country
- password
- phone
- role
- username
type: object
properties:
id:
type: integer
format: int64
username:
type: string
email:
type: string
password:
type: string
format: password
phone:
type: string
country:
type: string
role:
type: string
enum:
- doctor
- beneficiary
userStatus:
type: string
description: User Status
enum:
- pending
- suspended
- active
- inactive
example:
country: country
password: ""
role: doctor
userStatus: pending
phone: phone
id: 0
email: email
username: username
License:
required:
- certificateUrl
- code
- endDate
- issueDate
- issuerCountry
- issuerEntity
properties:
id:
type: integer
format: int64
code:
type: string
issueDate:
type: string
format: date
endDate:
type: string
format: date
issuerEntity:
type: string
issuerCountry:
type: string
certificateUrl:
type: string
status:
type: string
description: License validation status
enum:
- validated
- verifying
- Invalid
example:
issuerEntity: issuerEntity
code: code
endDate: 2000-01-23
issueerCountry: issueerCountry
id: 1
certificateUrl: certificateUrl
issueDate: 2000-01-23
status: validated
Beneficiary:
required:
- address
- birthDate
- gender
- name
- phone
- taxId
type: object