chore: changeset for ratelimit overrides

[MichaelUnkey]

What does this PR do?

Fixes # (issue)

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?

Not sure how one would test this.

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 ratelimit override API, allowing users to configure and override default ratelimit settings.

• Documentation

  • Updated documentation to reflect the new ratelimit override API and its usage.

[changeset-bot]

🦋 Changeset detected

Latest commit: 8f6bbe4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 7 packages

Name	Type
@unkey/docs	Minor
@unkey/api	Minor
@unkey/ratelimit	Minor
@unkey/hono	Patch
@unkey/nextjs	Patch
planetfall	Patch
@unkey/dashboard	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another 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 16, 2024 8:33pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 16, 2024 8:33pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 16, 2024 8:33pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 16, 2024 8:33pm

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a new ratelimit override API to the SDK, allowing users to configure and customize ratelimit settings. The changes span across multiple packages including @unkey/docs, @unkey/api, and @unkey/ratelimit. The implementation adds functionality to override default rate limit configurations, providing more flexibility for developers using the SDK.

Changes

File/Path	Change Summary
.changeset/spotty-hornets-knock.md	Added changeset file documenting the new ratelimit override API feature
@unkey/docs/*	Documentation updates related to the new ratelimit override API
@unkey/api/*	Implementation of ratelimit override API endpoints
@unkey/ratelimit/*	SDK modifications to support ratelimit override functionality

Possibly related PRs

• feat: override methods in sdk #2668: Introduces ratelimit override API in @unkey/api package
• feat: Add override methods and docs #2728: Adds override methods to the SDK
• chore: add override routes in unkey ratelimit sdk docs #2741: Enhances documentation for Unkey ratelimit SDK with override route information

Suggested labels

🕹️ oss.gg, hacktoberfest, Needs Approval

Suggested reviewers

• mcstepp
• ogzhanolguncu
• perkinsjr
• chronark

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 46878c2 and 8f6bbe4.

📒 Files selected for processing (1)

• .changeset/spotty-hornets-knock.md (1 hunks)

🔇 Additional comments (1)

.changeset/spotty-hornets-knock.md (1)

1-4: LGTM on version bumps!

The minor version bumps across all affected packages are appropriate for a new feature addition and maintain version consistency across the related packages.

---

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. (Beta)
• @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! 🙏