Add API-reference HTTP endpoint catalog from Rust SDK mapping#350
Open
xiaobo-gaga wants to merge 7 commits intomainfrom
Open
Add API-reference HTTP endpoint catalog from Rust SDK mapping#350xiaobo-gaga wants to merge 7 commits intomainfrom
xiaobo-gaga wants to merge 7 commits intomainfrom
Conversation
Collaborator
Author
|
@huacnlee 已按你的要求把 改为“每个 API 一个文件”的结构(参考 Mintlify 风格)。\n\n本次更新(en):\n- 新增目录:\n- 22 个 endpoint 页面(每页包含 Method / URL / Base URL / SDK source)\n- 改为索引页(链接到每个 endpoint 子页)\n\ncommit: 7b3afcf\n\n如果你确认这个结构 OK,我下一步按同样方式同步 zh-CN / zh-HK。 |
Collaborator
Author
|
补充更正:上一条评论里因 shell 转义导致文件名显示异常。实际变更已正确提交到 commit |
Member
|
@xiaobo-gaga 继续,还不够细化,不够清晰 |
Collaborator
Author
|
@huacnlee 收到,我继续细化(按你要的 Mintlify 风格):\n\n下一批会把每个 endpoint 补完整:\n1) Parameters 全部用 Table(Query/Header/Body/Path 分开)\n2) Response fields 用 Table(字段类型/说明)\n3) cURL 请求示例改为可直接跑\n4) Response 示例改为实际调用结果(能实测的用真实数据,受权限限制的补真实错误响应)\n\n我会先从 watchlist + quote + asset/account 三组开始,分批提交,便于 review。 |
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
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.
This PR adds missing direct HTTP API information under
api-reference, based on the real SDK implementation inlongportapp/openapiRust source.What’s added
docs/en/docs/api-reference/http-endpoints.mddocs/zh-CN/docs/api-reference/http-endpoints.mddocs/zh-HK/docs/api-reference/http-endpoints.mdhow-to-access-apipage to this HTTP endpoint catalog.Data source (verified)
Mapped from:
https://github.com/longportapp/openapi/blob/main/rust/src/quote/context.rshttps://github.com/longportapp/openapi/blob/main/rust/src/trade/context.rshttps://github.com/longportapp/openapi/blob/main/rust/src/config.rsIncludes endpoint + HTTP method pairs currently used by SDK HTTP client.
Scope
This is the first completion step for “SDK docs lacking direct API URL”.
Next PRs can continue filling HTTP method/path directly into each individual API page where currently only SDK examples are shown.