This repository has been archived by the owner on Jan 31, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.yaml
674 lines (646 loc) · 19.3 KB
/
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
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
openapi: 3.0.3
info:
title: QuantifiedSelf App V2
description: |-
QuantifiedSelf App is a personal tracking app.
- It allows the user to create a new account.
- The logged in user can create a new tracker of different types, read, update them and delete them.
- Every tracker can be logged at any time with appropiate value, also can be read, updated and deleted.
- The app sends an alert every evening if none of the tracker is logged by the user.
- User can import/export the trackers and logs.
- The sends a montly report to the user containing previous month activity.
---
# Database Schema
- ## Role
| Column Name | Column Type | Constraint |
|----------|------------|-------------------------------------------|
| id | Integer | Primary Key |
| name | Text | Not Null, Unique |
| description | Text | |
- ## User
| Column Name | Column Type | Constraint |
|----------|------------|-------------------------------------------|
| id | Integer | Primary Key, Auto-increment|
| fs-uniquifier | Text | Not Null, Unique |
| password | Text |Not Null |
|first_name|Text| Not Null|
|last_name|Text||
|active|Integer|Default(1)|
|email| Text| Not Null, Unique|
|role| Integer|Not Null, Foreign Key( "Role(id)" )|
- ## Tracker_Type
|Column Name | Column Type | Constraint|
|---|---|---|
|id|Integer|Primary Key, Auto-increment|
|name|Text|Not Null, Unique|
- ## Tracker
|Column Name | Column Type | Constraint|
|---|---|---|
|id|Integer|Primary Key, Auto-increment|
|name|Text|Not Null|
|description|Text||
|type|Integer|Not Null, Foreign Key( "Tracker_Type(id)" )|
|user_id|Integer|Not Null, Foreign Key( "User(id)" )|
|last_modified| Text| Not Null, Default( 'Never' )|
- ## Month_History
|Column Name | Column Type | Constraint|
|---|---|---|
|tracker_id|Integer|Primary Key, Foreign Key( "Tracker(id)" )|
- ## Options
|Column Name | Column Type | Constraint|
|---|---|---|
|tracker_id|Integer|Not Null, Primary Key, Foreign Key( "Tracker(id)" )|
|name|Text|Not Null, Primary Key|
|active| Integer| Not NUll, Default(1)|
- ## Log
|Column Name | Column Type | Constraint|
|---|---|---|
|id|Integer| Primary Key, Auto-increment|
|tracker_id|Integer|Not Null, Foreign Key( "Tracker(id)" )|
|value| Text| Not Null|
|note|Text||
|timestamp|Text|Not Null|
---
# Tracker Types
| Code | Name |
|----------|-----------------|
| 1 | Numerical |
| 2 | Multiple Choice |
| 3 | Time Duration |
| 4 | Boolean |
contact:
email: 21f1001878@student.onlinedegree.iitm.ac.in
version: "2.0"
servers:
- url: http://192.168.78.50:8080/api
tags:
- name: user
description: Operations about user
- name: tracker
description: Operations about tracker
- name: log
description: Operations about log
paths:
/user:
post:
tags:
- user
summary: Create new user
description: Anyone can create a new account with a unique userName and a valid email.
operationId: createUser
requestBody:
description: Details to create a new user.
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: "prof_x_54@outlook.com"
password:
type: string
format: password
example: "Long_Password_Is_Better_Than_A_Complex_One"
firstName:
type: string
example: "Charles"
lastName:
type: string
example: "Xavier"
responses:
'201':
description: User created successfully.
'400':
description: Provide valid email
'409':
description: Email already exist.
'500':
description: Unexpected error.
get:
tags:
- user
summary: Get User Details
description: 'The logged in user can get the personal details.'
operationId: viewUser
parameters:
- in: header
name: Authentication-Token
schema:
type: string
required: true
responses:
'200':
description: Operation Successful
content:
applicatin/json:
schema:
type: object
properties:
firstName:
type: string
example: Charles
lastName:
type: string
example: Xavier
email:
type: string
example: prof_x_54@outlook.com
id:
type: integer
example: 1
'401':
description: Unauthorised Access
'500':
description: Unexpected error.
/user/login:
post:
tags:
- user
summary: Logs user into the system
description: 'Username and Password is must to login.'
operationId: loginUser
parameters:
- name: include_auth_token
in: query
schema:
type: string
default: "True"
requestBody:
description: Credentials to login.
content:
application/json:
schema:
type: object
properties:
email:
type: string
example: prof_x_54@outlook.com
password:
type: string
format: password
example: Long_Password_Is_Better_Than_A_Complex_One
responses:
'200':
description: Login Successful and authorisation token provide.
content:
applicatin/json:
schema:
type: object
properties:
token:
type: string
example: 4458ECBCD673C3307AC8C3C071CB03E4DA60890556E90F135AF7F92E3B6DC99E
'400':
description: Wrong credentials
'500':
description: Unexpected error.
/user/logout:
get:
tags:
- user
summary: Logs out current logged in user session
description: ''
operationId: logoutUser
parameters:
- in: header
name: Authentication-Token
schema:
type: string
required: true
responses:
'200':
description: Logout Successful
'401':
description: Unauthorised Access
'500':
description: Unexpected error.
/tracker:
post:
tags:
- tracker
summary: Create new Tracker
description: Logged in user can create a new Tracker.
operationId: createTracker
parameters:
- in: header
name: Authentication-Token
schema:
type: string
required: true
requestBody:
description: Details of the Tracker to be created.
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Evening Game
description:
type: string
example: Game I play in Evening.
type:
type: integer
format: int64
example: 4
options:
type: array
items:
type: string
example: ["Cricket", "Badminton","Football"]
responses:
'201':
description: Tracker created successfully.
'400':
description: Invalid Tracker Type Supplied
'401':
description: Unauthorised Access
'409':
description: Tracker already exist.
'500':
description: Unexpected error.
get:
tags:
- tracker
summary: Get all the Trackers.
description: Logged in user can get the details of all the trackers user created.
operationId: readAllTrackers
parameters:
- in: header
name: Authentication-Token
schema:
type: string
required: true
responses:
'200':
description: Request Successful
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
description:
type: string
last_modified:
type: string
example:
- id: 1
name: Evening Game
description: The game I play in Evening.
last_modified: "2022-01-01 03:45"
'401':
description: Unauthorised Access
'500':
description: Unexpected error.
/tracker/{id}:
get:
tags:
- tracker
summary: Get the details of the tracker specified
description: Logged in user can get the details of the tracker name specified.
operationId: readTracker
parameters:
- name: id
in: path
description: Id of the tracker that needs to be read.
required: true
schema:
type: string
- in: header
name: Authentication-Token
schema:
type: string
required: true
responses:
'200':
description: Operation Successful.
content:
application/json:
schema:
properties:
id:
type: integer
example: 1
name:
type: string
example: Evening Game
description:
type: string
example: The game I play in evening.
type:
type: integer
format: int64
example: 2
options:
type: array
items:
type: string
example: ["Cricket", "Badminton", "Football"]
'400':
description: Invalid id supplied.
'401':
description: Unauthorised Access
'404':
description: Tracker not found.
'500':
description: Unexpected Error.
patch:
tags:
- tracker
summary: Update the tracker
description: Logged in user can update the name, description, options of the tracker.
operationId: updateTracker
parameters:
- name: id
in: path
description: Id of the tracker that needs to be read.
required: true
schema:
type: string
- in: header
name: Authentication-Token
schema:
type: string
required: true
requestBody:
description: Details of the Tracker
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Evening Game
description:
type: string
example: Game I play in Evening.
type:
type: string
example: 4
optons:
type: array
items:
type: string
example: ["Cricket", "Badminton", "Football"]
responses:
'201':
description: Update Successful.
'400':
description: Invalid id supplied./ Tracker with same name already exist.
'401':
description: Unauthorised Access
'404':
description: Tracker not found.
'500':
description: Unexpected Error.
delete:
tags:
- tracker
summary: Delete the tracker
description: Logged in user can delete the tracker and the corresponding logs.
operationId: deleteTracker
parameters:
- name: id
in: path
description: Id of the tracker that needs to be deleted.
required: true
schema:
type: string
- in: header
name: Authentication-Token
schema:
type: string
required: true
responses:
'404':
description: Tracker not found.
'200':
description: Deletion Successful.
'401':
description: Unauthorised Access
'500':
description: Unexpected Error.
/log:
post:
tags:
- log
summary: Create new Log
description: Logged in user can log a Tracker.
operationId: createLog
parameters:
- name: tracker_id
in: header
schema:
type: string
required: true
- in: header
name: Authentication-Token
schema:
type: string
required: true
requestBody:
description: Details of the Log
content:
application/json:
schema:
type: object
properties:
value:
type: string
example: Cricket
note:
type: string
example: I think I am kinda enjoying it.
timestamp:
type: string
example: "2022-01-01 03:45"
responses:
'201':
description: Log created successfully.
'400':
description: Bad Request
'401':
description: Unauthorised Access
'404':
description: Tracker not found.
'500':
description: Unexpected error.
get:
tags:
- log
summary: Get all logs of a tracker
description: Logged in user can get all logs of a tracker with the id
operationId: readLog
parameters:
- name: tracker_id
in: header
schema:
type: string
required: true
- in: header
name: Authentication-Token
schema:
type: string
required: true
responses:
'200':
description: Request Successful
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
format: int32
example: 1001
value:
type: string
example: "Cricket"
note:
type: string
example: I think I am kinda enjoying Cricket.
timestamp:
type: string
example: "2022-01-01 03:45"
tracker_id:
type: integer
example: 1
'401':
description: Unauthorised Access
'404':
description: Log not found.
'500':
description: Unexpected error.
/log/{id}:
get:
tags:
- log
summary: Get Log by id.
description: Logged in user can get the details of a particular log with the id.
operationId: readAllLogs
parameters:
- name: id
in: path
description: Name of the tracker to get all the logs.
required: true
schema:
type: string
- in: header
name: Authentication-Token
schema:
type: string
required: true
responses:
'200':
description: Request Successful
content:
application/json:
schema:
type: object
properties:
id:
type: integer
format: int32
example: 1001
value:
type: string
example: "Cricket"
note:
type: string
example: "I think I am kinda enjoying Cricket."
timestamp:
type: string
example: "2022-01-01 03:45"
tracker_id:
type: integer
example: 1
'401':
description: Unauthorised Access
'404':
description: Log not found.
'500':
description: Unexpected Error.
patch:
tags:
- log
summary: Update Log
description: Logged in user can update the log with the logid.
operationId: updateLog
parameters:
- name: id
in: path
schema:
type: integer
format: int32
required: true
- in: header
name: Authentication-Token
schema:
type: string
required: true
requestBody:
description: Details of the Log
content:
application/json:
schema:
type: object
properties:
value:
type: string
example: "Cricket"
note:
type: string
example: I think I am kinda enjoying Cricket.
timestamp:
type: string
example: "2022-01-01 03:45"
responses:
'201':
description: Update Successful.
'401':
description: Unauthorised Access
'404':
description: Log not found.
'500':
description: Unexpected Error.
delete:
tags:
- log
summary: Delete Log
description: Logged in user can delete the log with the logid.
operationId: deleteLog
parameters:
- name: id
in: path
schema:
type: integer
format: int32
required: true
- in: header
name: Authentication-Token
schema:
type: string
required: true
responses:
'404':
description: Log not found.
'200':
description: Deletion Successful.
'400':
description: Invalid id supplied.
'401':
description: Unauthorised Access
'500':
description: Unexpected Error.