fix: adding apiId field to verify key code snippet by Nelwhix · Pull Request #2940 · unkeyed/unkey

Nelwhix · 2025-03-08T14:48:15Z

What does this PR do?

This PR adds apiId field to the verifyKey curl request in creating a root key and creating keys under an API page

Fixes # (issue)
#2937

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?

Checklist

Required

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
- Enhanced API key verification by enriching the data payload with an associated API identifier. This update provides additional context during key verification while maintaining the existing user workflow.

changeset-bot · 2025-03-08T14:48:18Z

⚠️ No Changeset found

Latest commit: e4c73f6

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 · 2025-03-08T14:48:20Z

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 8, 2025 2:53pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 8, 2025 2:53pm
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 8, 2025 2:53pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 8, 2025 2:53pm

vercel · 2025-03-08T14:48:22Z

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

A member of the Team first needs to authorize it.

coderabbitai · 2025-03-08T14:48:22Z

📝 Walkthrough

Walkthrough

This pull request updates two components that construct curl command snippets for key verification. Both components now include an additional "apiId" field in the JSON payload alongside the existing "key" field. The changes solely extend the payload without altering the underlying logic or control flow.

Changes

File(s)	Change Summary
`apps/dashboard/.../client.tsx` `apps/dashboard/.../keys.tsx`	Updated curl command snippets to include the `"apiId"` field in the JSON payload along with the `"key"`.

Possibly related PRs

fix: key creation and default prefix #2816: Involved adding an "apiId" field to JSON payloads in different components.
fix: UI for update and create key #2795: Modified the JSON payload to include the "apiId" field in a related component.
feat: add all options to verifyKey #2827: Adjusted the JSON payload for key verification by adding the "apiId" field.

Suggested labels

Feature

Suggested reviewers

mcstepp
chronark
perkinsjr
MichaelUnkey

📜 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 101d62e and e4c73f6.

📒 Files selected for processing (2)

apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx (1 hunks)
apps/dashboard/app/new/keys.tsx (1 hunks)

🔇 Additional comments (2)

apps/dashboard/app/new/keys.tsx (1)

76-79: Added apiId to the verifyKey curl request. LGTM!

This enhances the functionality of the verifyKey curl request by adding the necessary apiId field to the JSON payload, which addresses issue #2937. The change ensures the verification endpoint has both the key and its associated API ID for proper validation.

apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/new/client.tsx (1)

149-152: Added apiId to the verification snippet. LGTM!

This change properly adds the apiId field to the JSON payload, ensuring consistency with the change in the keys.tsx file and addressing issue #2937. The curl command now includes all necessary fields for proper key verification.

✨ Finishing Touches

📝 Generate Docstrings

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

🪧 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 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 · 2025-03-08T14:48:23Z

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

chronark · 2025-03-08T14:49:09Z

ooh very nice, thank you!

fix: adding apiId field to verify key code snippet

e4c73f6

Nelwhix requested review from chronark, mcstepp, ogzhanolguncu and perkinsjr as code owners March 8, 2025 14:48

vercel bot temporarily deployed to Preview – engineering March 8, 2025 14:49 Inactive

vercel bot temporarily deployed to Preview – play March 8, 2025 14:50 Inactive

vercel bot temporarily deployed to Preview – www March 8, 2025 14:51 Inactive

vercel bot temporarily deployed to Preview – dashboard March 8, 2025 14:53 Inactive

chronark merged commit 92624a2 into unkeyed:main Mar 8, 2025
26 of 28 checks passed

This was referenced Mar 13, 2025

feat: Apis overview v2 #2947

Merged

feat: allow clicking on keyid on overview #2990

Closed

coderabbitai bot mentioned this pull request Jul 2, 2025

feat: v2/keys.getKey #3421

Merged

13 tasks

coderabbitai bot mentioned this pull request Jul 28, 2025

fix: remove apiId from verifyKey request #3666

Merged

18 tasks

coderabbitai bot mentioned this pull request Aug 22, 2025

fix: verify key curl #3832

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: adding apiId field to verify key code snippet#2940

fix: adding apiId field to verify key code snippet#2940
chronark merged 1 commit intounkeyed:mainfrom
Nelwhix:improving-verify-key-example

Nelwhix commented Mar 8, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Mar 8, 2025

Uh oh!

vercel bot commented Mar 8, 2025 •

edited

Loading

Uh oh!

vercel bot commented Mar 8, 2025

Uh oh!

coderabbitai bot commented Mar 8, 2025 •

edited

Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Mar 8, 2025 •

edited

Loading

Uh oh!

chronark commented Mar 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Nelwhix commented Mar 8, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Type of change

How should this be tested?

Checklist

Required

Appreciated

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Mar 8, 2025

⚠️ No Changeset found

Uh oh!

vercel bot commented Mar 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Mar 8, 2025

Uh oh!

coderabbitai bot commented Mar 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Mar 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chronark commented Mar 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Nelwhix commented Mar 8, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Mar 8, 2025 •

edited

Loading

coderabbitai bot commented Mar 8, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Mar 8, 2025 •

edited

Loading