[docs] Update API reference for v0.1.33 upstream sync (PR #58)#59
Closed
github-actions[bot] wants to merge 1 commit intomainfrom
Closed
[docs] Update API reference for v0.1.33 upstream sync (PR #58)#59github-actions[bot] wants to merge 1 commit intomainfrom
github-actions[bot] wants to merge 1 commit intomainfrom
Conversation
Document features merged in PR #58 (upstream v0.1.33 sync): - Mark :auto-restart? as deprecated in create-client options - Add :telemetry and :on-get-trace-context client options (OTel support) - Note :on-permission-request is optional in create-session and join-session - Update join-session docs with example showing optional permission handler - Add :reasoning-effort opts to switch-model! and set-model! - Document :skip-permission? on tool definitions - Update event reference with data fields for session.start, session.resume, session.model_change events - Add :blob attachment type to send! attachments table Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
bot
added
automation
documentation
Contributor
Author
|
This pull request was automatically closed because it expired on 2026-03-17T22:53:32.654Z.
|
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.
Documentation Updates — 2026-03-16
This PR updates
doc/reference/API.mdbased on features merged in PR #58 (upstream v0.1.33 sync) earlier today.Features Documented
:auto-restart?deprecation (from Port upstream v0.1.33: OTel, skipPermission, setModel opts, event specs #58, upstream PR #803) — marked as deprecated in thecreate-clientoptions table with a clear explanation:telemetryand:on-get-trace-contextclient options with descriptions of all sub-keys:on-permission-request(from Port upstream v0.1.33: OTel, skipPermission, setModel opts, event specs #58, upstream PR #802) — updatedcreate-sessionconfig table andjoin-sessionsection; added example showing extension without a permission handler:reasoning-effortinswitch-model!/set-model!(from Port upstream v0.1.33: OTel, skipPermission, setModel opts, event specs #58, upstream PR #712) — added optional opts argument with code examples:skip-permission?on tool definitions (from Port upstream v0.1.33: OTel, skipPermission, setModel opts, event specs #58, upstream PR #808) — added new "Skipping permission prompts" subsection with examplesession.start,session.resume, andsession.model_change:blobattachment type (from Port upstream v0.1.33: OTel, skipPermission, setModel opts, event specs #58, upstream PR #796) — added blob row to the attachment types tableChanges Made
doc/reference/API.mdonly (CHANGELOG was already updated in PR Port upstream v0.1.33: OTel, skipPermission, setModel opts, event specs #58 itself)Validation
Merged PRs Referenced
Notes
All new documentation follows the style guide: code-first, direct tone, Clojure-idiomatic terminology, valid parseable code blocks.