Skip to content

Commit 1f8ce14

Browse files
committed
feat: acknowledge OOO request
1 parent eb51c07 commit 1f8ce14

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

requests/README.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The Requests API provides endpoints for creating, fetching, and updating request
77
| [GET /requests](#get-requests) | Returns a list of requests with pagination and filtering options. |
88
| [POST /requests](#post-requests) | Creates a new request. |
99
| [PUT /requests/:id](#put-requestsid) | Updates an existing request. |
10-
| [PATCH /requests/:id](#patch-requestsid) | Updates an existing request before approval or rejection. |
10+
| [PATCH /requests/:id](#patch-requestsid) | Updates an existing request before approval or rejection. Also acknowledges (approve or reject) existing request. |
1111

1212
### **GET /requests**
1313

@@ -368,9 +368,10 @@ Updates an existing request with the provided details.
368368

369369
### **PATCH /requests/:id**
370370

371-
Updates an existing request before approval or rejection with the provided details.
371+
This endpoint serves dual purposes based on the request type:
372+
- Updates an existing request before approval or rejection with the provided details. Also acknowledges (approve or reject) existing request with the provided details.
372373

373-
- **Description:** Updates an existing request before approval or rejection with the provided details..
374+
- **Description:** Updates an existing request before approval or rejection with the provided details. Also acknowledges (approve or reject) existing request with the provided details.
374375

375376
- **URL:** `https://api.realdevsquad.com/requests/:id`
376377

@@ -394,6 +395,41 @@ Updates an existing request before approval or rejection with the provided detai
394395

395396
- Body Parameters:
396397

398+
- **Example of OOO Request:**
399+
```json
400+
{
401+
"type": "OOO",
402+
"status": "string", // status must be APPROVED or REJECTED
403+
"comment": "string" // optional
404+
}
405+
```
406+
407+
- **Success Response of OOO Request:**
408+
409+
- **Code:** 200
410+
- **Content:**
411+
```json
412+
{
413+
"message": "Request approved/rejected successfully"
414+
}
415+
```
416+
417+
- **Error Responses of OOO Request:**
418+
- **Code:** 400
419+
- **Content:** `{ "statusCode": 400, "error": "Bad Request", "message": "Invalid request type" }`
420+
- **Code:** 400
421+
- **Content:** `{ "statusCode": 400, "error": "Bad Request", "message": "Request already approved" }`
422+
- **Code:** 400
423+
- **Content:** `{ "statusCode": 400, "error": "Bad Request", "message": "Request already rejected" }`
424+
- **Code:** 401
425+
- **Content:** `{ "statusCode": 401, "error": "Unauthorized", "message": "Unauthenticated User" }`
426+
- **Code:** 401
427+
- **Content:** `{ "statusCode": 401, "error": "Unauthorized", "message": "Only super users are allowed to acknowledge OOO requests" }`
428+
- **Code:** 404
429+
- **Content:** `{ "statusCode": 404, "error": "Not Found", "message": "Request does not exist" }`
430+
- **Code:** 500
431+
- **Content:** `{ "statusCode": 500, "error": "Internal Server Error", "message": "An internal server error occurred" }`
432+
397433
- **Example of Onboarding Extension Request:**
398434
```json
399435
{

0 commit comments

Comments
 (0)