Skip to content

Use RESTATE_AUTH_TOKEN in CDK example for consistency with CLI#189

Merged
pcholakov merged 1 commit into
mainfrom
pavel/connecting-services-auth-token
Apr 28, 2026
Merged

Use RESTATE_AUTH_TOKEN in CDK example for consistency with CLI#189
pcholakov merged 1 commit into
mainfrom
pavel/connecting-services-auth-token

Conversation

@pcholakov
Copy link
Copy Markdown
Contributor

@pcholakov pcholakov commented Apr 27, 2026

Just making things a bit more consistent across the board, received customer feedback that the different names are confusing.

Summary

  • Renames RESTATE_API_KEY to RESTATE_AUTH_TOKEN in the CDK example on docs/cloud/connecting-services (both the embedded code block and the standalone reference under it).
  • Aligns this page with the Cloud getting-started page, the Restate CLI (which reads RESTATE_AUTH_TOKEN), and the Cloud UI's example snippets. A customer reported that the three different env var names across docs and tools tripped them up while configuring everything end-to-end.

Notes

  • The embedded CDK block is CODE_LOAD'd from restatedev/examples on main. The companion PR Rename RESTATE_API_KEY env var to RESTATE_AUTH_TOKEN examples#389 renames the same vars in the source files. Once that merges, running node scripts/loadScripts.js is a no-op against this MDX. Until then, this PR temporarily desyncs the embedded block from upstream main, which is intentional.
  • The tunnel client section further down the page still references RESTATE_BEARER_TOKEN — that's accurate to the tunnel binary's actual env var and out of scope for this PR.

Test plan

  • npm run dev renders the page without errors and the CDK block shows RESTATE_AUTH_TOKEN throughout
  • After the companion examples PR merges, run node scripts/loadScripts.js locally and confirm there is no diff against this branch

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 27, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
restatedev 🟢 Ready View Preview Apr 27, 2026, 8:47 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@pcholakov pcholakov merged commit 3db16e8 into main Apr 28, 2026
9 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 28, 2026
@gvdongen gvdongen deleted the pavel/connecting-services-auth-token branch May 15, 2026 10:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants