Skip to content

docs(repo): Add JSdocs to APIKey backend type#7871

Merged
SarahSoutoul merged 4 commits intorelease/core-2from
ss/api-keys-consistency
Feb 18, 2026
Merged

docs(repo): Add JSdocs to APIKey backend type#7871
SarahSoutoul merged 4 commits intorelease/core-2from
ss/api-keys-consistency

Conversation

@SarahSoutoul
Copy link
Contributor

@SarahSoutoul SarahSoutoul commented Feb 17, 2026

Description

I noticed the APIKey backend object didn't have JSDoc comments that can then be used for a Typedoc output to be used in our docs. This is part of working towards improving the documentation for the APIKey backend docs. Currently, we don't have it documented properly.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@SarahSoutoul SarahSoutoul self-assigned this Feb 17, 2026
@changeset-bot
Copy link

changeset-bot bot commented Feb 17, 2026

🦋 Changeset detected

Latest commit: 22b788e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link

vercel bot commented Feb 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment Feb 18, 2026 4:55pm

Request Review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 17, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ss/api-keys-consistency

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@SarahSoutoul SarahSoutoul marked this pull request as ready for review February 18, 2026 16:25
@SarahSoutoul SarahSoutoul changed the title Add JSdocs to APIKey backend type docs(repo): Add JSdocs to APIKey backend type Feb 18, 2026
Copy link
Member

@wobsoriano wobsoriano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Left a minor suggestion

@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 18, 2026

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@7871

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@7871

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@7871

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@7871

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@7871

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@7871

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@7871

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@7871

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@7871

@clerk/express

npm i https://pkg.pr.new/@clerk/express@7871

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@7871

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@7871

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@7871

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@7871

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@7871

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@7871

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@7871

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@7871

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@7871

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@7871

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@7871

@clerk/types

npm i https://pkg.pr.new/@clerk/types@7871

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@7871

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@7871

commit: 22b788e

Co-authored-by: Robert Soriano <sorianorobertc@gmail.com>
@SarahSoutoul SarahSoutoul merged commit 8e4fa16 into release/core-2 Feb 18, 2026
44 checks passed
@SarahSoutoul SarahSoutoul deleted the ss/api-keys-consistency branch February 18, 2026 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments