feat: sdk docs

[chronark]

• Update checks for open API endpoints, Adds back our webhook alert.
• remove logs
• fmt
• Add back the env checks
• revert: auditLogId
• docs: fix ratelimit subcommand typo

Summary by CodeRabbit

• Documentation
  • Updated API examples to reference the updated "ratelimits" namespace.
  • Corrected parameter naming inconsistencies for improved clarity.
• Style
  • Enhanced formatting in examples to ensure consistency and readability.

[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	Mar 31, 2025 8:48am
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 31, 2025 8:48am
play	🛑 Canceled (Inspect)			Mar 31, 2025 8:48am
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 31, 2025 8:48am

[changeset-bot]

⚠️ No Changeset found

Latest commit: f187951

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

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This pull request updates the rate limit override documentation by changing method calls from the singular form (ratelimit) to the plural (ratelimits). It modifies four markdown files—updating the method names across delete, get, list, and set override examples. Additionally, the get override example corrects a parameter name from nameSpaceId to namespaceId and adds a newline in the response section, while the set override file includes minor formatting adjustments. These changes standardize the API namespace references.

Changes

File(s)	Summary
apps/.../delete-override.mdx, apps/.../list-overrides.mdx, apps/.../set-override.mdx	Updated method calls from unkey.ratelimit.<method> to unkey.ratelimits.<method>. The set override file also includes minor formatting adjustments.
apps/.../get-override.mdx	Updated method call from unkey.ratelimit.getOverride to unkey.ratelimits.getOverride, corrected nameSpaceId to namespaceId, and added a newline at the end of the <ResponseExample>.

Possibly related PRs

• feat: override methods in sdk #2668: Addresses deleteOverride method updates, directly related to the deletion changes.
• chore: add override routes in unkey ratelimit sdk docs #2741: Covers naming convention changes from singular to plural for rate limit override methods.
• fix: documentation for setOverride is pointing to the limit endpoint #2726: Focuses on modifications to the setOverride method that align with the updated namespace usage.

Suggested labels

Documentation, Bug, 🕹️ oss.gg, :joystick: 150 points

Suggested reviewers

• mcstepp
• perkinsjr
• ogzhanolguncu

---

📜 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 ee0b672 and f187951.

📒 Files selected for processing (4)

• apps/docs/libraries/ts/sdk/ratelimits/overrides/delete-override.mdx (1 hunks)
• apps/docs/libraries/ts/sdk/ratelimits/overrides/get-override.mdx (2 hunks)
• apps/docs/libraries/ts/sdk/ratelimits/overrides/list-overrides.mdx (1 hunks)
• apps/docs/libraries/ts/sdk/ratelimits/overrides/set-override.mdx (4 hunks)

---

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

[github-actions]

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