Skip to content

Commit 5d7807b

Browse files
authored
Merge pull request #226 from surajmaity1/fix/acknowledge-ooo-request-api-contract
Add API contract for PATCH /requests/:id endpoint for OOO request
2 parents 377d467 + 2cc40f5 commit 5d7807b

File tree

1 file changed

+38
-4
lines changed

1 file changed

+38
-4
lines changed

requests/README.md

Lines changed: 38 additions & 4 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 partially. |
1111

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

@@ -368,9 +368,8 @@ 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.
372-
373-
- **Description:** Updates an existing request before approval or rejection with the provided details..
371+
- **Description:**
372+
- This endpoint updates the details of any type of exsisting request (OOO, ONBOARDING etc.).
374373

375374
- **URL:** `https://api.realdevsquad.com/requests/:id`
376375

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

395394
- Body Parameters:
396395

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

0 commit comments

Comments
 (0)