-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhealth-tracker-api.yaml
337 lines (333 loc) · 9.13 KB
/
health-tracker-api.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
openapi: 3.0.0
info:
version: 1.0.0
title: Health Tracker API
description: This API provides endpoints for Health Tracker App
contact:
name: Ashika Hussain
email: [email protected]
paths:
/api/users:
post:
description: Add a user to the app
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: integer
example: 3232
name:
type: string
example: Joe Soap
email:
type: string
example: [email protected]
responses:
200:
description: The user has been created
get:
summary: Retrieve all users
responses:
200:
description: This is a list of the users in the app
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
example: 3232
name:
type: string
example: Joe Soap
email:
type: string
example: [email protected]
delete:
summary: Delete a User
parameters:
- in: path
name: user-id
required: true
schema:
type: integer
example: 3232
responses:
200:
description: The user has been deleted
/api/users/{user-id}:
get:
summary: Get user by User Id
parameters:
- in: path
name: user-id
required: true
schema:
type: integer
example: 3232
responses:
200:
description: This is a specific user in the app
content:
application/json:
schema:
type: object
properties:
id:
type: integer
example: 3232
name:
type: string
example: Joe Soap
email:
type: string
example: [email protected]
patch:
summary: Update User
parameters:
- in: path
name: user-id
required: true
schema:
type: integer
example: 3232
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Joe Soap
email:
type: string
example: [email protected]
responses:
200:
description: This is a to update a specific user in the app
content:
application/json:
schema:
type: object
properties:
id:
type: integer
example: 3232
name:
type: string
example: Joe Soap
email:
type: string
example: [email protected]
delete:
summary: Delete user by ID
operationId: deleteUser
parameters:
- in: path
name: user-id
schema:
type: string
required: true
description: ID of the user
responses:
200:
description: User deleted successfully
/api/users/email/{email}:
get:
summary: Get User by Email Id
parameters:
- in: path
name: email
required: true
schema:
type: string
example: [email protected]
responses:
200:
description: This is a specific user in the app using email id
content:
application/json:
schema:
type: object
properties:
id:
type: integer
example: 3232
name:
type: string
example: Joe Soap
email:
type: string
example: [email protected]
/api/activities:
get:
summary: Retrieve all activities
operationId: getAllActivities
responses:
'200':
description: A list of activities
content:
application/json:
schema:
type: array
items:
properties:
id:
type: integer
example: 3232
description:
type: string
example: Walking
duration:
type: number
format: double
example: 34.0
started:
type: string
format: date-time
example: [email protected]
calories:
type: integer
example: 800
post:
summary: Add a new activity
operationId: addActivity
requestBody:
description: Activity object that needs to be added
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: integer
example: 3232
description:
type: string
example: Walking
duration:
type: number
format: double
example: 34.0
started:
type: string
format: date-time
example: [email protected]
calories:
type: integer
example: 800
responses:
'200':
description: Activity added successfully
/api/activities/{activity-id}:
get:
summary: Get activity by ID
operationId: getActivitiesByActivityId
parameters:
- in: path
name: activity-id
schema:
type: string
required: true
description: ID of the activity
responses:
'200':
description: Activity found
delete:
summary: Delete activity by ID
operationId: deleteActivityByActivityId
parameters:
- in: path
name: activity-id
schema:
type: string
required: true
description: ID of the activity
responses:
'200':
description: Activity deleted successfully
patch:
summary: Update activity by ID
operationId: updateActivity
parameters:
- in: path
name: activity-id
schema:
type: integer
required: true
description: ID of the activity
requestBody:
content:
application/json:
schema:
type: object
properties:
description:
type: string
example: Walking
duration:
type: number
format: double
example: 34.0
started:
type: string
format: date-time
example: 2-11-2023 06:43:00
calories:
type: integer
example: 800
responses:
'200':
description: Activity updated successfully
/api/login:
post:
summary: Login to the system
operationId: login
requestBody:
description: Login to the system
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
example: [email protected]
password:
type: string
example: password
responses:
'200':
description: Login successful
content:
application/json:
schema:
type: object
properties:
role:
type: string
example: admin
result :
type: string
example: Login successful
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
role:
type: string
example: null
result:
type: string
example: Login failed