docs: replace removed session.idle.backgroundTasks field with the current aborted field - #2232
Open
examon wants to merge 1 commit into
Open
docs: replace removed session.idle.backgroundTasks field with the current aborted field#2232examon wants to merge 1 commit into
session.idle.backgroundTasks field with the current aborted field#2232examon wants to merge 1 commit into
Conversation
…urrent `aborted` field The `session.idle` reference tables listed a `backgroundTasks` field of type `BackgroundTasks`. That field was removed from the payload and the docs were never updated; the type name no longer exists in the schema either. The payload's only member today is an optional `aborted` boolean, which was undocumented. Corrects the data-field row and the at-a-glance row in docs/features/streaming-events.md, plus the two Node.js quick-reference tables. Documentation only; no code, schema or generated file is affected. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates session.idle documentation to match the current generated SDK payload.
Changes:
- Replaces removed
backgroundTasksreferences with optionalaborted. - Updates detailed and quick-reference event tables.
Show a summary per file
| File | Description |
|---|---|
docs/features/streaming-events.md |
Corrects the field reference and summary. |
nodejs/docs/examples.md |
Updates the event quick reference. |
nodejs/docs/agent-author.md |
Updates the agent author reference. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Balanced
Contributor
Cross-SDK Consistency Review ✅This PR is documentation-only — it corrects stale Summary:
No action needed in other SDK implementations. The change correctly aligns docs with the current schema state.
|
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.
Fixes #2231
What
The
session.idledocumentation still lists abackgroundTasksfield of typeBackgroundTasks. That field was removed from the payload a while ago and the docs were never updated; the type name no longer exists in the schema either. Meanwhile the optional field the event may carry,aborted, was undocumented.This replaces the stale rows with the real field in all four places that named it.
Why it is wrong today
session-events.schema.jsondefines the payload as (field descriptions elided):{ "type": "object", "properties": { "aborted": { "type": "boolean" } }, "additionalProperties": false, "title": "IdleData" }additionalPropertiesisfalse, andbackgroundTasksappears nowhere insession-events.schema.jsonorapi.schema.json. All six generated bindings expose only an optional/nullable boolean namedaborted.Verified on the wire against CLI
1.0.78-2by capturing raw JSON-RPC frames:session.idleis now emitted only after tracked active background work has quiesced, so abackgroundTaskssnapshot on that payload would always be empty. Changes to background-task state are signalled separately, by the empty-payloadsession.background_tasks_changedevent.Before / after
docs/features/streaming-events.md(thesession.idledata-field table):and the "at a glance" summary table:
The same stale cell is corrected in the two Node.js quick-reference tables (
nodejs/docs/examples.md,nodejs/docs/agent-author.md).The description is worded to match this guide's existing vocabulary for the same concept (see the
abortevent's "Why the turn was aborted" row). The Required column is left empty becauseabortedis optional (matching the convention used by other optional rows in the same file, e.g.interactionIdandreasoningOpaque), and the at-a-glance table uses the?suffix for the same reason.Verification
rg -n 'backgroundTasks|BackgroundTasks' docs/ nodejs/docs/returns no hits after the change. The only remaining matches in the repo are the generatedBackgroundTasksChanged*types belonging to the separatesession.background_tasks_changedevent.Scope
Deliberately limited to the incorrect
session.idlerows. No new event sections are added, and no other event's field table is changed.