Add API contract for PATCH /requests/:id endpoint for OOO request

[surajmaity1]

Date: 18 Mar, 2025

Developer Name: Suraj Maity ( @surajmaity1 )

---

Issue Ticket Number

• Closes doc: Add API contract for the PATCH /requests/:id endpoint for OOO request #225

Description

The PR adds the API contract for PATCH /requests/:id endpoint for OOO requests.

• The API contract defines the success response with the correct status code and response body.
• The API contract defines proper error response for different edge cases with correct status codes and meaningful error messages.

Documentation Updated?

• Yes
• No

Under Feature Flag

• Yes
• No

Database Changes

• Yes
• No

Breaking Changes

• Yes
• No

Development Tested?

• Yes
• No

Screenshots

Screenshot 1

Test Coverage

Screenshot 1

Additional Notes

• Design Document - User OOO Management
• Feature PR - Add feature to approve or reject OOO request website-backend#2384
• Test PR - feat: Add test cases for PATCH /requests/:id API for acknowledging OOO requests website-backend#2391

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Summary by CodeRabbit

• Documentation
  • Enhanced API documentation for Out-of-Office requests.
  • Provided detailed examples for expected JSON input and success responses.
  • Clarified error scenarios including unauthorized access, invalid requests, and internal errors.

Walkthrough

The pull request updates the API documentation in the requests/README.md file to provide detailed examples for Out of Office (OOO) requests using the PATCH method. It introduces an example JSON payload with a "status" field (values "APPROVED" or "REJECTED") and an optional "comment", along with success and various error response examples (400, 401, 404, 500). No changes were made to the public API declarations.

Changes

File	Change Summary
requests/README.md	Added detailed documentation for OOO PATCH requests, including an example request payload, a success response example, and multiple error responses (400, 401, 404, 500).

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Server

    Client->>API: PATCH /ooo-request (with JSON payload)
    API->>Server: Validate and process OOO request
    alt Valid Request
        Server-->>API: Success response (APPROVED/REJECTED with message)
    else Invalid Request
        Server-->>API: 400 Error ("Invalid request type", "Request already approved", or "Request already rejected")
    else Unauthorized
        Server-->>API: 401 Error (unauthenticated or super user restrictions)
    else Not Found/Error
        Server-->>API: 404 Error (request does not exist) or 500 Error (internal server error)
    end
    API-->>Client: Return appropriate response

Loading

Possibly related issues

• doc: Add API contract for the PATCH /requests/:id endpoint for OOO request #225: This PR enhances the PATCH method documentation for OOO requests by providing concrete examples and error cases, which aligns with the broader API contract improvements referenced in the issue.

Poem

I’m a rabbit with a hop and a skip,
Reading docs that now have a new tip.
With examples and errors all laid out clear,
API adventures bring a cheerful cheer!
Hop along, my friends, for changes are here!
🐰✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 32937f5 and b1428d9.

📒 Files selected for processing (1)

• requests/README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

requests/README.md

391-391: Unordered list indentation
Expected: 2; Actual: 3

(MD007, ul-indent)

---

392-392: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)

---

403-403: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)

🔇 Additional comments (1)

requests/README.md (1)

409-424: API Contract: Clear and Comprehensive Error Responses
The error responses for the PATCH endpoint are well defined for multiple scenarios (400, 401, 404, and 500). Please verify that the duplicate HTTP status codes (multiple 400s and 401s) are intentional to distinctly cover different error conditions.