Skip to content

docs(ud): API route prefix#1838

Merged
Tobbe merged 2 commits into
mainfrom
tobbe-docs-ud-api-route-prefix
May 28, 2026
Merged

docs(ud): API route prefix#1838
Tobbe merged 2 commits into
mainfrom
tobbe-docs-ud-api-route-prefix

Conversation

@Tobbe
Copy link
Copy Markdown
Member

@Tobbe Tobbe commented May 28, 2026

Document route prefix

@netlify
Copy link
Copy Markdown

netlify Bot commented May 28, 2026

Deploy Preview for cedarjs ready!

Name Link
🔨 Latest commit 4195252
🔍 Latest deploy log https://app.netlify.com/projects/cedarjs/deploys/6a181231ba0a3a0009b4b5e3
😎 Deploy Preview https://deploy-preview-1838--cedarjs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added this to the next-release-patch milestone May 28, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 28, 2026

Greptile Summary

This PR documents the API route prefix configuration for Universal Deploy, adding a new section that explains apiUrl in cedar.toml, the --apiRootPath CLI flag, and the CEDAR_API_ROOT_PATH environment variable and how they interact.

  • The precedence table and prose accurately reflect the implementation in vite-plugin-cedar-universal-deploy.ts and buildUDApiServer.ts.
  • One factual inaccuracy: the generated vercel.json from yarn cedar setup deploy vercel --ud only contains yarn cedar build --ud --verbose — it does not include --apiRootPath=/.api/functions, contrary to the doc's claim that both Netlify and Vercel configure this automatically.

Confidence Score: 4/5

Safe to merge once the Vercel claim is corrected; all other details match the implementation.

The Netlify setup correctly includes --apiRootPath=/.api/functions in its build command, but the Vercel setup only generates yarn cedar build --ud --verbose with no route-prefix flag. Developers targeting Vercel who rely on this doc may ship a broken deployment.

docs/docs/deploy/universal-deploy.md — the paragraph claiming Vercel auto-configures --apiRootPath.

Important Files Changed

Filename Overview
docs/docs/deploy/universal-deploy.md Adds a new "API route prefix" section documenting apiUrl, --apiRootPath, and CEDAR_API_ROOT_PATH; the claim that Vercel auto-configures --apiRootPath is incorrect per the source.

Reviews (2): Last reviewed commit: "tweak apiUrl doc" | Re-trigger Greptile

Comment thread docs/docs/deploy/universal-deploy.md Outdated
@Tobbe Tobbe merged commit b9a926a into main May 28, 2026
34 checks passed
@Tobbe Tobbe deleted the tobbe-docs-ud-api-route-prefix branch May 28, 2026 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant