docs(delegation): document api_mode wire-protocol override from #26824#27109
Closed
r266-tech wants to merge 2 commits into
Closed
docs(delegation): document api_mode wire-protocol override from #26824#27109r266-tech wants to merge 2 commits into
r266-tech wants to merge 2 commits into
Conversation
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
Contributor
|
Merged via PR #27247 — your commit was cherry-picked onto current |
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.
Summary
#26824 (salvage of #10273, merged 2026-05-16) added a new
delegation.api_modeconfig key so subagent delegation can honor an explicit wire-protocol override when_detect_api_mode_for_url()can't classify a custombase_url(Azure AI Foundry, MiniMax, Zhipu GLM, LiteLLM proxies, …).hermes_cli/config.pydocuments the key inline, but the user-facing website docs still only mentionmodel,provider,base_url, andapi_keyfor the direct-endpoint path, so users hitting the 404 #26824 fixes have no docs to point at.This patch surfaces
api_modein the two user-guide pages that already enumerate the delegation YAML keys.Changes
website/docs/user-guide/configuration.md(Delegation section): add the# api_mode: ""line to the commented YAML example next toapi_key, and a new Wire protocol (api_mode) paragraph after Direct endpoint override that paraphrases the auto-detect rules and lists the three valid values.website/docs/user-guide/features/delegation.md(Configuration subsection): add a commentedapi_modeline to the "Or use a direct custom endpoint" YAML block so the example matches the one inconfiguration.md.Value set (
chat_completions,codex_responses,anthropic_messages) and auto-detect behavior are taken verbatim from thehermes_cli/config.pydocstring written by #26824. No claim is made about auto-detect handling endpoints beyond the URL/known-host heuristics in_detect_api_mode_for_url().4 LOC additive total; no source-code change.
Test plan
hermes_cli/config.pylines 1149-1152 (added by fix(delegation): honor api_mode + auto-detect anthropic_messages URLs #26824)./anthropicsuffix →anthropic_messages, plus retainedchatgpt.com/backend-api/codex,api.anthropic.com,api.kimi.com/codinghostname overrides.website/docs/user-guide/configuration.mdDelegation section orfeatures/delegation.mdforapi_mode(docs: document explicit api_mode for custom endpoints #7176 coversmodel.api_modeinintegrations/providers.md, different config namespace).