-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbrief.py
101 lines (70 loc) · 2.52 KB
/
brief.py
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
title = "Assessment API"
summary = "The API handles all Assessment related tasks for the HNGX \
Zuri Portfolio Project "
version = "0.0.1"
docs = "/api/v1"
description = """
### Summary
This version of the API can do awesome stuff like:
*Get All User Asessments*, *Start Assessment*, *Get Assessment Session Details*, \
*Get Assessment Result*,*Submit Assessment*,*Get User Completed Assessments*,\
*Get User Assessment*.
<details>
<summary>Brief Descriptions</summary>
### Get All User Asessments. =>/assessments
```http
Method:GET
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `token` | `string` | **Required**. *header param* |
### Start Asessment. =>/start-assessment
```http
Method:POST
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `token` | `string` | **Required**. *header param* |
| `assessment_id` | `dict` | **Required**. *request Body* |
### Get Assessment Session Details. =>/session/assessment_id
```http
Method:GET
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `token` | `string` | **Required**. *header param* |
| `assessment_id` | `string` | **Required**. *path param* |
## Get Asessment Result. =>/assessment_id/result
```http
Method:GET
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `token` | `string` | **Required**. *header param* |
| `assessment_id` | `string` | **Required**. *path param* |
### Submit Asessment. =>/submit
```http
Method:POST
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `token` | `string` | **Required**. *header param* |
| `data` | `dict` | **Required**. *request Body* |
### Get User Completed Asessments. =>/get-user-assessments
```http
Method:GET
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `token` | `string` | **Required**. *header param* |
### Get Asessment. =>/assessment_id
```http
Method:GET
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `token` | `string` | **Required**. *header param* |
| `assessment_id` | `string` | **Required**. *path param* |
</details>
---
"""