Skip to content

Commit 86706d4

Browse files
Merge pull request #206 from vikasosmium/added-doc-deprecate-extension-requests/self
DOC: Added an API contract for /extension-requests/user/:userId
2 parents 99e19a4 + dff96a3 commit 86706d4

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

extension-requests/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
| [GET /extension-requests](#get-extension-requests) | Return all extension requests |
2222
| [GET /extension-requests/:id](#get-extension-requests-id) | Return extension request with id |
2323
| [GET /extension-requests/self](#get-extension-requests-self) | Return all extension requests of a user |
24+
| [GET /extension-requests/user/:userId](#get-extension-requests-userId) | Return extension request with userId |
2425
| [POST /extension-requests](#post-extension-requests) | Creates new extension request |
2526
| [PATCH /extension-requests/:id](#patch-extension-requestsid) | Updates extension request |
2627
| [PATCH /extension-requests/:id/status](#patch-extension-requests-id-status) | APPROVE or DENY an extension request |
@@ -128,6 +129,41 @@ Returns all the extension requests of a user for a task if query `taskId=<taskId
128129
- **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }`
129130

130131

132+
## **GET /extension-requests/user/:userId**
133+
134+
Returns all the extension requests of a authenticated user for a task by userId if query `taskId=<taskId>` is passed, else returns all the extension requests of the user.
135+
136+
- **Params**
137+
userId=``<userId>``
138+
- **Query**
139+
`status=APPROVED | DENIED | PENDING, taskId=<task_object_id>`
140+
- **Body**
141+
None
142+
- **Headers**
143+
Content-Type: application/json
144+
- **Cookie**
145+
rds-session: `<JWT>`
146+
- **Success Response:**
147+
- **Code:** 200
148+
- **Content:**
149+
```
150+
{
151+
message: 'Extension Requests returned successfully!'
152+
allExtensionRequests: [{<extension_request_object>}]
153+
}
154+
```
155+
156+
- **Error Response:**
157+
- **Code:** 401
158+
- **Content:** `{ 'statusCode': 401, 'error': 'Unauthorized', 'message': 'Unauthenticated User' }`
159+
- **Code:** 403
160+
- **Content:** `{ 'statusCode': 403, 'error': 'Forbidden', 'message': 'Forbidden access' }`
161+
- **Code:** 404
162+
- **Content:** `{ 'statusCode': 404, 'error': 'Not Found', 'message': 'User doesn't exist' }`
163+
- **Code:** 500
164+
- **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }`
165+
166+
131167
## **POST /extension-requests**
132168

133169
- **Params**

0 commit comments

Comments
 (0)