fix: some more v2 api changes

[Flo4604]

What does this PR do?

Sorry for the different type of changes but I just fixed everything I found when testing.

THis fixes our list endpoints which didnt respect the limit parmaeter
also prints our error messages without "xxx"\ anymore and just uses 'xxxx'
Fixes the title for the duplicate role/permission errors
Fixes the naming for our buffers

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?

• Test A
• Test B

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

  • Role and permission identifier patterns are now more flexible, allowing additional characters such as colons, periods, and asterisks.
  • The limit for listing roles and permissions can now be set via a request parameter, enabling dynamic pagination.

• Bug Fixes

  • Pagination and cursor handling for listing keys, roles, permissions, and rate limit overrides are improved for accuracy and consistency.

• Style

  • Error messages now consistently use single quotes around identifiers in user-facing responses.

• Documentation

  • Error and API documentation updated for clarity and accuracy, including improved error descriptions and identifier references.

• Chores

  • Internal documentation and code comments updated for better maintainability and alignment with current behavior.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 63a5d92

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 ↗︎

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
dashboard	⬜️ Ignored (Inspect)	Visit Preview		Jul 30, 2025 10:05am
engineering	⬜️ Ignored (Inspect)	Visit Preview		Jul 30, 2025 10:05am

[coderabbitai]

📝 Walkthrough

Walkthrough

This change set updates error message formatting for roles, permissions, and rate limits to use single quotes, and clarifies duplicate permission errors to reference "slug" instead of "name". It also introduces dynamic, parameterized pagination for listing roles, permissions, and rate limit overrides, and removes the NamespaceId field from rate limit override schemas and responses. OpenAPI schemas and related SQL queries are updated for expanded identifier patterns and improved pagination.

Changes

Cohort / File(s)	Change Summary
Error Message Formatting (Single Quotes, Slug Reference) apps/docs/errors/unkey/data/permission_already_exists.mdx, go/apps/api/routes/v2_keys_add_roles/handler.go, go/apps/api/routes/v2_keys_create_key/handler.go, go/apps/api/routes/v2_keys_remove_permissions/handler.go, go/apps/api/routes/v2_keys_remove_roles/handler.go, go/apps/api/routes/v2_keys_set_roles/404_test.go, go/apps/api/routes/v2_keys_set_roles/handler.go, go/apps/api/routes/v2_keys_update_key/handler.go, go/apps/api/routes/v2_identities_update_identity/handler.go, go/apps/api/routes/v2_permissions_create_permission/handler.go, go/apps/api/routes/v2_permissions_create_role/handler.go, go/internal/services/keys/validation.go, go/apps/api/routes/v2_keys_verify_key/412_test.go	Standardizes error message formatting to use single quotes for identifiers and updates duplicate permission errors to reference "slug" instead of "name".
Pagination and Limit Parameterization go/apps/api/routes/v2_permissions_list_roles/handler.go, go/apps/api/routes/v2_permissions_list_permissions/handler.go, go/apps/api/routes/v2_ratelimit_list_overrides/handler.go, go/apps/api/routes/v2_apis_list_keys/handler.go, go/pkg/db/role_list.sql_generated.go, go/pkg/db/queries/role_list.sql, go/pkg/db/permission_list.sql_generated.go, go/pkg/db/queries/permission_list.sql, go/pkg/db/ratelimit_override_list_by_namespace_id.sql_generated.go, go/pkg/db/queries/ratelimit_override_list_by_namespace_id.sql, go/pkg/db/querier_generated.go	Adds dynamic limit parameters and cursor-based pagination to handlers and queries for roles, permissions, and rate limit overrides.
Rate Limit Override Schema and Response Changes go/apps/api/openapi/gen.go, go/apps/api/openapi/openapi-generated.yaml, go/apps/api/openapi/spec/common/ratelimitOverride.yaml, go/apps/api/openapi/spec/common/ratelimitResponse.yaml, go/apps/api/routes/v2_ratelimit_get_override/handler.go, go/apps/api/routes/v2_ratelimit_list_overrides/handler.go, go/apps/api/routes/v2_ratelimit_list_overrides/200_test.go, go/apps/api/routes/v2_ratelimit_get_override/200_test.go	Removes the NamespaceId field from rate limit override schemas and responses, updates related tests and OpenAPI specs.
OpenAPI: Expanded Identifier Patterns go/apps/api/openapi/openapi-generated.yaml, go/apps/api/openapi/spec/paths/v2/keys/createKey/V2KeysCreateKeyRequestBody.yaml, go/apps/api/openapi/spec/paths/v2/keys/removeRoles/V2KeysRemoveRolesRequestBody.yaml, go/apps/api/openapi/spec/paths/v2/keys/setRoles/V2KeysSetRolesRequestBody.yaml, go/apps/api/openapi/spec/paths/v2/keys/updateKey/V2KeysUpdateKeyRequestBody.yaml, go/apps/api/openapi/spec/paths/v2/permissions/deleteRole/V2PermissionsDeleteRoleRequestBody.yaml, go/apps/api/openapi/spec/paths/v2/permissions/getRole/V2PermissionsGetRoleRequestBody.yaml	Updates OpenAPI schemas to allow broader character sets for role and permission identifiers, removing initial letter constraints and adding support for colons, dots, asterisks, etc.
OpenAPI: Identity Creation Response Structuring go/apps/api/openapi/gen.go, go/apps/api/openapi/openapi-generated.yaml, go/apps/api/openapi/spec/paths/v2/identities/createIdentity/V2IdentitiesCreateIdentityResponseData.yaml, go/apps/api/routes/v2_identities_create_identity/handler.go	Changes identity creation API response from a generic map to a struct with an explicit identityId field.
Handler Response Consistency (Empty Data Field) go/apps/api/routes/v2_apis_delete_api/handler.go, go/apps/api/routes/v2_permissions_delete_permission/handler.go, go/apps/api/routes/v2_permissions_delete_role/handler.go	Adds an empty Data field to successful delete responses for APIs, permissions, and roles.
Documentation and Formatting go/apps/api/routes/v2_ratelimit_list_overrides/IMPLEMENTATION_SUMMARY.md, go/pkg/codes/constants_gen.go, go/pkg/clickhouse/client.go	Deletes implementation summary doc, adjusts code comments/formatting, and updates batch processor names in ClickHouse client.
Miscellaneous Minor Changes go/apps/api/routes/v2_ratelimit_set_override/handler.go, go/apps/api/openapi/spec/paths/v2/keys/verifyKey/VerifyKeyRatelimitData.yaml, go/apps/api/openapi/spec/paths/v2/keys/setRoles/V2KeysSetRolesRequestBody.yaml	Minor formatting, blank line, or schema constraint removals with no impact on logic or exported entities.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant DB

    Client->>API: Request list (roles/permissions/ratelimit overrides) with limit & cursor
    API->>DB: Query with limit+1 and cursor
    DB-->>API: Return results
    API->>API: Determine hasMore, set nextCursor, trim to limit
    API-->>Client: Response with data, hasMore, nextCursor

Loading

sequenceDiagram
    participant Client
    participant API

    Client->>API: Create identity request
    API->>API: Generate identityID
    API->>DB: Insert identity with identityID
    DB-->>API: Success
    API-->>Client: Response { identityId: ... }

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• fix: v2 wrong error codes #3672: Adds duplicate error codes and updates error handling middleware for permissions and roles, related to duplicate permission error handling in this PR.
• fix: throw conflict error for duplicate roles/permissions #2845: Changes error code from "NOT_UNIQUE" to "CONFLICT" for duplicate roles/permissions and improves conflict error handling; related to this PR's duplicate permission/role error handling changes.

Suggested labels

Bug, Core Team

Suggested reviewers

• perkinsjr
• imeyer
• MichaelUnkey
• ogzhanolguncu

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-smaller-v2-stuff

---

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.
  • @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 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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

[github-actions]

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

[coderabbitai]

Actionable comments posted: 3

♻️ Duplicate comments (8)

go/apps/api/openapi/spec/paths/v2/keys/setRoles/V2KeysSetRolesRequestBody.yaml (1)

29-29: Pattern change consistent with broader schema updates.

This pattern change aligns with similar updates across multiple role-related schemas. However, this significantly relaxes role validation from the previous strict requirements.

The same validation pattern consistency concern applies here as mentioned in the removeRoles schema review.

go/apps/api/openapi/spec/paths/v2/keys/createKey/V2KeysCreateKeyRequestBody.yaml (1)

81-81: Coordinated pattern change across role schemas.

This pattern update is consistent with similar changes across multiple role-related OpenAPI schemas in this PR. The relaxed validation allows for more flexible role naming conventions including namespaced roles with colons and wildcard patterns.

The same validation pattern consistency concern applies here as mentioned in other role schema reviews.

go/apps/api/openapi/spec/paths/v2/permissions/getRole/V2PermissionsGetRoleRequestBody.yaml (1)

9-9: Same broadened regex → same concerns

The same character-set expansion appears here. Ensure consistency with the storage layer and handler logic; otherwise we risk accepting role strings that cannot be resolved downstream.
If the earlier comment is addressed globally, this one can be treated as covered.

go/apps/api/openapi/openapi-generated.yaml (5)

918-921: Same regex change as above

See the comment on Lines 674-678; the same considerations apply here.

---

1006-1009: Same regex change as above

Refer to Lines 674-678 for rationale.

---

1171-1174: Same regex change as above

Refer to Lines 674-678 for rationale.

---

1461-1464: Same regex change as above

Refer to Lines 674-678 for rationale.

---

1523-1527: Same regex change as above

Refer to Lines 674-678 for rationale.

[chronark]

ship it

[graphite-app]

[graphite-app]

Graphite Automations

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

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