Use RESTATE_AUTH_TOKEN in CDK example for consistency with CLI#189
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
gvdongen
approved these changes
Apr 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Just making things a bit more consistent across the board, received customer feedback that the different names are confusing.
Summary
RESTATE_API_KEYtoRESTATE_AUTH_TOKENin the CDK example ondocs/cloud/connecting-services(both the embedded code block and the standalone reference under it).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
CODE_LOAD'd fromrestatedev/examplesonmain. 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, runningnode scripts/loadScripts.jsis a no-op against this MDX. Until then, this PR temporarily desyncs the embedded block from upstreammain, which is intentional.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 devrenders the page without errors and the CDK block showsRESTATE_AUTH_TOKENthroughoutnode scripts/loadScripts.jslocally and confirm there is no diff against this branch