chore: openapi references

[chronark]

What does this PR do?

This PR fixes tag naming consistency in rate limit routes and updates API documentation sources. It changes the tag from "ratelimit" to "ratelimits" in three rate limit override routes for better consistency. Additionally, it updates the OpenAPI source URLs in the docs configuration to point to the correct endpoints.

Fixes # (issue)

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 rate limit routes are properly grouped under the "ratelimits" tag in the API documentation
• Confirm that the API documentation is correctly loading from the updated source URLs

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

• Documentation
  • Updated OpenAPI route tags for rate limit endpoints for improved consistency.
  • Updated documentation configuration to use new source URLs for OpenAPI specifications.

[changeset-bot]

⚠️ No Changeset found

Latest commit: aabe611

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	Aug 4, 2025 7:49am
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 4, 2025 7:49am

[coderabbitai]

📝 Walkthrough

Walkthrough

This change updates the OpenAPI route metadata tags from "ratelimit" to "ratelimits" in three API route files and modifies documentation configuration URLs for the OpenAPI specification sources. No application logic or exported entities are affected.

Changes

Cohort / File(s)	Change Summary
API Route Tag Updates apps/api/src/routes/v1_ratelimits_getOverride.ts, apps/api/src/routes/v1_ratelimits_listOverrides.ts, apps/api/src/routes/v1_ratelimits_setOverride.ts	Changed OpenAPI route metadata tags from "ratelimit" to "ratelimits".
Docs OpenAPI Source URLs apps/docs/docs.json	Updated OpenAPI specification source URLs for v1 and v2 endpoints in documentation config.

Sequence Diagram(s)

No sequence diagram generated due to the metadata-only nature of the changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• feat: sdk docs #3051: Updates SDK documentation method calls from unkey.ratelimit.* to unkey.ratelimits.*, reflecting the same namespace pluralization as this PR.

Suggested labels

Bug

Suggested reviewers

• perkinsjr
• mcstepp
• MichaelUnkey

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4e9a819 and aabe611.

📒 Files selected for processing (4)

• apps/api/src/routes/v1_ratelimits_getOverride.ts (1 hunks)
• apps/api/src/routes/v1_ratelimits_listOverrides.ts (1 hunks)
• apps/api/src/routes/v1_ratelimits_setOverride.ts (1 hunks)
• apps/docs/docs.json (2 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*.{js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (CLAUDE.md)

**/*.{js,jsx,ts,tsx}: Use Biome for formatting and linting in TypeScript/JavaScript projects
Prefer named exports over default exports in TypeScript/JavaScript, except for Next.js pages

Files:

• apps/api/src/routes/v1_ratelimits_getOverride.ts
• apps/api/src/routes/v1_ratelimits_listOverrides.ts
• apps/api/src/routes/v1_ratelimits_setOverride.ts

**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (CLAUDE.md)

**/*.{ts,tsx}: Follow strict TypeScript configuration
Use Zod for runtime validation in TypeScript projects

Files:

• apps/api/src/routes/v1_ratelimits_getOverride.ts
• apps/api/src/routes/v1_ratelimits_listOverrides.ts
• apps/api/src/routes/v1_ratelimits_setOverride.ts

**/*.{env,js,ts,go}

📄 CodeRabbit Inference Engine (CLAUDE.md)

All environment variables must follow the format: UNKEY_<SERVICE_NAME>_VARNAME

Files:

• apps/api/src/routes/v1_ratelimits_getOverride.ts
• apps/api/src/routes/v1_ratelimits_listOverrides.ts
• apps/api/src/routes/v1_ratelimits_setOverride.ts

🧠 Learnings (11)

📓 Common learnings

Learnt from: Flo4604
PR: unkeyed/unkey#3421
File: go/apps/api/openapi/openapi.yaml:196-200
Timestamp: 2025-07-03T05:58:10.699Z
Learning: In the Unkey codebase, OpenAPI 3.1 is used, which allows sibling keys (such as `description`) alongside `$ref` in schema objects. Do not flag this as an error in future reviews.

Learnt from: chronark
PR: unkeyed/unkey#2126
File: apps/api/src/routes/v1_ratelimit_getOverride.happy.test.ts:36-36
Timestamp: 2024-11-13T19:06:36.786Z
Learning: In the rate limit test files (e.g., `apps/api/src/routes/v1_ratelimit_getOverride.happy.test.ts`), URL parameters like `namespaceId` and `identifier` do not need to be URL-encoded in the test code because the values used are always considered safe within the test environment.

Learnt from: chronark
PR: unkeyed/unkey#2544
File: apps/api/src/pkg/env.ts:4-6
Timestamp: 2024-10-23T12:05:31.121Z
Learning: The `cloudflareRatelimiter` type definition in `apps/api/src/pkg/env.ts` should not have its interface changed; it should keep the `limit` method returning `Promise<{ success: boolean }>` without additional error properties.

📚 Learning: the `cloudflareratelimiter` type definition in `apps/api/src/pkg/env.ts` should not have its interfa...

Learnt from: chronark
PR: unkeyed/unkey#2544
File: apps/api/src/pkg/env.ts:4-6
Timestamp: 2024-10-23T12:05:31.121Z
Learning: The `cloudflareRatelimiter` type definition in `apps/api/src/pkg/env.ts` should not have its interface changed; it should keep the `limit` method returning `Promise<{ success: boolean }>` without additional error properties.

Applied to files:

• apps/api/src/routes/v1_ratelimits_getOverride.ts
• apps/api/src/routes/v1_ratelimits_listOverrides.ts
• apps/api/src/routes/v1_ratelimits_setOverride.ts

📚 Learning: in the rate limit test files (e.g., `apps/api/src/routes/v1_ratelimit_getoverride.happy.test.ts`), u...

Learnt from: chronark
PR: unkeyed/unkey#2126
File: apps/api/src/routes/v1_ratelimit_getOverride.happy.test.ts:36-36
Timestamp: 2024-11-13T19:06:36.786Z
Learning: In the rate limit test files (e.g., `apps/api/src/routes/v1_ratelimit_getOverride.happy.test.ts`), URL parameters like `namespaceId` and `identifier` do not need to be URL-encoded in the test code because the values used are always considered safe within the test environment.

Applied to files:

• apps/api/src/routes/v1_ratelimits_getOverride.ts
• apps/api/src/routes/v1_ratelimits_listOverrides.ts
• apps/api/src/routes/v1_ratelimits_setOverride.ts

📚 Learning: in `apps/dashboard/lib/trpc/routers/ratelimit/createoverride.ts`, when determining the maximum numbe...

Learnt from: ogzhanolguncu
PR: unkeyed/unkey#2707
File: apps/dashboard/lib/trpc/routers/ratelimit/createOverride.ts:63-63
Timestamp: 2024-12-05T13:27:55.555Z
Learning: In `apps/dashboard/lib/trpc/routers/ratelimit/createOverride.ts`, when determining the maximum number of rate limit overrides (`max`), the intentional use of `const max = hasWorkspaceAccess("ratelimitOverrides", namespace.workspace) || 5;` allows `max` to fall back to `5` when `hasWorkspaceAccess` returns `0` or `false`. This fallback behavior is expected and intended in the codebase.

Applied to files:

• apps/api/src/routes/v1_ratelimits_getOverride.ts
• apps/api/src/routes/v1_ratelimits_listOverrides.ts
• apps/api/src/routes/v1_ratelimits_setOverride.ts

📚 Learning: in `apps/api/src/pkg/keys/service.ts`, `ratelimitasync` is a table relation, not a column selection....

Learnt from: chronark
PR: unkeyed/unkey#2294
File: apps/api/src/pkg/keys/service.ts:268-271
Timestamp: 2024-10-20T07:05:55.471Z
Learning: In `apps/api/src/pkg/keys/service.ts`, `ratelimitAsync` is a table relation, not a column selection. When querying, ensure that table relations are included appropriately, not as columns.

Applied to files:

• apps/api/src/routes/v1_ratelimits_getOverride.ts
• apps/api/src/routes/v1_ratelimits_listOverrides.ts
• apps/api/src/routes/v1_ratelimits_setOverride.ts

📚 Learning: in apps/dashboard/lib/trpc/routers/deployment/getopenapidiff.ts, the user mcstepp prefers to keep mo...

Learnt from: mcstepp
PR: unkeyed/unkey#3662
File: apps/dashboard/lib/trpc/routers/deployment/getOpenApiDiff.ts:110-147
Timestamp: 2025-07-25T19:11:00.208Z
Learning: In apps/dashboard/lib/trpc/routers/deployment/getOpenApiDiff.ts, the user mcstepp prefers to keep mock data fallbacks in POC/demonstration code for simplicity, even if it wouldn't be production-ready. This aligns with the PR being work-in-progress for demonstration purposes.

Applied to files:

• apps/api/src/routes/v1_ratelimits_getOverride.ts
• apps/api/src/routes/v1_ratelimits_listOverrides.ts
• apps/api/src/routes/v1_ratelimits_setOverride.ts

📚 Learning: in `apps/api/src/routes/v1_keys_updatekey.ts`, the code intentionally handles `externalid` and `owne...

Learnt from: chronark
PR: unkeyed/unkey#2693
File: apps/api/src/routes/v1_keys_updateKey.ts:350-368
Timestamp: 2024-11-29T15:15:47.308Z
Learning: In `apps/api/src/routes/v1_keys_updateKey.ts`, the code intentionally handles `externalId` and `ownerId` separately for clarity. The `ownerId` field will be removed in the future, simplifying the code.

Applied to files:

• apps/api/src/routes/v1_ratelimits_getOverride.ts
• apps/api/src/routes/v1_ratelimits_listOverrides.ts
• apps/api/src/routes/v1_ratelimits_setOverride.ts

📚 Learning: in `authorization/roles/[roleid]/update-role.tsx`, the tag `role-${role.id}` is revalidated after up...

Learnt from: AkshayBandi027
PR: unkeyed/unkey#2215
File: apps/dashboard/app/(app)/@breadcrumb/authorization/roles/[roleId]/page.tsx:28-29
Timestamp: 2024-10-08T15:33:04.290Z
Learning: In `authorization/roles/[roleId]/update-role.tsx`, the tag `role-${role.id}` is revalidated after updating a role to ensure that the caching mechanism is properly handled for roles.

Applied to files:

• apps/api/src/routes/v1_ratelimits_getOverride.ts
• apps/api/src/routes/v1_ratelimits_setOverride.ts

📚 Learning: in the unkey codebase, openapi 3.1 is used, which allows sibling keys (such as `description`) alongs...

Learnt from: Flo4604
PR: unkeyed/unkey#3421
File: go/apps/api/openapi/openapi.yaml:196-200
Timestamp: 2025-07-03T05:58:10.699Z
Learning: In the Unkey codebase, OpenAPI 3.1 is used, which allows sibling keys (such as `description`) alongside `$ref` in schema objects. Do not flag this as an error in future reviews.

Applied to files:

• apps/docs/docs.json

📚 Learning: applies to go/deploy/**/*.{go,js,ts,tsx,py,sh,md,txt,json,yaml,yml,ini,env,conf,html,css,scss,xml,c,...

Learnt from: CR
PR: unkeyed/unkey#0
File: go/deploy/CLAUDE.md:0-0
Timestamp: 2025-07-21T18:05:58.236Z
Learning: Applies to go/deploy/**/*.{go,js,ts,tsx,py,sh,md,txt,json,yaml,yml,ini,env,conf,html,css,scss,xml,c,h,cpp,java,rb,rs,php,pl,sql} : Update relevant anchors when modifying associated code.

Applied to files:

• apps/docs/docs.json

📚 Learning: in the unkey codebase, input validation for api endpoints is primarily handled through openapi schem...

Learnt from: Flo4604
PR: unkeyed/unkey#2955
File: go/apps/api/routes/v2_identities_create_identity/handler.go:162-202
Timestamp: 2025-03-19T09:25:59.751Z
Learning: In the Unkey codebase, input validation for API endpoints is primarily handled through OpenAPI schema validation, which occurs before requests reach the handler code. For example, in the identities.createIdentity endpoint, minimum values for ratelimit duration and limit are defined in the OpenAPI schema rather than duplicating these checks in the handler.

Applied to files:

• apps/docs/docs.json

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: Build / Build
• GitHub Check: Test API / API Test Local
• GitHub Check: Test Packages / Test
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (5)

apps/docs/docs.json (2)

248-250: Source URL update looks correct — no concerns.

Switching from the canary endpoint to the stable api.unkey.dev/openapi.json aligns with production usage. Docs generators that rely on application/json should continue to work without further tweaks.

---

270-272: Confirm downstream tooling accepts the new Speakeasy URL.

The new v2 source points at the Speakeasy-hosted JSON+code-samples endpoint. Triple-check any internal scripts that:

1. Expect a .yaml MIME type, or
2. Assume the spec lives under the api.unkey.com domain.

If you control those scripts, no further action needed; otherwise, update them accordingly.

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

10-10: Tag rename improves consistency — good change.

No other route metadata was modified, so nothing else to validate here.

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

13-13: Consistent plural tag — LGTM.

The OpenAPI grouping will now match the other ratelimit endpoints.

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

10-10: Plural tag adopted — looks good.

This keeps documentation grouping uniform with the related list/set routes.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 08-04-chore_openapi_references

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
• 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 explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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.

[chronark]

• chore: openapi references #3723 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

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

[graphite-app]

[graphite-app]

Graphite Automations

"Post a GIF when PR approved" took an action on this PR • (08/04/25)

1 gif was posted to this PR based on Andreas Thomas's automation.

[Flo4604]

@chronark can you force merge this?

Its waiting for the required go CI which we dont trigger since there are no go related changes