Commit Graph

6 Commits

Author SHA1 Message Date
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
袁昌瑞 6b96976dfb feat: rename LongPort to Longbridge 2025-11-21 19:00:00 +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
ihavecoke 0940dcea8d Update llms-full.txt to include LongPort OpenAPI Documentation header 2025-05-09 23:53:41 +08:00
ihavecoke 4385c55c71 Support llms-full.txt. 2025-05-09 23:44:23 +08:00
Jason Lee cfec198ff2 Remove Swagger, just use simple Markdown files. (#314) 2025-03-20 16:13:25 +08:00