fix: Incorrect error for listOverrides fix

[MichaelUnkey]

What does this PR do?

Fixes # (issue)
#2730

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

Api Routes still work

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

• New Features

  • Introduced a new API route for deleting rate limit overrides.

• Bug Fixes

  • Enhanced error handling for namespace not found scenarios in existing routes, providing clearer error messages.

• Chores

  • Updated operation ID for the set override route for improved clarity.

[linear]

ENG-1595 Make sure correct errors are returned for overrides

[changeset-bot]

⚠️ No Changeset found

Latest commit: 54b6188

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 3:50pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 3:50pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 10, 2024 3:50pm
www	🛑 Canceled (Inspect)			Dec 10, 2024 3:50pm

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a new API route for deleting rate limit overrides, defined with a POST method at /v1/ratelimits.deleteOverride. It requires bearer authentication and includes a request body schema with optional fields namespaceId and namespaceName, and a required identifier. Enhanced error handling is implemented, throwing UnkeyApiError exceptions for specific conditions. Additionally, modifications are made to error handling in the existing list and set override routes to improve clarity in error messages, while no new functionalities are introduced in those routes.

Changes

File Path	Change Summary
apps/api/src/routes/v1_ratelimits_deleteOverride.ts	Added a new API route for deleting rate limit overrides with enhanced error handling and audit logging. Added types for request and response.
apps/api/src/routes/v1_ratelimits_listOverrides.ts	Modified error handling to use UnkeyApiError for namespace not found, improving error reporting.
apps/api/src/routes/v1_ratelimits_setOverride.ts	Updated operationId for clarity and enhanced error messages for namespace not found.

Possibly related PRs

• fix: documentation for setOverride is pointing to the limit endpoint #2726: This PR updates the documentation for the setOverride endpoint, which is directly related to the new API route introduced in the main PR for deleting rate limit overrides.

Suggested labels

Bug, 🕹️ oss.gg, :joystick: 300 points, hacktoberfest

Suggested reviewers

• mcstepp
• chronark
• perkinsjr

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c6dfe2d and 54b6188.

📒 Files selected for processing (3)

• apps/api/src/routes/v1_ratelimits_deleteOverride.ts (0 hunks)
• apps/api/src/routes/v1_ratelimits_listOverrides.ts (1 hunks)
• apps/api/src/routes/v1_ratelimits_setOverride.ts (2 hunks)

💤 Files with no reviewable changes (1)

• apps/api/src/routes/v1_ratelimits_deleteOverride.ts

🔇 Additional comments (3)

apps/api/src/routes/v1_ratelimits_listOverrides.ts (1)

103-106: LGTM: Improved error handling with specific namespace identifier

The error handling enhancement provides better clarity by including the specific namespace identifier (either ID or name) that wasn't found. This improvement helps with debugging and user experience.

apps/api/src/routes/v1_ratelimits_setOverride.ts (2)

115-115: LGTM: Consistent error handling improvement

The error message enhancement aligns with the changes in listOverrides, providing better context by including the specific namespace identifier that wasn't found.

---

13-13: Verify impact of operationId change

The change from "ratelimit.setOverride" to "setOverride" could potentially break API clients that rely on the exact operationId. Please verify if this is a breaking change.

✅ Verification successful

Change in operationId is safe

The operationId change from "ratelimit.setOverride" to "setOverride" appears to be safe. The only reference found is in the auto-generated OpenAPI type definitions file (packages/api/src/openapi.d.ts), which will be regenerated with the new operationId. No client code was found using this operationId directly.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any usage of the old operationId in the codebase
rg -l "ratelimit\.setOverride"

# Search for OpenAPI/Swagger documentation files that might reference this operationId
fd -e yaml -e json | xargs rg "ratelimit\.setOverride"

Length of output: 119

---

Script:

#!/bin/bash
# Let's check the content of the OpenAPI definition file to understand the context
cat packages/api/src/openapi.d.ts

# Also search for any client code that might be using this operation
rg -A 2 "setOverride" --type ts

Length of output: 131070

---

Script:

#!/bin/bash
# Let's check if there are any client SDKs or documentation that might be using this operationId
rg -l "ratelimit\.setOverride" --type ts --type js --type md

# Also check for any direct API calls using this operationId
rg -l "POST.*?/v1/ratelimits\.setOverride" --type ts --type js

Length of output: 157

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Experiment)
• @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.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏