Skip to content

docs(backend,expo,nextjs): Fix broken BAPI links in JSDoc comments#8655

Merged
alexisintech merged 6 commits into
mainfrom
aa/update-links
May 27, 2026
Merged

docs(backend,expo,nextjs): Fix broken BAPI links in JSDoc comments#8655
alexisintech merged 6 commits into
mainfrom
aa/update-links

Conversation

@alexisintech
Copy link
Copy Markdown
Member

Description

Updates broken links to BAPI reference in JSDoc comments
Related to clerk/clerk-docs PR: Update Backend Commerce --> Billing; fix BAPI links

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:

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 26, 2026

🦋 Changeset detected

Latest commit: cf44423

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
Copy Markdown

vercel Bot commented May 26, 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 May 27, 2026 12:37pm

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 74f86f8d-1118-4b09-9839-285b414172e1

📥 Commits

Reviewing files that changed from the base of the PR and between 4b4235c and 2b96317.

📒 Files selected for processing (1)
  • packages/backend/src/api/resources/Deserializer.ts
✅ Files skipped from review due to trivial changes (1)
  • packages/backend/src/api/resources/Deserializer.ts

📝 Walkthrough

Walkthrough

This PR updates sixteen inline documentation links and JSDoc references across backend resource classes, Deserializer and verifyToken comments, Expo hooks, the Next.js currentUser doc, and adds a two-line changeset file. All edits are comment-only link/path changes; no code logic, exported types, or runtime behavior were modified.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 40.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title accurately summarizes the main change: fixing broken Backend API (BAPI) links in JSDoc comments across the specified packages.
Description check ✅ Passed The description is clearly related to the changeset, explaining that it updates broken BAPI reference links in JSDoc comments and references the related clerk-docs PR.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 26, 2026

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8655

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8655

@clerk/upgrade

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

@clerk/vue

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

commit: cf44423

@SarahSoutoul
Copy link
Copy Markdown
Contributor

SarahSoutoul commented May 26, 2026

Do we want to change those too? @alexisintech

Screenshot 2026-05-26 at 3 07 02 pm

@alexisintech
Copy link
Copy Markdown
Member Author

Do we want to change those too? @alexisintech

Screenshot 2026-05-26 at 3 07 02 pm

those json files that get generated are never used in the docs, and changing those generated files would require changing the source code - that's up to the billing team! gonna keep this scope on updating BAPI links 🫡

Copy link
Copy Markdown
Contributor

@SarahSoutoul SarahSoutoul left a comment

Choose a reason for hiding this comment

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

LGTM!

@alexisintech alexisintech merged commit 0796911 into main May 27, 2026
43 checks passed
@alexisintech alexisintech deleted the aa/update-links branch May 27, 2026 18:52
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.

3 participants