Skip to content

Commit d904554

Browse files
authored
Add api contract for Post /requests endpoint of onboarding extension requests (#216)
* Update README.md * Fix: change error response code and error name * Fix: change status code to 403 * Fix: change heading * fix: change error message * chore: change response field value * chore: change status code to 409 for sending conflict response
1 parent d77c8ba commit d904554

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

requests/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,15 @@ Creates a new request.
172172
"state": "PENDING"
173173
}
174174
```
175+
- Example Onboarding Extension Request:
176+
```json
177+
{
178+
"type": "ONBOARDING",
179+
"numberOfDays": "<number>",
180+
"userId": "<RDS Discord Id>",
181+
"reason": "<Request Reason>"
182+
}
183+
```
175184

176185
- **Success Response of OOO Request:**
177186

@@ -200,6 +209,40 @@ Creates a new request.
200209
- **Code:** 500
201210
- **Content:** `{ "statusCode": 500, "error": "Internal Server Error", "message": "An internal server error occurred" }`
202211

212+
- **Success Response of Onboarding Extension Request:**
213+
214+
- **Code:** 201
215+
- **Content:**
216+
```json
217+
{
218+
"message": "Onboarding extension request created successfully",
219+
"data": {
220+
"id": "string",
221+
"createdAt": "number",
222+
"updatedAt": "number",
223+
"requestedBy": "<username>",
224+
"type": "string",
225+
"state": "string",
226+
"userId": "string",
227+
"requestNumber": "number",
228+
"reason": "<request-reason>",
229+
"newEndsOn": "number",
230+
"oldEndsOn": "number",
231+
}
232+
}
233+
```
234+
235+
- **Error Responses of Onboarding Extension Request:**
236+
- **Code:** 409
237+
- **Content:** `{ "statusCode": 409, "error": "Conflict", "message": "Request already exists please wait for approval or rejection" }`
238+
- **Code:** 500
239+
- **Content:** `{ "statusCode": 500, "error": "Internal Server Error", "message": "An internal server error occurred"" }`
240+
- **Code:** 404
241+
- **Content:** `{ "statusCode": 404, "error": "Not Found", "message": "User not found" }`
242+
- **Code:** 403
243+
- **Content:** `{ "statusCode": 403, "error": "Forbidden", "message": "Only super user and onboarding user are authorized to create an onboarding extension request" }`
244+
245+
203246
#### Authentication and Authorization:
204247

205248
- Authentication is required for creating a new request.

0 commit comments

Comments
 (0)