docs(api): document Watch Management endpoints from #2110#2123
Merged
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
5 tasks
qin-ctx
approved these changes
May 20, 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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Documents the Watch Management surface introduced in #2110 (REST
/api/v1/watches/*, theov task watchCLI subcommand group, and the MCPlist_watches/cancel_watchtools). All three control planes are net-new and currently undocumented indocs/{en,zh}/api/02-resources.md, where users land for everythingwatch_interval-related.The new section follows the API documentation writing guide: Implementation Overview / Code Entry Points / Interface and Parameter Description / Usage Examples (HTTP + CLI + MCP). EN and ZH are mirrored.
Related Issue
Documents the changes from #2110 (RFC #2104 — Watch Management API).
Type of Change
Changes Made
docs/en/api/02-resources.md: insert a### Watch Managementsection between### add_resourceand### add_skill(~93 lines added)docs/zh/api/02-resources.md: mirrored Chinese section (~93 lines added)Specifically captured:
{task_id}and?to_uri=variantsPATCH /watchesbody schema with field semantics (notablywatch_intervalmust be> 0;is_activeorthogonal to the cadence for pause/resume;extra="forbid"→ 422)ov task watchsubcommands (ls / show / rm / pause / resume / update / trigger) with the<key>auto-classification (viking://URI vs task_id)list_watches,cancel_watch) and an explicit note that pause / resume / trigger / update are intentionally CLI/REST-onlyadd_resourceas the watch-creation entry pointTesting
openviking/server/routers/watches.pyandcrates/ov_cli/src/commands/watch.rsat HEADChecklist