docs: add grid trading documentation (CLI, API, SDK, MCP) - #1204
Open
hogan-yuan wants to merge 11 commits into
Open
docs: add grid trading documentation (CLI, API, SDK, MCP)#1204hogan-yuan wants to merge 11 commits into
hogan-yuan wants to merge 11 commits into
Conversation
Add a Grid Trading section under Trade docs (overview + 11 endpoints: submit, replace, list, list-by-ids, detail, trigger-history, cancel, suspend, restart, questionnaire, symbol-info) in en / zh-CN / zh-HK, each with CLI and Python/Node.js/Java/Rust/C++ SDK examples. Add the /v1/gridtrading/* paths, /v1/record/questionnaire, /v1/orders/info and a GridTradeRule schema to openapi.yaml under a new Grid Trading tag. Extend SDKLinks to support the grid module and a hideGo flag (the Go SDK has no grid bindings yet). Refs: longbridge/openapi#563, longbridge/longbridge-terminal#281
The grid trading pages pushed the vitepress page-render phase past the 12GB heap ceiling (OOM during rendering). Bump --max-old-space-size to 14336 in the build scripts and CI workflows (runner has 16GB).
Add a 2026-08-14 changelog entry (platform + SDK v4.5.0 + CLI v0.27.0) and a CLI v0.27.0 release-notes entry for the new grid command group, across en / zh-CN / zh-HK.
Add short sidebar_label to every grid page (drop the redundant 网格/Grid prefix since they sit under the Grid Trading category), keeping the full page titles. Remove the '/v1/gridtrading/list path reuse' sentence from list_by_ids.
…s format Add a '## Schemas' section (canonical today_orders format: schema anchor + Response Status link + tree-nested field table) to the grid list, list_by_ids, detail, trigger_history, and symbol_info pages across all three locales, and add the Content-Type note under Parameters. Remove the now-duplicate '### Response Fields' blocks so the section order matches today_orders.
The overview's Grid endpoints table duplicated the sidebar/nav; remove it across all three locales.
Add a Grid Order Changes section to trade-push (gridtrading_order event on the private topic, field table, per-language callback) and update the trade FAQ to state grid orders are now supported via the Grid Trading API.
Document the longbridge grid command group (submit/list/detail/triggers/ replace/suspend/restart/cancel/info/questionnaire) in the CLI usage docs, across en / zh-CN / zh-HK.
hogan-yuan
marked this pull request as ready for review
August 13, 2026 08:22
hogan-yuan
changed the title
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
1 participant
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
Complete grid trading documentation for the Longbridge Developers site — the new grid strategy orders documented across CLI, HTTP API, SDKs, and MCP, in English / Simplified Chinese / Traditional Chinese.
What's included
docs/trade/grid/) — an overview page plus 11 endpoint pages: submit, replace, list, list-by-IDs, detail, trigger history, cancel, suspend, restart, questionnaire, and symbol info. Each endpoint page carries a<CliCommand>example, Python / Node.js / Java / Rust / C++ SDK tabs, request/response tables, and a## Schemassection — matching the existingtrade/orderpages.cli/orders/grid.md) — thelongbridge gridcommand group under "Orders & Trading".GridOrderChanged(gridtrading_order) event documented intrade-push.md.qa/trade.mdupdated: grid orders are now supported.openapi.yaml— the/v1/gridtrading/*,/v1/record/questionnaire, and/v1/orders/infopaths plus theGridTradeRuleschema, under a newGrid Tradingtag.SDKLinkscomponent — now supports thegridmodule and ahideGoflag (the Go SDK has no grid bindings yet).All pages are mirrored across
en/zh-CN/zh-HK.Notes
Refs: longbridge/openapi#563, longbridge/longbridge-terminal#281