docs(zh): rewrite the server API reference - #3483

Open

liruifengv wants to merge 47 commits into

mainfrom

docs/server-api-reference

Commits on Sep 2, 2026

docs(zh): rewrite the server API reference as typed endpoint and frame entries
liruifengv
committed
44073b2
docs(zh): drop the API walkthrough section entirely
liruifengv
committed
6eae8a5
docs(zh): drop the WebSocket lifecycle section from the server API reference
liruifengv
committed
5a6be67
docs(zh): trim the server API reference opening to one sentence
liruifengv
committed
71d7e40
docs(zh): drop the experimental notice from the server API reference
liruifengv
committed
ebfaf18
docs(zh): drop the address section from the server API reference
liruifengv
committed
8f8b655
docs(zh): restructure the auth section as how-to, failure shape, and exempt endpoints
liruifengv
committed
d7ad1ef
docs(zh): drop the default-auth and token-rotation sentences from the auth section
liruifengv
committed
f891b5e
docs(zh): replace the envelope concept with a defined ResponseType
liruifengv
committed
8f674a0
docs(zh): move non-zero-code data shapes into the endpoint entries
liruifengv
committed
9f76602
docs(zh): add a complete error code section with a TODO placeholder
liruifengv
committed
219e9c8
docs(zh): link the error code ranges section to the complete error code chapter
liruifengv
committed
e3c958e
docs(zh): regroup the REST endpoints from 27 registry domains into 6 business domains
liruifengv
committed
73cfae2
docs(zh): split the service-and-account domain into service and account
liruifengv
committed
d1438c2
docs(zh): move GET /auth from the service domain to the account domain
liruifengv
committed
7e03207
docs(zh): drop duplicated domain intros and the single-block divider
liruifengv
committed
729cfcd
docs(zh): drop the divider that duplicated the service domain name
liruifengv
committed
1fb22a0
docs(zh): classify the type dictionary by REST and WS with TypeScript definition blocks
liruifengv
committed
b7c874e
docs(zh): split the tasks-and-terminal domain into tasks and terminal
liruifengv
committed
f6e2cff
docs(zh): rewrite the service module as the endpoint format reference
liruifengv
committed
446586d
docs(zh): split config and models/providers out of the service domain
liruifengv
committed
3286eea
docs(zh): demote endpoint headings to h4 so the outline only shows domains
liruifengv
committed
78d8224
docs(zh): restore the REST API umbrella heading with domains at h3
liruifengv
committed
7ba51a1
docs(zh): state the full ResponseType generic in every response body line
liruifengv
committed
a1d9679
docs(zh): unwrap type links from inline code so anchors work
liruifengv
committed
7a1abe8
docs(zh): add T-MetaResponse to the type dictionary and reference it from GET /meta
liruifengv
committed
50a9bef
docs(zh): add trigger-event lines to the finalized reference domains
liruifengv
committed
5f71cd0
docs(zh): link every named type in the finalized reference domains
liruifengv
committed
a9e8bbf
docs(zh): normalize the account domain to the endpoint format
liruifengv
committed
0ce6748
docs(zh): normalize the workspace-and-session domain to the endpoint format
liruifengv
committed
6bcbdc6
docs(zh): normalize the conversation domain to the endpoint format
liruifengv
committed
f32c389
docs(zh): normalize the task domain to the endpoint format
liruifengv
committed
8f57712
docs(zh): normalize the terminal domain to the endpoint format
liruifengv
committed
950c842
docs(zh): normalize the extension domain to the endpoint format
liruifengv
committed
2e4c7f0
docs(zh): normalize the files-and-misc domain to the endpoint format
liruifengv
committed
176614d
docs(zh): promote transcript family members to headings and state the providers action response envelope
liruifengv
committed
c8db359
docs(zh): escape pipes inside table cells
liruifengv
committed
34e150e
docs(zh): add a format sample for the WebSocket frame chapter
liruifengv
committed
8920f8b
docs(zh): use the server's own union names in the WS frame overview
liruifengv
committed
1b180e2
docs(zh): use only real system type names in the WS frame overview
liruifengv
committed
3ff1d7f
docs(zh): move the frame unions from the overview into their own sections
liruifengv
committed
4bbdd85
docs(zh): complete the control frame entries in the server API reference
liruifengv
committed
8047b75
docs(zh): write out all 19 event.* frame entries
liruifengv
committed
7d8dd0e
docs(zh): write out all 51 agent event frame entries
liruifengv
committed
396cbc9
docs(zh): write transcript and terminal frame sections, drop the superseded old-format content
liruifengv
committed
b2a9946
docs(zh): link REST trigger-event names to their WS frame entries
liruifengv
committed
27b8518
docs(zh): drop the stale new-implementation label on transcript frames
liruifengv
committed
7056aeb