Skip to content

Commit dbda48a

Browse files
authored
Add api contract for Put /requests endpoint of onboarding extension requests (#219)
* Update README.md * Fix: change error response code and error name * Fix: change status code to 403 * Fix: change heading * doc: added contracts for put endpoint of onboarding extension request * chore: change status code to 404 when request does not exist * chore: remove unnecessary changes
1 parent d904554 commit dbda48a

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

requests/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,38 @@ Updates an existing request with the provided details.
318318
- **Code:** 500
319319
- **Content:** `{ "statusCode": 500, "error": "Internal Server Error", "message": "An internal server error occurred" }`
320320

321+
- **Success Response of Onboarding Extension Request:**
322+
323+
- **Code:** 200
324+
- **Content:**
325+
```json
326+
{
327+
"message": "Request approved successfully | Request rejected successfully",
328+
"data": {
329+
"id": "string",
330+
"updatedAt": "number",
331+
"type": "string",
332+
"state": "string",
333+
"lastModifiedBy": "string",
334+
"message": "string"
335+
}
336+
}
337+
```
338+
339+
- **Error Responses of Onboarding Extension Request:**
340+
- **Code:** 400
341+
- **Content:** `{ "statusCode": 400, "error": "Bad Request", "message": "Request already rejected" }`
342+
- **Code:** 400
343+
- **Content:** `{ "statusCode": 400, "error": "Bad Request", "message": "Request already approved" }`
344+
- **Code:** 404
345+
- **Content:** `{ "statusCode": 404, "error": "Not Found", "message": "Request does not exist" }`
346+
- **Code:** 500
347+
- **Content:** `{ "statusCode": 500, "error": "Internal Server Error", "message": ""An internal server error occurred" }`
348+
- **Code:** 401
349+
- **Content:** `{ "statusCode": 401, "error": "Unauthorized", "message": "Unauthenticated User" }`
350+
- **Code:** 401
351+
- **Content:** `{ "statusCode": 401, "error": "Unauthorized", "message": "You are not authorized for this action." }`
352+
321353
#### Authentication and Authorization:
322354

323355
- Authentication is required for accessing this endpoint.

0 commit comments

Comments
 (0)