Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
221 lines (212 loc) · 5.38 KB
/
Copy pathopenapi.yaml
File metadata and controls
221 lines (212 loc) · 5.38 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
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
openapi: 3.0.0
info:
title: Patient Microservice
version: 1.0.0
description: >
Patient microservice for managing patient data within the Clinic Management System.
Supports registration, retrieval, updating, and deletion of patient information.
servers:
- url: /api/v1
security:
- cookieAuth: []
tags:
- name: Patients
description: Operations related to patient management.
paths:
/patients/:
post:
tags:
- Patients
summary: Register a new patient
description: Creates a new patient record in the system.
security:
- cookieAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Patient'
responses:
'201':
description: Patient created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Patient'
'400':
description: Missing fields in the request body.
content:
application/json:
example:
message: "Missing fields"
'500':
description: Internal server error.
content:
application/json:
example:
message: "An unexpected error occurred"
get:
tags:
- Patients
summary: Retrieve all patients
description: Fetch a list of all patients.
security:
- cookieAuth: []
responses:
'200':
description: List of patients retrieved successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Patient'
'500':
description: Internal server error.
content:
application/json:
example:
message: "An unexpected error occurred"
/patients/{id}:
get:
tags:
- Patients
summary: Get patient by ID
description: Fetch a specific patient using their unique ID.
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Patient retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Patient'
'404':
description: Patient not found.
content:
application/json:
example:
message: "Patient not found"
'500':
description: Internal server error.
content:
application/json:
example:
message: "An unexpected error occurred"
put:
tags:
- Patients
summary: Update a patient by ID
description: Modify the details of a specific patient.
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
responses:
'200':
description: Patient updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Patient'
'404':
description: Patient not found.
content:
application/json:
example:
message: "Patient not found"
'500':
description: Internal server error.
content:
application/json:
example:
message: "An unexpected error occurred"
delete:
tags:
- Patients
summary: Delete a patient by ID
description: Remove a specific patient from the system.
security:
- cookieAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Patient deleted successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Patient'
'404':
description: Patient not found.
content:
application/json:
example:
message: "Patient not found"
'500':
description: Internal server error.
content:
application/json:
example:
message: "An unexpected error occurred"
components:
securitySchemes:
cookieAuth:
type: apiKey
in: cookie
name: token
schemas:
Patient:
type: object
properties:
name:
type: string
surname:
type: string
birthdate:
type: string
format: date
dni:
type: string
city:
type: string
email:
type: string
password:
type: string
required:
- name
- surname
- birthdate
- dni
- city
- username
- email
ErrorResponse:
type: object
properties:
message:
type: string