docs(backend): include the Electron dev server origin in allowedOrigins JSDoc

[manovotny]

Description

The allowedOrigins JSDoc on instances.update() and the Instance resource only mentioned the custom renderer scheme for @clerk/electron apps. FAPI checks allowed origins by exact match, so during development the renderer's dev server origin (for example http://localhost:5173) has to be listed too, or requests get rejected. Both comments now say so, matching the "Allowed origins" section of packages/electron/README.md.

Follows up on #9784. Mirrors the OpenAPI fix in clerk/clerk_go#22577.

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:

🤖 Generated with Claude Code

[vercel]

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

Project	Deployment	Actions	Updated
clerk-js-sandbox	Ready	Preview	Sep 29, 2026 6:51pm UTC
swingset	Ready	Preview	Sep 29, 2026 6:51pm UTC

[changeset-bot]

🦋 Changeset detected

Latest commit: 28ac051

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

This PR includes changesets to release 11 packages

Name	Type
@clerk/backend	Patch
@clerk/astro	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/hono	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch
@clerk/swingset	Patch

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

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Team

Run ID: abf63cdf-0804-4991-aaf2-feb7f2ef0aba

📥 Commits

Reviewing files that changed from the base of the PR and between e34a5cc and 28ac051.

📒 Files selected for processing (3)

• .changeset/electron-allowed-origins-dev-server.md
• packages/backend/src/api/endpoints/InstanceApi.ts
• packages/backend/src/api/resources/Instance.ts

🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

• clerk/clerk_go (manual) → reviewed against open PR #22577 manovotny/docs-12179-unblock-3c736c instead of the default branch
• clerk/dashboard (manual)
• clerk/accounts (manual)
• clerk/backoffice (manual)
• clerk/clerk (manual)
• clerk/clerk-docs (manual)
• clerk/cloudflare-workers (manual)
• clerk/cli (auto-detected)
• clerk/clerk-ios (auto-detected)
• clerk/clerk-android (auto-detected)

Included review availability: This review used your included allowance. 6 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 8 reviews per hour.

---

📝 Walkthrough

Walkthrough

The allowedOrigins documentation for clerkClient.instances.update() and the Instance resource now includes http://localhost:5173 as an Electron renderer development-server origin example. A patch changeset records the documentation update.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 28ac0

The Electron development-origin guidance is ready to merge after normal checks. Generated reference pages are expected to update through the release process.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely identifies the main change: updating backend JSDoc to include the Electron development-server origin in allowedOrigins.
Description check	✅ Passed	The description accurately explains the allowedOrigins JSDoc updates, the Electron development requirement, and the affected resources.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 2…
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.

---

_{Comment @coderabbitai help to get the list of available commands.}

[pkg-pr-new]

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@9982

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@9982

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@9982

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9982

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/mosaic

npm i https://pkg.pr.new/@clerk/mosaic@9982

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 28ac051

[github-actions]

API Changes Report

Generated by Break Check on 2026-09-29T18:53:58.025Z

Summary

Metric	Count
Packages analyzed	19
Packages with changes	0
🔴 Breaking changes	0
🟡 Non-breaking changes	0
🟢 Additions	0

No API Changes Detected

All packages have stable APIs with no detected changes.

---

Report generated by Break Check

_{Last ran on 28ac051.}