chore: Remove getVerifications from docs by perkinsjr · Pull Request #3302 · unkeyed/unkey

perkinsjr · 2025-06-06T12:52:40Z

What does this PR do?

Adds the correct docs to the SDK and removes the old analytics endpoint.

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?

Check out the new libraries/ts/sdk/analytics/get

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

Documentation
- Removed the API reference documentation for the deprecated verifications endpoint.
- Added comprehensive documentation for the new analytics verifications API, including usage examples, parameters, and response structure.
- Updated navigation to reflect the removal of deprecated pages and addition of the new analytics documentation.
- Added a deprecation notice to the old verifications API documentation, recommending use of the new analytics endpoint.

changeset-bot · 2025-06-06T12:52:45Z

⚠️ No Changeset found

Latest commit: 4b976a8

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-06-06T12:52:45Z

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		Jun 6, 2025 7:20pm
engineering	⬜️ Ignored (Inspect)	Visit Preview		Jun 6, 2025 7:20pm

coderabbitai · 2025-06-06T12:52:47Z

📝 Walkthrough

Walkthrough

This change removes the documentation for the deprecated keys.verifications API endpoint, adds a new documentation file for the analytics.getVerifications SDK method, and updates the documentation navigation configuration to reflect these changes. A deprecation notice is also added to the old SDK documentation.

Changes

Files / Groups	Change Summary
apps/docs/api-reference/keys/verifications.mdx	Removed documentation for `GET /v1/keys.getVerifications` API endpoint.
apps/docs/libraries/ts/sdk/analytics/get.mdx	Added new documentation for `analytics.getVerifications` SDK method, detailing usage, parameters, and response.
apps/docs/libraries/ts/sdk/keys/verifications.mdx	Added deprecation warning, advising use of `analytics.getVerifications` instead.
apps/docs/docs.json	Removed references to old verifications docs, added new analytics SDK doc, updated navigation formatting.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant UnkeySDK
    participant UnkeyAPI

    Developer->>UnkeySDK: Call analytics.getVerifications(params)
    UnkeySDK->>UnkeyAPI: GET /analytics/verifications with filters
    UnkeyAPI-->>UnkeySDK: Return grouped verification usage data
    UnkeySDK-->>Developer: Provide parsed analytics data

Possibly related PRs

docs: analytics quickstarts #2807: Improves validation and error handling for the analytics verifications API endpoint, which is now documented in this PR.
fix: formatting for openapi #3102: Fixes formatting in the OpenAPI description for analytics getVerifications endpoint, related to the same API route documented here.

Suggested labels

🕹️ oss.gg, Documentation, Needs Approval

Suggested reviewers

mcstepp
MichaelUnkey
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 2b38b8b and 4b976a8.

📒 Files selected for processing (2)

apps/docs/libraries/ts/sdk/analytics/get.mdx (1 hunks)
apps/docs/libraries/ts/sdk/keys/verifications.mdx (1 hunks)

✅ Files skipped from review due to trivial changes (1)

apps/docs/libraries/ts/sdk/analytics/get.mdx

🚧 Files skipped from review as they are similar to previous changes (1)

apps/docs/libraries/ts/sdk/keys/verifications.mdx

⏰ Context from checks skipped due to timeout of 90000ms (4)

GitHub Check: Test Packages / Test ./packages/cache
GitHub Check: Test Packages / Test ./internal/clickhouse
GitHub Check: autofix
GitHub Check: Analyze (javascript-typescript)

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.
- 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 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-06-06T12:52:54Z

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

coderabbitai

Actionable comments posted: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4ff69b7 and 1e1e34a.

📒 Files selected for processing (4)

apps/docs/api-reference/keys/verifications.mdx (0 hunks)
apps/docs/docs.json (3 hunks)
apps/docs/libraries/ts/sdk/analytics/get.mdx (1 hunks)
apps/docs/libraries/ts/sdk/keys/verifications.mdx (1 hunks)

💤 Files with no reviewable changes (1)

apps/docs/api-reference/keys/verifications.mdx

⏰ Context from checks skipped due to timeout of 90000ms (15)

GitHub Check: Test Packages / Test ./packages/nextjs
GitHub Check: Test Packages / Test ./apps/dashboard
GitHub Check: Test Packages / Test ./packages/rbac
GitHub Check: Test Packages / Test ./packages/hono
GitHub Check: Test Packages / Test ./packages/api
GitHub Check: Test Packages / Test ./internal/keys
GitHub Check: Test Packages / Test ./internal/resend
GitHub Check: Test Packages / Test ./internal/clickhouse
GitHub Check: Test Packages / Test ./packages/cache
GitHub Check: Test Packages / Test ./internal/id
GitHub Check: Test Packages / Test ./internal/hash
GitHub Check: Test Packages / Test ./internal/encryption
GitHub Check: Test Packages / Test ./internal/billing
GitHub Check: autofix
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (3)

apps/docs/docs.json (3)

77-80: Unrelated change: Concept pages updated
The addition of concepts/identities/ratelimits under the "Concepts → Identities" group is outside the scope of removing getVerifications docs. Please confirm if this update is intentional or should be moved to its own PR.

328-331: SDK nav: Analytics group added correctly
The new "Analytics" group with the libraries/ts/sdk/analytics/get page aligns with the PR objectives and appears in the appropriate location under @unkey/api.

368-370: Unrelated change: Migrations pages modified
The libraries/ts/sdk/migrations/migrate-to-unkey addition seems unrelated to getVerifications removal. Please verify this was intended in this PR or relocate it.

apps/docs/libraries/ts/sdk/keys/verifications.mdx

apps/docs/libraries/ts/sdk/analytics/get.mdx

Remove getVerifications

1e1e34a

perkinsjr requested review from MichaelUnkey, chronark, mcstepp and ogzhanolguncu as code owners June 6, 2025 12:52

mintlify bot deployed to staging - apps/docs June 6, 2025 12:53 View deployment

[autofix.ci] apply automated fixes

2b38b8b

coderabbitai bot reviewed Jun 6, 2025

View reviewed changes

mintlify bot deployed to staging - apps/docs June 6, 2025 12:55 View deployment

fix stuff

4b976a8

mintlify bot deployed to staging - apps/docs June 6, 2025 19:19 View deployment

perkinsjr merged commit 56d51eb into main Jun 7, 2025
29 of 30 checks passed

perkinsjr deleted the docs-update branch June 7, 2025 00:20

coderabbitai bot mentioned this pull request Aug 1, 2025

docs: update sdks #3712

Merged

18 tasks

Conversation

perkinsjr commented Jun 6, 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 Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

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

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

perkinsjr commented Jun 6, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jun 6, 2025 •

edited

Loading

vercel bot commented Jun 6, 2025 •

edited

Loading

coderabbitai bot commented Jun 6, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Jun 6, 2025 •

edited

Loading