-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathprogress-account-spec.yml
311 lines (311 loc) · 8.13 KB
/
progress-account-spec.yml
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
openapi: 3.0.1
info:
title: Progress-Account
description: Progress account specification to define the progress account API
contact:
email: [email protected]
version: 1.0.0
servers:
- url: https://localhost:8080/v1
description: Production server
tags:
- name: progresses
description: Progress Account
paths:
/progresses:
get:
summary: Retrieve all progresses
tags:
- progresses
security:
- BearerAuth
operationId: getAllProgress
responses:
200:
$ref: '#/components/responses/SuccessGetAll'
401:
$ref: '#/components/responses/Unauthorized'
500:
$ref: '#/components/responses/ServerError'
/progress:
post:
summary: Create a new progress
tags:
- progresses
security:
- BearerAuth
operationId: createProgressAccount
requestBody:
$ref: '#/components/requestBody/progressBody'
required: true
responses:
201:
$ref: '#/components/responses/Created'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
500:
$ref: '#/components/responses/ServerError'
/progress/{id}:
get:
summary: Get a progress by ID
tags:
- progresses
security:
- BearerAuth
operationId: getProgressById
parameters:
- name: id
in: path
description: Progress ID
required: true
schema:
type: integer
format: int64
responses:
200:
$ref: '#/components/responses/Success'
401:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/ServerError'
put:
summary: Update a progress by ID
tags:
- progresses
security:
- BearerAuth
operationId: updateProgressById
parameters:
- name: id
in: path
description: Progress ID
required: true
schema:
type: integer
format: int64
requestBody:
$ref: '#/components/requestBody/progressBody'
responses:
202:
$ref: '#/components/responses/Accepted'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/ServerError'
delete:
summary: Delete a progress by ID
tags:
- progresses
security:
- BearerAuth
operationId: deleteProgressById
parameters:
- name: id
in: path
description: Progress ID
required: true
schema:
type: integer
format: int64
responses:
204:
description: No Content
401:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/ServerError'
components:
schemas:
requestBody:
required:
- dateProgress
- headCircumference
- height
- weight
- patient
type: object
properties:
dateProgress:
type: string
format: date
minimum: 10
example: 10/02/2010
headCircumference:
type: number
format: double
example: 0.74
height:
type: number
format: double
example: 1.2
weight:
type: number
format: double
example: 16.2
patient:
$ref: '#/components/schemas/patient'
progress:
required:
- id
- dateProgress
- headCircumference
- height
- weight
- patient
type: object
properties:
id:
type: integer
format: int64
example: 1
dateProgress:
type: string
format: date
minimum: 10
example: 10/02/2010
headCircumference:
type: number
format: double
example: 0.74
height:
type: number
format: double
example: 1.2
weight:
type: number
format: double
example: 16.2
patient:
$ref: '#/components/schemas/patient'
patient:
required:
- id
- firstName
- lastName
- dateBirth
- gender
- phoneNumber
type: object
properties:
id:
type: integer
format: int64
example: 1
dateBirth:
type: string
format: date
minimum: 10
example: 10/02/2010
firstName:
type: string
minimum: 2
example: 'Cleison'
lastName:
type: string
minimum: 2
example: 'Melo'
phoneNumber:
type: number
format: int32
example: 555-6563-5623
gender:
type: string
example: M
enum:
- M
- F
body_response_error:
required:
- code_error
- message
type: object
properties:
code_error:
type: integer
format: int64
minimum: 1
example: 13216
message:
type: string
example: message_to_show
requestBody:
progressBody:
description: Progress JSON object required
content:
application/json:
schema:
$ref: '#/components/schemas/requestBody'
responses:
Success:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/progress'
Created:
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/progress'
Accepted:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/progress'
SuccessGetAll:
description: OK
content:
application/json:
schema:
type: array
items:
oneOf:
- $ref: '#/components/schemas/progress'
- $ref: '#/components/schemas/progress'
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/body_response_error'
Unauthorized:
description: Unauthorized error
content:
application/json:
schema:
$ref: '#/components/schemas/body_response_error'
Forbidden:
description: Forbidden error
content:
application/json:
schema:
$ref: '#/components/schemas/body_response_error'
ServerError:
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/body_response_error'
NotFound:
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/body_response_error'
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT