Commit Graph

312 Commits

Author SHA1 Message Date
xiaobo-gaga 9024e24cd5 Expand endpoint pages with detailed structure (auth/request/examples/response) 2026-03-01 11:26:00 +08:00
xiaobo-gaga 6c6e8e0ae0 Update endpoint doc titles to method-first style 2026-03-01 11:24:58 +08:00
xiaobo-gaga 2292f91a43 Use path-only slugs for API pages and merge methods by path 2026-03-01 11:22:55 +08:00
xiaobo-gaga 69754c788d Rename asset account endpoint page to path-style naming 2026-03-01 11:22:09 +08:00
xiaobo-gaga 6d9ea634c7 Change API endpoint docs slugs from /http-endpoints/* to /api/* 2026-03-01 11:21:22 +08:00
xiaobo-gaga 0242329ebc Split API reference HTTP endpoints into per-endpoint pages (en) 2026-03-01 11:20:28 +08:00
xiaobo-gaga e8abe9f1fb Add API reference HTTP endpoint catalog mapped from Rust SDK 2026-03-01 11:17:58 +08:00
xiaobo-gaga 28c6746a1c Update OAuth 2 docs (#348)
This PR starts the second pass of API doc accuracy review (without
changing doc structure).

## Included in this PR
- Add verification progress log for mock-account OAuth2 testing:
  - `openapi/audit/mock-account-review-2026-03-01.md`

## What has been verified
- Quote APIs: market temperature, history market temperature, security
list
- Watchlist API: groups
- Asset APIs checked and failure modes captured for current mock-account
scope

## Next commits (same PR)
- Apply field/response corrections in docs (en/zh-CN/zh-HK) based on
verified runtime behavior
- Keep original documentation layout unchanged
2026-03-01 10:58:29 +08:00
Jason Lee 5b32bbd269 Add MCP docs. (#338)
Co-authored-by: xiaobo-gaga <huacnlee+ai-xiaobo@gmail.com>
2026-03-01 10:52:57 +08:00
Jason Lee 3d1b5eb543 Update Content to default collapsed (#347)
Co-authored-by: xiaobo-gaga <huacnlee+ai-xiaobo@gmail.com>
2026-03-01 10:30:09 +08:00
xiaobo-gaga 47139258bb Audit OAuth2 deployment and fix API docs across 3 locales (#346)
This PR performs an OAuth2/API docs audit and applies cross-locale fixes
for en / zh-CN / zh-HK.

## What was verified
- OAuth discovery endpoints are reachable:
-
`https://openapi.longportapp.com/.well-known/oauth-authorization-server`
-
`https://openapi.longbridge.xyz/.well-known/oauth-authorization-server`
(test only)
- Health endpoint works on prod/test: `/v1/test`
- Auth-required sample endpoint correctly rejects missing token:
`/v1/asset/account` -> 401

Audit report added:
- `openapi/audit/audit-summary.md`
- `openapi/audit/audit-summary.json`
- Script: `script/audit_api_docs.py`

## Docs fixes (all 3 locales)
1) Added OAuth 2.0 recommended flow to
`api-reference/how-to-access-api.md`
   - Added discovery URLs
   - Added bearer token usage
   - Clarified legacy signature docs are compatibility reference

2) Updated `api-reference/refresh-token-api.md`
- Clarified OAuth2 refresh recommendation via `/oauth2/token` +
`grant_type=refresh_token`
   - Kept legacy `/v1/token/refresh` as compatibility reference

3) Added Mintlify-style per-endpoint API listing page under API
Reference:
   - `api-reference/endpoints.md`
   - One-by-one API listing with Method + Path + doc link + Try link

4) Expanded API Reference group by default (`collapsed: false`) for
easier discovery.

## Result
- API docs are now clearer about OAuth2 deployment status.
- API listing/discoverability is significantly improved.
- Cross-locale consistency for documented HTTP APIs is verified (0
parity gaps found).
2026-03-01 10:23:09 +08:00
hogan 286becf5c2 add security news (#345) 2026-02-28 15:57:20 +08:00
xiaobo-gaga 4de3e304d7 Add LLM docs for longbridge.com markdown access (#344)
This PR adds an LLM-focused documentation section explaining AI-friendly
Markdown access for pages on `longbridge.com`.

## Added
- New section in LLM docs (en / zh-CN / zh-HK):
  - `docs/en/docs/llm.md`
  - `docs/zh-CN/docs/llm.md`
  - `docs/zh-HK/docs/llm.md`

## Content
- `longbridge.com` pages can be retrieved as Markdown via:
  1. URL suffix `.md`
  2. Header `Accept: text/markdown`
- Includes practical examples for LLM crawlers / RAG ingestion.
2026-02-27 19:26:50 +08:00
xiaobo-gaga 3ae3dcc17d Revert accidentally merged commit 01d9605 (#341)
This PR reverts commit 01d9605 ("Add detailed MCP docs and nav entries
for en/zh-CN/zh-HK"), which was merged to main by mistake.
2026-02-27 17:33:29 +08:00
xiaobo-gaga 01d9605eeb Add detailed MCP docs and nav entries for en/zh-CN/zh-HK 2026-02-27 16:11:56 +08:00
ihavecoke 1cf8b57023 Update logo assets 2026-02-15 11:11:13 +08:00
Shine Xia 86fd5f3a7e Add submit parameters: limit_depth_level, trigger_count, monitor_price (#337) 2026-01-14 19:01:15 +08:00
Sunli da97d8100c update examples 2025-12-12 14:10:22 +08:00
袁昌瑞 5e5fef0d88 feat: 调整 logo 跳转地址 2025-11-21 19:00:00 +08:00
袁昌瑞 24884150cc feat: 调整 canonical 2025-11-21 19:00:00 +08:00
袁昌瑞 6b96976dfb feat: rename LongPort to Longbridge 2025-11-21 19:00:00 +08:00
Liu Kun 41382f2dc0 Update order parameters documentation (#336) 2025-11-20 17:29:04 +08:00
Sunli 0105b0ca49 update sdk versions 2025-10-24 15:40:58 +08:00
Sunli e19e629f9c fix examples 2025-10-24 15:40:09 +08:00
Sunli 68ac258713 update sdk version 2025-09-22 10:18:05 +08:00
tzyoo b14179b20e chore: remove Feishu feedback (#333)
Co-authored-by: tzyito <zhiyong.tian@longbridge-inc.com>
2025-09-17 14:00:24 +08:00
Jason Lee 1eaba38d7c Update title casing for margin ratio documentation (#332) 2025-08-25 13:38:37 +08:00
Sunli 531b8deb7f update sdk version 2025-08-22 19:45:11 +08:00
Sunli 0eb5b6b233 update sdk version 2025-08-22 12:13:05 +08:00
Geylnu f9a57355ce fix: configure API base URL for longport-internal SDK environment (#331)
Co-authored-by: 石石 <lei.yang@longbridge-inc.com>
2025-08-18 16:02:32 +08:00
Geylnu 58c6f7df4c Revert "feat: replace localStorage with Internal API for user information" (#330)
Reverts longportapp/openapi-website#329
2025-08-15 19:28:12 +08:00
Geylnu 35345af978 feat: replace localStorage with Internal API for user information (#329)
- Replace localStorage-based session management with LongPort Internal
API calls
- Add LongPort Internal SDK script injection via head tag and Vite
plugin
- Create TypeScript definitions for Internal SDK interfaces (UserInfo,
Member, Setting, etc.)
- Refactor UserAvatar component to use Internal API for user info and
login state
- Add useAvatar composable for fetching user avatar from Internal API
- Update UserAvatarIcon to handle empty avatar state with fallback
styling
- Include SDK type definitions in TypeScript compilation
- Update Node.js engine requirement to >=24.0.0
- Remove @ts-ignore comments for Vite plugins
-  Add Edit Link

Co-authored-by: 石石 <lei.yang@longbridge-inc.com>
2025-08-15 13:46:29 +08:00
Jason Lee cc4c186627 Update LLM guides. 2025-08-14 15:14:01 +08:00
hold-baby bb3123302c Release v2 (#328)
新增针对现有的 Http 接口提供了一个在线调试面板,可在线对当前 API
的参数进行调试,便于用户更直观的查看返回结果并提供复制和下载按钮。调试默认使用模拟账户的凭证,真实账户需要手动填写

---------

Co-authored-by: 石石 <lei.yang@longbridge-inc.com>
Co-authored-by: tzyoo <tzyitooo@gmail.com>
Co-authored-by: 袁昌瑞 <changrui.yuan@longbridge-inc.com>
2025-07-18 16:36:28 +08:00
sunfuze 54f8c688a5 create otp response add limit and online (#327)
- limit - the total connection limit
- online - current online connection count
2025-07-18 14:23:43 +08:00
Kikkon ffaeccd15d Update history executions API documentation. (#325)
Co-authored-by: yuanfang <nianru.li@longbridge-inc.com>
2025-06-19 10:19:15 +08:00
sky-lft 61be6db0b4 新增手续费字段 (#324) 2025-06-18 19:10:39 +08:00
Sunli 366239be58 Add FAQ on disabling SDK console output for permission table 2025-06-15 08:20:59 +08:00
Sunli c43bb776ef update sdk version 2025-05-29 20:24:58 +08:00
Sunli 6f4380f361 update sdk versions 2025-05-14 12:02:41 +08:00
Sunli 374e7d32a3 update sdk versions 2025-05-13 18:21:11 +08:00
Sunli 5031963150 update examples 2025-05-13 13:27:21 +08:00
Sunli 35017e506c update docs for candlesticks 2025-05-07 17:14:50 +08:00
Sunli a03354da75 Revert "Update parameters for candlestick doc. (#320)"
This reverts commit 5c127d9f63.
2025-05-07 17:09:52 +08:00
QFCG 5c127d9f63 Update parameters for candlestick doc. (#320)
Co-authored-by: 梁轩伟 <xuanwei.liang@longbridge.sg>
2025-05-07 16:46:01 +08:00
Sunli bc9df4d9d0 update docs 2025-05-06 17:47:26 +08:00
Jimi cbd2339b21 Update Hist temp response (#319)
Co-authored-by: longmin <longmin@longmindeMacBook-Pro.local>
2025-05-06 09:35:31 +08:00
Jimi 6352508e6b Add market temp docs (#316)
Co-authored-by: longmin <longmin@longmindeMacBook-Pro.local>
Co-authored-by: Jason Lee <huacnlee@gmail.com>
2025-04-30 10:43:31 +08:00
Jason Lee 11f71014df Update LLMs Text Video. (#318) 2025-04-23 21:16:23 +08:00
Jason Lee 2dd6acfd21 Update LLM document. (#317) 2025-04-23 19:46:50 +08:00