[Docs] Update API domains #7903
Conversation
|
WalkthroughReplaced thirdweb-dev.com with thirdweb.com in documentation links and API client type. Removed the specUrl prop from an OpenApiEndpoint usage in the AI Chat page. Updated ClientOptions.baseUrl literal type to the production API host. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
Portal
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
joaquim-verges
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7903 +/- ##
=======================================
Coverage 56.53% 56.53%
=======================================
Files 904 904
Lines 58592 58592
Branches 4143 4143
=======================================
Hits 33126 33126
Misses 25360 25360
Partials 106 106
🚀 New features to boost your workflow:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
4 Skipped Deployments
|
size-limit report 📦
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
apps/portal/src/app/ai/sidebar.tsx (1)
25-27: Nit: show external-link affordance for the API Reference item.For consistency with the "Playground" external link, consider adding the ExternalLinkIcon.
{ name: "API Reference", - href: "https://api.thirdweb.com/reference#tag/ai/post/ai/chat", + href: "https://api.thirdweb.com/reference#tag/ai/post/ai/chat", + icon: <ExternalLinkIcon />, },apps/portal/src/app/ai/chat/page.mdx (1)
54-55: API Reference link domain update looks good; consider centralizing the docs base URL.To avoid future drift, derive this URL from a single config/constant used across MDX and the sidebar.
packages/api/src/client/types.gen.ts (1)
3099-3100: Ensure the generator source is updated so this change persists.Since this file is auto-generated, please update the OpenAPI/hey-api generation config (or the spec server URL) to keep
https://api.thirdweb.comon future regenerations.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
apps/portal/src/app/ai/chat/page.mdx(2 hunks)apps/portal/src/app/ai/sidebar.tsx(1 hunks)packages/api/src/client/types.gen.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx}: Write idiomatic TypeScript with explicit function declarations and return types
Limit each file to one stateless, single-responsibility function for clarity
Re-use shared types from@/typesor localtypes.tsbarrels
Prefer type aliases over interface except for nominal shapes
Avoidanyandunknownunless unavoidable; narrow generics when possible
Choose composition over inheritance; leverage utility types (Partial,Pick, etc.)
Comment only ambiguous logic; avoid restating TypeScript in prose
Files:
apps/portal/src/app/ai/sidebar.tsxpackages/api/src/client/types.gen.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (CLAUDE.md)
Load heavy dependencies inside async paths to keep initial bundle lean (lazy loading)
Files:
apps/portal/src/app/ai/sidebar.tsxpackages/api/src/client/types.gen.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Size
- GitHub Check: Analyze (javascript)
🔇 Additional comments (4)
apps/portal/src/app/ai/sidebar.tsx (2)
25-27: API Reference domain update looks correct.Matches the PR objective and maintains the same path/fragment.
25-27: Portal AI docs cleared of deprecated API domain referencesVerified that in apps/portal/src/app/ai there are no remaining occurrences of
api.thirdweb-dev.comand no deprecatedspecUrlusages. No further updates to the portal AI documentation are required.apps/portal/src/app/ai/chat/page.mdx (1)
25-25: specUrl is Optional and Defaults to a Valid SpecThe
OpenApiEndpointPropsinterface in
apps/portal/src/components/Document/APIEndpointMeta/OpenApiEndpoint.tsxdeclaresspecUrl?: stringand theOpenApiEndpointInnerfunction signature provides a default value of"https://api.thirdweb.com/openapi.json". Omitting thespecUrlprop (as in<OpenApiEndpoint path="/ai/chat" method="POST" />) will correctly resolve to the default OpenAPI spec and render the endpoint without errors.Key locations:
apps/portal/src/components/Document/APIEndpointMeta/OpenApiEndpoint.tsx:13–specUrl?: stringapps/portal/src/components/Document/APIEndpointMeta/OpenApiEndpoint.tsx:475–480–specUrl = "https://api.thirdweb.com/openapi.json"No further changes required.
packages/api/src/client/types.gen.ts (1)
3099-3100: LGTM: baseUrl literal updated to production host.Keeps editor autocomplete for the prod host while still permitting arbitrary strings via
(string & {}).
| baseUrl: "https://api.thirdweb.com" | "http://localhost:3030" | (string & {}); | ||
| }; |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Repo-wide check for lingering -dev domains and baseUrl defaults.
Run a quick audit to catch any stragglers or hardcoded defaults in client code/tests.
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Search for old domain anywhere in the repo..."
rg -nP -C2 --glob '!**/dist/**' --glob '!**/.git/**' 'https?://api\.thirdweb-dev\.com'
echo
echo "Search for baseUrl defaults/usages that might still point to the old domain..."
rg -nP -C3 --type=ts --type=tsx '\bbaseUrl\b'Length of output: 209
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "🔍 Searching for legacy ‘api.thirdweb-dev.com’ across the repo..."
rg -nP --glob '!**/dist/**' --glob '!**/.git/**' 'https?://api\.thirdweb-dev\.com' || echo "✅ No legacy ‘-dev’ domains found"
echo
echo "🔍 Scanning for baseUrl defaults pointing at any thirdweb domain…"
rg -nP -C2 --type=ts --type=tsx 'baseUrl\s*:\s*".*thirdweb.*"' || echo "✅ No hardcoded baseUrl defaults found"Length of output: 647
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "🔍 Searching for legacy ‘api.thirdweb-dev.com’ across the repo..."
rg -nP --glob '!**/dist/**' --glob '!**/.git/**' 'https?://api\.thirdweb-dev\.com' || echo "✅ No legacy ‘-dev’ domains found"
echo
echo "🔍 Scanning for baseUrl defaults pointing at any thirdweb domain…"
rg -nP -C2 'baseUrl\s*:\s*".*thirdweb.*"' \
--glob '!**/dist/**' \
--glob '!**/.git/**' \
--glob '*.ts' --glob '*.tsx' --glob '*.js' --glob '*.jsx' \
|| echo "✅ No hardcoded baseUrl defaults found"Length of output: 2756
Update lingering -dev domains in the nebula client
We still have two hardcoded references to thirdweb-dev.com in the nebula package; these must be updated to the production domain.
• packages/nebula/src/client/client.gen.ts (around line 26)
Replace
baseUrl: "https://nebula-api.thirdweb-dev.com",with
baseUrl: "https://nebula-api.thirdweb.com",• packages/nebula/src/client/types.gen.ts (around line 4460)
Replace
export type ClientOptions = {
baseUrl: "https://nebula-api.thirdweb-dev.com" | (string & {});
};with
export type ClientOptions = {
baseUrl: "https://nebula-api.thirdweb.com" | (string & {});
};🤖 Prompt for AI Agents
In packages/nebula/src/client/client.gen.ts around line 26 and
packages/nebula/src/client/types.gen.ts around line 4460, replace the hardcoded
dev domain "thirdweb-dev.com" with the production domain "thirdweb.com": update
the baseUrl value in client.gen.ts to use https://nebula-api.thirdweb.com and
update the ClientOptions type in types.gen.ts so its baseUrl union contains
https://nebula-api.thirdweb.com instead of the -dev domain; ensure formatting
and string literal types remain consistent with surrounding code.
PR-Codex overview
This PR focuses on updating the API reference URLs from
https://api.thirdweb-dev.comtohttps://api.thirdweb.comacross multiple files for consistency and accuracy.Detailed summary
hrefin thesidebar.tsxfile.baseUrlin thetypes.gen.tsfile.specUrlfrom theOpenApiEndpointinpage.mdx.page.mdx.Summary by CodeRabbit
Documentation
Chores