Simplify and reorder the Stable IPs API examples - #5063
Open
lukeknep wants to merge 3 commits into
Open
Conversation
Rewrite "Changes to Stable IP ranges" to state the actual commitments: once a region's ranges are published Temporal avoids adding to them and has no plans to remove one, and any unforeseen add or remove comes with six months of advance notice. Remove the "Don't depend on DNS resolution behavior" callout from the Stable IPs section. It named High Availability as the *only* case with guaranteed DNS resolution, which is wrong now that Stable IPs is a second case. The accurate version, listing both, already exists in "When Namespace Endpoint DNS resolution is predictable" on the same page and in the Namespaces page callout. Replace "routes to" with "redirects via DNS to" where the docs describe the Namespace Endpoint reaching an active region. The endpoint does not proxy traffic; it is a DNS redirect. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Drop the temporal-cloud-api-version header from the curl and gRPC examples. Callers no longer need to pin the Cloud Ops API version, and carrying it through every command added noise. This removes the H_VER variable, the version entry in GRPC_HEADERS, the "two headers" preamble, and the two minimum-version bullets. Reorder both procedures to follow the order a caller actually works in. Creating the Connectivity Rule is now Step 1, including capturing the rule ID and waiting for the async operation to reach a terminal state. Attaching the rule to the Namespace is Step 2, folding in the GetNamespace read that the full-replace UpdateNamespace call depends on. Add a non-polling way to confirm each step. Step 1 can list the account's Connectivity Rules and read the new rule's state, which also reveals whether a public rule already exists. Step 2 can describe the Namespace and confirm connectivityRuleIds contains the new rule ID. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links
|
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Stacked on top of PR #5056. Merge #5056 first, and GitHub will retarget this to
main.All changes are in
docs/cloud/connectivity/ip-addresses.mdx, and each applies to both the curl and the gRPC procedure.1. Removed the
temporal-cloud-api-versionheaderPrevious instructions used a specific version of the Cloud Ops API -- which was an over-optimization added by AI.
Simplifies example steps by removing the Version (often called $H_VER in the steps)
We do still have a place that notes it requires "Cloud Ops API
v0.15.0or later," for clarity for customers who roll-their-own Ops API.2. Reordered the steps to be more intuitive.
Same steps, different order that matches user behavior better.
CR_IDand waiting for the async operationGetNamespacereadInternal cross-references were updated to match the new numbering.
3. Added a simpler, intuitive example command for confirming each step
Some users (like me) don't want to use the "async operation ID". They can just use the new sample commands in Step 1 and Step 2 to query ("look up") the state of the resource-they-just-created.
AI Verification
Claude checked field names and enum values were checked against the protos in
temporalio/cloud-api.🤖 Generated with Claude Code
┆Attachments: EDU-6912 Simplify and reorder the Stable IPs API examples