API reference docs: consolidate Schedules + Workflows sections into unified /api/tasks#439
Merged
Conversation
Replace the stale Schedules section (leftover from removed feature) and the separate Workflows section (listing /api/jobs/* as primary API) with a single "Legacy Aliases" note that points readers to the canonical /api/tasks polymorphic surface. Closes #436 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2 tasks
jplorier
pushed a commit
to jplorier/optio
that referenced
this pull request
May 5, 2026
…onwiggins#439) Replace the stale Schedules section (leftover from removed feature) and the separate Workflows section (listing /api/jobs/* as primary API) with a single "Legacy Aliases" note that points readers to the canonical /api/tasks polymorphic surface. Closes jonwiggins#436 Co-authored-by: Optio Agent <optio-agent@noreply.github.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.
Closes #436
What changed
Removed the stale Schedules section (leftover from the removed schedules feature with non-existent
/api/schedulesendpoints) and the separate Workflows section (which listed/api/jobs/*endpoints as the primary API) from the API reference page.Replaced both with a single Legacy Aliases note that points readers to the canonical
/api/taskspolymorphic surface and lists/api/jobs/*and/api/task-configs/*as backward-compatible aliases.The main Tasks section (already documenting the unified
/api/tasksendpoint) remains the canonical reference.How to test
pnpm format:check— passesnpx turbo typecheck --filter=@optio/site— passes/docs/api-referencein the site — the Schedules and Workflows sections are gone, replaced by a concise Legacy Aliases note between Webhooks and Cluster