docs(connector): add self-hosted connector integration guide#293
Conversation
Document how to point the `oo` CLI at a self-hosted connector server in both English and Simplified Chinese, distilled from the self-hosted connector feature (#291) and its follow-up cleanup (#292). The command reference in `docs/commands.md` only records the per-command CLI contract, so there was no single place that explained the end-to-end onboarding flow or the HTTP contract a connector server must expose. The new guides cover both audiences: operators wiring the CLI to a server (`oo connector login`/`logout`, runtime tokens and the `/access` page, the `OO_CONNECTOR_URL` > `OO_API_KEY` > `connector.toml` > account routing precedence, and the OOMOL vs self-hosted feature differences), and server implementers (the `/v1/*` endpoints, health envelope, Bearer auth model, and response shapes). Link both guides from `README.md` and `README-ZH_CN.md` for discovery. Signed-off-by: Kevin Cui <bh@bugs.cc>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
Summary by CodeRabbit
WalkthroughThis PR adds two new documentation pages, Sequence Diagram(s)Not applicable — this change consists solely of documentation additions and README link updates with no code or control-flow changes. Estimated code review effort: Low-Medium Related PRs: None identified. Suggested labels: documentation Suggested reviewers: None identified. 🐰 A rabbit hops through docs anew, 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✨ Finishing Touches✨ Simplify code
Comment |
Summary
Adds a dedicated integration guide, in both English and Simplified Chinese, for
pointing the
ooCLI at a self-hosted connector server. The content is distilledfrom the self-hosted connector feature (#291) and its follow-up cleanup (#292).
The command reference in
docs/commands.mdonly records the per-command CLIcontract, so there was no single place explaining the end-to-end onboarding flow
or the HTTP contract a connector server must expose. The new guides cover both
audiences:
oo connector login/logout, runtime tokens and the/accesspage, theOO_CONNECTOR_URL>OO_API_KEY>connector.toml>account routing precedence, headless/CI env overrides, and the OOMOL vs
self-hosted feature differences (org identity rejected, async
--waitunsupported, proxy dependent on server support).
/v1/*endpoints (method, path, purpose), thehealth envelope, the Bearer auth model, and the response shapes.
Changes
docs/self-hosted-connector.md— English integration guide.docs/self-hosted-connector.zh-CN.md— Simplified Chinese integration guide.README.md/README-ZH_CN.md— link both guides from the Links section.Notes
validation exit codes,
oo auth statusoutput shape,connector.tomlformatand paths) was cross-checked against the current implementation.