Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
170 lines (162 loc) · 3.88 KB
/
Copy pathopenapi.yaml
File metadata and controls
170 lines (162 loc) · 3.88 KB
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
openapi: 3.0.0
info:
title: Staff Service
version: 1.0.0
description: API to manage doctors in a clinic
servers:
- url: http://localhost:3007/api/v1
description: Development server
- url: /api/v1
description: Production server
tags:
- name: staff
description: Operations about doctors
paths:
/staff/register:
post:
summary: Register a new doctor
tags:
- staff
security:
- cookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
surname:
type: string
specialty:
type: string
dni:
type: string
clinicId:
type: string
password:
type: string
email:
type: string
responses:
'201':
description: Doctor created successfully
'400':
description: Bad request
/staff/{doctorId}:
get:
summary: Get doctor by ID
tags:
- staff
parameters:
- in: path
name: doctorId
required: true
schema:
type: string
responses:
'200':
description: Doctor retrieved successfully
'404':
description: Doctor not found
put:
summary: Update doctor speciality
tags:
- staff
security:
- cookieAuth: []
parameters:
- in: path
name: doctorId
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
specialty:
type: string
responses:
'200':
description: Speciality updated successfully
'404':
description: Doctor not found
delete:
summary: Delete a doctor
tags:
- staff
security:
- cookieAuth: []
parameters:
- in: path
name: doctorId
required: true
schema:
type: string
responses:
'204':
description: Doctor deleted successfully
'404':
description: Doctor not found
/staff/clinic/{clinicId}/speciality/{speciality}:
get:
summary: Get doctors by speciality in a clinic
tags:
- staff
parameters:
- in: path
name: clinicId
required: true
schema:
type: string
- in: path
name: speciality
required: false
schema:
type: string
responses:
'200':
description: List of doctors
'404':
description: No doctors found
/staff/me:
get:
summary: Get authenticated doctor
tags:
- staff
security:
- cookieAuth: []
responses:
'200':
description: Authenticated doctor retrieved successfully
content:
application/json:
schema:
type: object
properties:
_id:
type: string
name:
type: string
surname:
type: string
specialty:
type: string
dni:
type: string
clinicId:
type: string
email:
type: string
userId:
type: string
'404':
description: Authenticated doctor not found
'400':
description: Error retrieving authenticated doctor