Skip to content

Commit eb51c07

Browse files
authored
Merge pull request #223 from surajmaity1/fix/create-ooo-request-api-contract
Fix api contract for Post /requests endpoint of OOO requests
2 parents 32937f5 + 988ab2c commit eb51c07

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

requests/README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,7 @@ Creates a new request.
142142
"type": "OOO",
143143
"from": "<timestamp>",
144144
"until": "<timestamp>",
145-
"message": "<Request Message>",
146-
"state": "PENDING"
145+
"reason": "<Request Reason>"
147146
}
148147
```
149148
- Example EXTENSION Request:
@@ -195,18 +194,25 @@ Creates a new request.
195194
"createdAt": "number",
196195
"updatedAt": "number",
197196
"requestedBy": "string",
197+
"userId": "string",
198198
"type": "string",
199199
"from": "number",
200200
"until": "number",
201-
"message": "string",
202-
"state": "string"
201+
"reason": "string",
202+
"comment": "string",
203+
"status": "string",
204+
"lastModifiedBy": "string"
203205
}
204206
}
205207
```
206208

207-
- **Error Responses:**
208-
- **Code:** 400
209-
- **Content:** `{ "statusCode": 400, "error": "Bad Request", "message": "Request already exists. Please wait for approval or rejection" }`
209+
- **Error Responses of OOO Request:**
210+
- **Code:** 403
211+
- **Content:** `{ "statusCode": 403, "error": "Forbidden", "message": "Your status is already OOO. Please cancel OOO to raise new one" }`
212+
- **Code:** 404
213+
- **Content:** `{ "statusCode": 404, "error": "Not Found", "message": "User status not found" }`
214+
- **Code:** 409
215+
- **Content:** `{ "statusCode": 409, "error": "Conflict", "message": "Request already exists please wait for approval or rejection" }`
210216
- **Code:** 500
211217
- **Content:** `{ "statusCode": 500, "error": "Internal Server Error", "message": "An internal server error occurred" }`
212218

0 commit comments

Comments
 (0)