Skip to content

docs(schema): state null handling for every optional v2 field - #2570

Merged
benbrandt merged 1 commit into
mainfrom
docs/null-equals-omitted
Oct 27, 2026
Merged

benbrandt merged 1 commit into
mainfrom
docs/null-equals-omitted

Conversation

@benbrandt

Copy link
Copy Markdown
Member

Every optional, non-patch v2 field now says how null is handled, using one standard wording: "Omitted and null are equivalent and mean …".

  • Adds the statement to the 36 fields that had none. Examples: ListSessionsRequest.cwd/cursor, SessionInfo.title/updatedAt, config option description/category, Command.input, Usage token counts, content annotations/mimeType, ResourceLink and Icon fields, Annotations, and Error.data.
  • Rewrites the existing variants ("Omitted or null both mean", "Omitted or null means") into the same wording.
  • Overview (stable and draft) gets a general rule: omitted and null are equivalent for optional fields unless the field says otherwise, and upsert updates are the exception, where null clears.

Skipped on purpose: nextCursor (covered in #2567), the flattened idle stopReason (its struct doc already covers it), and JSON-RPC params. No CI lint. v2 only.

@benbrandt
benbrandt requested a review from a team as a code owner October 27, 2026 21:41
@benbrandt
benbrandt enabled auto-merge (squash) October 27, 2026 21:42
@benbrandt
benbrandt merged commit 609d3fa into main Oct 27, 2026
14 checks passed
@benbrandt
benbrandt deleted the docs/null-equals-omitted branch October 27, 2026 21:44
@acp-release-bot acp-release-bot Bot mentioned this pull request Oct 27, 2026
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