Skip to content

docs: fix invalid schedule update example#1120

Open
chaptersix wants to merge 2 commits into
temporalio:mainfrom
chaptersix:fix/schedule-update-example
Open

docs: fix invalid schedule update example#1120
chaptersix wants to merge 2 commits into
temporalio:mainfrom
chaptersix:fix/schedule-update-example

Conversation

@chaptersix

@chaptersix chaptersix commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

What

The temporal schedule update example used --workflow-type, which is not a valid flag. The correct flag is --type (alias --name), from the shared-workflow-start option set.

Additionally, since schedule update performs a full replacement of the configuration, both --type and --task-queue are required. The old example was therefore also incomplete.

Before

temporal schedule update \
    --schedule-id "YourScheduleId" \
    --workflow-type "NewWorkflowType"

After

temporal schedule update \
    --schedule-id "YourScheduleId" \
    --workflow-id YourBaseWorkflowIdName \
    --task-queue YourTaskQueue \
    --type YourWorkflowType

This mirrors the valid schedule create example.

How

  • Edited the example in internal/temporalcli/commands.yaml
  • Regenerated internal/temporalcli/commands.gen.go via make gen

Audit

I also validated every other command's example flags against each command's real flag set (extracted from --help). The schedule update example was the only invalid one; all other examples reference flags that exist. Relevant tests pass.

The schedule update example used --workflow-type, which is not a valid
flag. The correct flag is --type. Since update performs a full
replacement, --type and --task-queue are also required, so the example
was incomplete. Update it to mirror the valid schedule create example.
@chaptersix chaptersix marked this pull request as ready for review July 10, 2026 20:34
@chaptersix chaptersix requested a review from a team as a code owner July 10, 2026 20:34
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