Fix Standalone Activities/Operations doc bugs: RunID optionality and List Filter status field - #5296
Open
Duncanma wants to merge 1 commit into
Open
Fix Standalone Activities/Operations doc bugs: RunID optionality and List Filter status field#5296Duncanma wants to merge 1 commit into
Duncanma wants to merge 1 commit into
Conversation
…List Filter status field The Go Standalone Activities guide said GetActivityHandle requires both ActivityID and RunID, but RunID is optional in the SDK: an empty RunID targets the latest Activity Execution with that Activity Id. The Go guide's List Filter example also used the visibility attribute `Status`, which isn't registered; the correct attribute is `ExecutionStatus` (per go.temporal.io/sdk and the Temporal Server's search attribute definitions). The same `Status` mistake was copied into the Standalone Activities guides for Python, TypeScript, Java, .NET, and Ruby, the Celery migration guide, and the Standalone Operations (Nexus) guides for Go, Python, TypeScript, and .NET.
|
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.
Summary
Two bugs flagged by Codex in the Go Standalone Activities guide, verified against the Go SDK and Temporal Server source, plus the same status-field bug found in sibling pages while verifying.
GetActivityHandlerequires bothActivityIDandRunID. PerClientGetActivityHandleOptionsinsdk-go, RunID is optional — an empty value targets the latest Activity Execution with that Activity Id. Other language guides (e.g. Java) already document this correctly.Statusfield in a List Filter example. The same page'sListActivitiesexample usedStatus = 'Running', but the registered visibility search attribute isExecutionStatus(seeStatusSearchAttributeinchasm/lib/activity/activity.goandsadefs.ExecutionStatusin the server).Statusisn't a valid field name for this query.While verifying the second bug, the identical
Status→ should-be-ExecutionStatusmistake turned up in every other Standalone Activities guide and the related Standalone Operations (Nexus) guides that share this example, so those are fixed too:docs/develop/python/activities/standalone-activities.mdxdocs/develop/typescript/activities/standalone-activities.mdxdocs/develop/java/activities/standalone-activities.mdxdocs/develop/dotnet/activities/standalone-activities.mdxdocs/develop/ruby/activities/standalone-activities.mdxdocs/guides/celery-to-standalone-activity.mdxdocs/develop/go/nexus/standalone-operations.mdxdocs/develop/python/nexus/standalone-operations.mdxdocs/develop/typescript/nexus/standalone-operations.mdxdocs/develop/dotnet/nexus/standalone-operations.mdx(Java's Nexus guide already used
ExecutionStatuscorrectly.)Test plan
vale --config .vale-ci.inion all touched files: 0 errors/warnings/suggestionsyarn build/yarn check-links(CI)