Fix api contract for Post /requests endpoint of OOO requests

[surajmaity1]

Date: 12 Mar, 2025

Developer Name: Suraj Maity ( @surajmaity1 )

---

Issue Ticket Number

• Open Fix api contract for Post /requests endpoint of OOO requests #224

Description

• Renamed message to reason field and removed state field from OOO's request body.
• Updated response body of OOO request
• Added error responses.

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 - Fix: feature to create OOO request website-backend#2383
• Test PR - feat: add test cases for POST /requests creating OOO request website-backend#2386

[coderabbitai]

Summary by CodeRabbit

• Documentation
  • Enhanced API documentation with updated request structure guidelines.
  • Revised success response details for out-of-office requests.
  • Updated error handling, introducing a new conflict status and additional codes for forbidden and not-found scenarios.

Walkthrough

The pull request updates the API documentation in requests/README.md. The request body for creating a new request now expects a reason field instead of message and omits the state field. The success response for out-of-office (OOO) requests has been updated by removing message and state and adding comment, status, and lastModifiedBy. Additionally, error responses have been revised: a 400 status for duplicate requests is now a 409, and new error responses with status codes 403 and 404 have been introduced for forbidden actions and not found user statuses, respectively.

Changes

File	Change Summary
requests/README.md	Updated request body: replaced message with reason and removed state; updated success response: removed message and state, added comment, status, lastModifiedBy; modified error responses: changed duplicate request status from 400 to 409, added 403 and 404 error codes.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant S as Server API

    C->>S: POST /requests (with "reason")
    alt Valid Request
        S-->>C: 200 Success (includes comment, status, lastModifiedBy)
    else Duplicate Request
        S-->>C: 409 Conflict Response
    else Forbidden Action (e.g., already OOO)
        S-->>C: 403 Forbidden Response
    else User Status Not Found
        S-->>C: 404 Not Found Response
    end

Loading

Poem

I'm just a rabbit, hopping with glee,
My API carrots now fresh and free.
"Reason" replaces old chatter in the code,
With new responses lighting our road.
Error codes dance — a curious display,
Hoppy changes lead the way!
🐇🌟

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent 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 988ab2c.

📒 Files selected for processing (1)

• requests/README.md (2 hunks)

🔇 Additional comments (3)

requests/README.md (3)

141-147: Updated Request Example for OOO Requests
In the example OOO request, the old field "message" has been replaced with "reason", and the "state" field is removed. This update correctly reflects the new API contract.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

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

(MD031, blanks-around-fences)

---

190-207: Enhanced Success Response Structure for OOO Requests
The success response now includes additional fields ("userId", "reason", "comment", "status", "lastModifiedBy") while omitting the deprecated "message" and "state" fields from the data object. Ensure the backend implementation and documentation are in sync with these new specifications.

---

209-216: Refined Error Responses for OOO Requests
New error responses have been defined:

• 403: Forbidden – when the user's status is already OOO.
• 404: Not Found – when the user status is not found.
• 409: Conflict – for duplicate requests.

This change improves clarity and aligns with best REST practices for error handling.

---

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.

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 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.

[MayankBansal12]

Hi @surajmaity1, can you provide a screenshot of the request and its response (either from rough implementation or design doc) to verify the structure