Skip to content

fix: return 403 Forbidden for unauthorized extension request updates#230

Merged
iamitprakash merged 1 commit into
mainfrom
fix/added-forbidden-status
Apr 5, 2025
Merged

fix: return 403 Forbidden for unauthorized extension request updates#230
iamitprakash merged 1 commit into
mainfrom
fix/added-forbidden-status

Conversation

@AnujChhikara

@AnujChhikara AnujChhikara commented Apr 3, 2025

Copy link
Copy Markdown
Contributor

Date: 3 April 2025

Developer Name: @AnujChhikara


Issue Ticket Number

Description

This PR updates the PATCH /extension-requests/:id API contract by adding a 403 Forbidden response

Documentation Updated?

  • Yes
  • No

Under Feature Flag

  • Yes
  • No

Database Changes

  • Yes
  • No

Breaking Changes

  • Yes
  • No

Development Tested?

  • Yes
  • No

Screenshots

Screenshot 1

image

Test Coverage

Screenshot 1

Additional Notes

@coderabbitai

coderabbitai Bot commented Apr 3, 2025

Copy link
Copy Markdown

Summary by CodeRabbit

  • New Features
    • Enhanced error feedback for extension request updates. Users attempting an update without the required permissions now receive a clear, informative forbidden message, providing better clarity on access restrictions.

Walkthrough

This pull request updates the error handling for the PATCH /extension-requests/:id endpoint. A new error code 403 is introduced when a user lacks permission to update an extension request. The response now returns a JSON object with a status code of 403, an "Forbidden" error, and a detailed message explaining the permission issue. Documentation in extension-requests/README.md has been updated accordingly.

Changes

File Change Summary
extension-requests/README.md Added documentation for a new 403 error response on PATCH /extension-requests/:id with a JSON payload indicating a forbidden update due to permission issues.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant S as API Server
    C->>S: PATCH /extension-requests/:id
    S->>S: Verify user permissions
    alt Insufficient permissions
        S-->>C: 403 Forbidden (JSON with details)
    else Sufficient permissions
        S-->>C: Proceed with update (not shown)
    end
Loading

Possibly related issues

Possibly related PRs

Suggested reviewers

  • vikasosmium

Poem

I'm a rabbit with hops so brisk,
Coding fixes with a digital twist.
Forbidden no longer hides in the code,
A clear 403 now easily showed.
Hoppin' in joy as the errors reside,
With CodeRabbit’s fixes, there's nothing to hide!
🐰💻


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
🪧 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 plan to trigger planning for file edits and PR creation.
  • @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 coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eb51c07 and ad76986.

📒 Files selected for processing (1)
  • extension-requests/README.md (1 hunks)

Comment thread extension-requests/README.md

- **Error Response:**
- **Code** 403
- **Content** `{ 'statusCode': 403, 'error': 'Forbidden', 'message': 'You don't have permission to update the extension request' }`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again, I think the error messsage should be changed

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion! I believe the original message is more appropriate here since it's about permissions, not missing content.

@iamitprakash iamitprakash left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR desc is missing

@iamitprakash
iamitprakash merged commit b1d1c2f into main Apr 5, 2025
@iamitprakash
iamitprakash deleted the fix/added-forbidden-status branch April 5, 2025 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: Add forbidden response in PATCH /extension-requests/:id API contract

5 participants