Commit Graph

323 Commits

Author SHA1 Message Date
Jason Lee b67c4d6bde fix footer. 2026-03-18 15:12:25 +08:00
Jason Lee 80978e1cc9 Fix assets 2026-03-18 14:58:09 +08:00
Jason Lee e7e9a2d1ba feat: Update platform name to Longbridge Developers and UI improvements (#369)
## Summary

- Rename project from "OpenAPI" to "Longbridge Developers" across all
locales, config, and docs
- Add local SVG assets for homepage features (replacing external CDN
URLs)
- **TipContainer**: replace emoji with SVG icons, Shadcn-style
border/bg/text per type using `data-type` + CSS `@apply`
- **Tabs**: improved tab styling, fix `ul`/`ol` indentation in tab
content
- **Sidebar**: active item uses brand color background (color-mix) with
rounded corners
- **Doc footer**: LLMs Text + Edit this page on same row, subdued
colors, lighter "Updated at"
- **Breadcrumb**: remove primary color
- **UserMenu**: rename Profile → Dashboard (控制台)
- **Style**: inline code color fix, blockquote updates, font
improvements

## Test plan

- [ ] Verify rename appears correctly in EN / zh-CN / zh-HK locales
- [ ] Check homepage SVGs load from `/assets/`
- [ ] Check TipContainer all 6 types render with correct
border/bg/text/icon colors in light and dark mode
- [ ] Check Tabs styling and list indentation
- [ ] Check sidebar active item background
- [ ] Check doc footer layout (LLMs Text + Edit this page same row)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-18 14:35:26 +08:00
hold-baby 961260f85f feat: remove customer service widget (#368)
Co-authored-by: 袁昌瑞 <changrui.yuan@longbridge-inc.com>
2026-03-18 10:08:45 +08:00
hold-baby 9391748947 feat: update support-widget version to 1.0.5 (#367)
Co-authored-by: 袁昌瑞 <changrui.yuan@longbridge-inc.com>
2026-03-17 23:52:38 +08:00
hold-baby 5d4c095101 feat: 添加客服入口 support-widget (#365)
- 动态加载 support-widget 脚本
- 配置 isLoggedIn、loginUrl、chatUrl
- 处理 token 编码和 null 场景

Co-authored-by: 袁昌瑞 <changrui.yuan@longbridge-inc.com>
2026-03-17 23:32:38 +08:00
Jason Lee c6a8731733 docs: add company filings commands and earnings analysis example to CLI docs (#364)
## Summary

- Add `filings` and `filing-detail` commands to the "Available
capabilities" section across all three locales (en, zh-CN, zh-HK)
- Add an earnings analysis example in the "AI integration" section
demonstrating a two-step workflow: use `filings` to discover filing IDs,
then `filing-detail` to pull full content for cross-company comparison
(TSLA vs NVDA Q4 2025)

## Test plan

- [ ] Verify the new "Company filings & announcements" section renders
correctly in all three locales
- [ ] Verify the earnings analysis example code block displays properly
- [ ] Check that table formatting renders correctly in the example
output

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-17 22:55:24 +08:00
Jason Lee 679706d589 docs: update brew install command to use --cask flag (#362)
## Summary

- Update brew install command to `brew install --cask` in CLI docs
(zh-CN, zh-HK, en)

Follows the migration of longbridge/homebrew-tap from Formula to Cask.

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-17 16:44:31 +08:00
Jason Lee 4a908652bb docs: add Longbridge Terminal CLI page (#361)
## Summary

- Add CLI documentation page (EN / zh-CN / zh-HK) for [Longbridge
Terminal](https://github.com/longbridge/longbridge-terminal), covering
installation (Homebrew + install script), OAuth authentication, full
command reference, and AI integration
- Add **CLI** nav item after MCP in all three locales
- Move LLM sidebar position to appear immediately after CLI

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-17 16:20:20 +08:00
hogan 77a52132e6 update news symbol (#359)
Co-authored-by: 袁章洪 <zhanghong.yuan@longbridge-inc.com>
2026-03-16 19:04:07 +08:00
Colbert Ran 5166d1613d fix wrong docs (#358) 2026-03-12 19:49:27 +08:00
Sunli 5accb00f24 docs: Longbridge SDK docs update (branding, 4.0.0, Go examples) (#356)
## Summary
- **Branding & version**: SDK 页与文档统一为 longbridge 品牌、版本 4.0.0,修正仓库与包地址
- **Getting started**: 更新 API Host、OAuth 示例与 4.0.0,修正 typo(开发中 → 开发者)
- **Request examples**: 为所有 API 请求示例补充多语言
tabs(Python/Node/Java/Rust/C++),并增加 Go SDK 示例(en / zh-CN / zh-HK)
- **Dependencies**: 更新 package.json 与 bun.lock

Made with [Cursor](https://cursor.com)
2026-03-11 11:34:49 +08:00
Endless Web 208e9206da docs: update brd.md 2026-03-05 17:23:19 +08:00
Jason Lee 50b377cee0 [Agent] 优化 MCP 服务介绍文档 (#355)
## 变更摘要

- 参考 Stripe MCP 文档风格,重写三个 locale(zh-CN、zh-HK、en)的 `docs/mcp.md`
- 将开篇由技术描述驱动改为用户价值驱动(「你可以做什么」优先于「这是什么」)
- 新增「能做什么」章节,补充查询行情、分析账户、执行交易三组具体提示词示例
- 整理各客户端接入配置,结构更清晰

## 实现细节

| 文件 | 修改原因 |
|------|---------|
| `docs/zh-CN/docs/mcp.md` | 简体中文版重写 |
| `docs/zh-HK/docs/mcp.md` | 繁体中文版同步 |
| `docs/en/docs/mcp.md` | 英文版同步 |

## Quality Checklist

- [x] 三个 locale 内容同步
- [x] 参考 Stripe 文档结构(https://docs.stripe.com/mcp)
- [x] 遵循长桥文案书写规范

---
_Generated by Endless Coding Agent (session a5817662)_

---------

Co-authored-by: Endless Agent <endless+openapi-website@longbridge.com>
Co-authored-by: Endless Agent <endless+openapi-website@endless+self-agent@longbridge.com>
Co-authored-by: Endless Agent <endless@longbridge.com>
2026-03-04 22:55:45 +08:00
Jason Lee 0aba4644e0 Add OAuth 2.0 as recommended authentication method (#351)
Updated getting-started documentation for both zh-CN and en:

**Changes:**
- Added OAuth 2.0 as the recommended authentication method (marked with
)
- Moved traditional API Key method to secondary position for
compatibility
- Added OAuth registration and authorization flow examples for all SDKs
- Included OAuth benefits and security best practices
- Provided code examples for Python, JavaScript, Rust, and Java

**OAuth 2.0 Benefits:**
 More secure (no shared secret)
 Simpler integration (no signature calculation)
 Token-based modern authentication
 Better suited for modern applications

---------

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-03-02 20:44:20 +08:00
xiaobo-gaga 626ee312c0 Place MCP under Getting Started and add MCP top-nav entry (#354)
## Summary

- Move MCP under Getting Started in left sidebar (all locales)
  - docs/en/docs/mcp.md
  - docs/zh-CN/docs/mcp.md
  - docs/zh-HK/docs/mcp.md
- Add MCP top navigation item right after Docs (all locales)
  - docs/.vitepress/locales/en/nav.ts
  - docs/.vitepress/locales/zh-CN/nav.ts
  - docs/.vitepress/locales/zh-HK/nav.ts

## Notes

- Clean branch from main
- No unrelated changes included
2026-03-02 18:39:35 +08:00
xiaobo-gaga ac5740ddc3 Adjust MCP docs sidebar order to position 6 (#353)
## Summary

Set MCP docs  to  across all locales:

- 
- 
- 

## Notes

Clean branch from  with only this change.
2026-03-02 11:41:36 +08:00
xiaobo-gaga f297ee91fc zh-CN OAuth docs rework: OAuth2-only access guide + refresh-page de-dup (#349) 2026-03-01 12:35:43 +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