Repository navigation
docs(protocol): show the required plan object in the v2 migration checklist - #2763
Merged
benbrandt merged 2 commits intoNov 6, 2026
Conversation
…cklist Wrap the checklist's plan_update literal in the required plan object.
Preview approval requiredThis pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit |
Member
|
thanks! |
benbrandt
enabled auto-merge (squash)
November 6, 2026 09:49
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.
The v2 migration checklist tells readers to send
plan_updatewith{ "type": "items", "planId": ..., "entries": [...] }, but$defs/PlanUpdaterequires a
planobject (required: ["plan"]). The same guide's Plans sectionand
docs/protocol/v2/agent-plan.mdxalready show theplanwrapper, so thechecklist literal is the odd one out.
Before: the literal fails schema validation with
'plan' is a required property.After:
{ "plan": { ... } }validates against$defs/PlanUpdate.Docs-only change;
prettier --checkpasses. No schema or Rust changes.