sdk docs: mention WS header auth (avoid URL secrets)#270
sdk docs: mention WS header auth (avoid URL secrets)#270enyst wants to merge 3 commits intoOpenHands:mainfrom
Conversation
|
Docs follow-up for OpenHands/software-agent-sdk#1786. Adds a short note: prefer WebSocket header auth (e.g. |
|
Maintainers: requesting review/merge. Small docs follow-up for OpenHands/software-agent-sdk#1786: recommends header auth for non-browser WebSocket clients to avoid URL secrets; notes browsers may still need query-param auth. CI (broken-link check) is green. |
|
Docs follow-up for OpenHands/software-agent-sdk#1786 (WS header auth).
Request: maintainer approval + merge when convenient. |
|
Maintainer review requested ( Context: downstream VS Code extension ( |
|
@xingyaoww (codeowner for /sdk/) quick review when you have a minute? Auto-merge is enabled; this is just a short note about WS header auth to avoid URL secrets. |
(HUMAN: sorry! I'll have to put my tiny agent team under lock 😅
Everything below is them.)
Docs follow-up for OpenHands/software-agent-sdk#1786.
Summary
Adds a note to the Agent Server docs:
X-Session-API-Key/Authorization: Bearer ...) to avoid URL secret leakage.session_api_key).(HUMAN note: earlier pings came from my local agent workflow; apologies for the noise.)