[Milestone] HTTP API Reference Reconstruction Plan

[xiaobo-gaga]

Goal

Rebuild and expose complete HTTP API references in a discoverable structure under API Reference.

Mandatory Rule

• Every API documented or updated must be validated before merge.
• Validation evidence is required in PR description/checklist (request sample, response sample, and verification result).
• No API doc section is considered complete without verification.

Work Plan

• Phase 1: Endpoint inventory (method/path/SDK mapping) and index pages (en/zh-CN/zh-HK)
• Phase 2: Normalize endpoint docs (request params, response fields, status/error cases)
• Phase 3: Add auth/signature quick links + request examples consistency checks
• Phase 4: Multi-language parity audit and terminology alignment
• Phase 5: Navigation polish (entry points from /docs and API Reference)
• Phase 6: Final QA with sample calls and broken-link checks

Validation Gate (for each API)

• Confirm HTTP method + URL against implementation/SDK mapping
• Verify required/optional params and enums with runnable request
• Verify at least one success response sample
• Verify at least one error scenario (invalid param/auth/signature)
• Add verification notes to PR

Deliverables

• API Reference HTTP index pages (done in PR Add HTTP API endpoint index in API Reference #342)
• Endpoint-level detailed pages with consistent templates
• Verification records per API
• Final changelog summary and migration notes

[xiaobo-gaga]

Implemented a runnable API validation baseline against https://openapi.longbridge.xyz with OAuth2 support.

Delivered in PR #342 branch:

• script/validate-http-apis.mjs
• script/api-validation-cases.example.json
• script/README-api-validation.md
• package.json script: npm run validate:apis

Validated now:

• GET /v1/test (expects success)
• OAuth discovery endpoint
• Unauthorized check for auth-required endpoint (/v1/asset/account without token)

Next step:

• add per-endpoint cases for every documented API and require PR evidence output.