docs: add missing documentation for namespace parameter in RatelimitConfig @unkey/ratelimit

[Vardhaman619]

What does this PR do?

This PR adds the missing documentation for the namespace parameter in the RatelimitConfig object in the @unkey/ratelimit SDK. The namespace parameter was previously missing from the documentation and was incorrectly described under the rootKey property. The addition of this information will provide users with clear guidance on how to properly configure the ratelimiting functionality using the SDK.

Fixes #2241

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?

• Verify that the namespace parameter is now correctly documented under the RatelimitConfig section in the @unkey/ratelimit SDK documentation.
• Ensure the information is clear and accurate, providing enough details for users to configure the namespace when using the SDK.
• Confirm that the rootKey property is now described correctly without confusion between the two parameters.

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

  • Updated error classification for unauthorized access in documentation.
  • Introduced a namespace parameter in the Ratelimit configuration for better application area management.
  • Added timeout parameter with a fallback mechanism in RatelimitConfig.

• Documentation

  • Enhanced explanations and examples for timeout configuration and onError handler in the @unkey/ratelimit library documentation.

[changeset-bot]

⚠️ No Changeset found

Latest commit: e5be49b

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)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 7, 2024 3:12pm

[vercel]

@Vardhaman619 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Warning

Rate limit exceeded

@github-actions[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 40 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between e7461cf and e5be49b.

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request includes modifications to two documentation files. The UNAUTHORIZED.mdx file updates the openapi-schema field from ErrInternalServerError to ErrUnauthorized, correcting the error categorization for unauthorized access. The ratelimit.mdx file revises the RatelimitConfig documentation to replace the rootKey parameter with a namespace parameter, enhancing the configuration options and providing additional details on the timeout and onError features.

Changes

File Path	Change Summary
apps/docs/api-reference/errors/code/UNAUTHORIZED.mdx	Updated openapi-schema from ErrInternalServerError to ErrUnauthorized.
apps/docs/libraries/ts/ratelimit.mdx	Replaced rootKey parameter with namespace in RatelimitConfig, added details about timeout and onError.

Assessment against linked issues

Objective	Addressed	Explanation
Missing information about namespace parameter in RatelimitConfig (#2241)	✅

Possibly related PRs

• Fix incorrect error code and reference link for UNAUTHORIZED error #2230: This PR directly addresses the same change in the openapi-schema field for the UNAUTHORIZED error, correcting it from ErrInternalServerError to ErrUnauthorized, which is identical to the modification made in the main PR.

Suggested labels

hacktoberfest

---

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 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! 🙏

[oss-gg]

Awarding Vardhaman619: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/Vardhaman619