Skip to content

Commit 56be71d

Browse files
Cooooookerchengzhipengclaude
authored
docs: Add is_pinned field to watchlist and limit hashtags to 1 (#413)
- Add `is_pinned` boolean field to watchlist groups API response - Update create_topic hashtags maximum from 5 to 1 Co-authored-by: chengzhipeng <zhipeng.cheng@longbridge-inc.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent f63b957 commit 56be71d

File tree

7 files changed

+15
-7
lines changed

7 files changed

+15
-7
lines changed

docs/en/docs/content/create_topic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ longbridge topic create AAPL.US "Apple WWDC preview"
5555
| body | string | YES | Topic body. \n- For `post`: plain text only — Markdown is not rendered.\n- For `article`: Markdown is supported. |
5656
| topic_type | string | NO | Content type: `post` (plain text, default) or `article` (Markdown). |
5757
| tickers | string[] | NO | Related security symbols, format `{symbol}.{market}` (e.g. `["AAPL.US", "700.HK"]`). Maximum 10. **Note:** Symbols mentioned in the body (e.g. `700.HK`, `TSLA.US`) are automatically recognized and linked by the platform. Use `tickers` to associate additional symbols not explicitly mentioned in the body. |
58-
| hashtags | string[] | NO | Hashtag names (e.g. `["earnings", "fed"]`). Maximum 5. |
58+
| hashtags | string[] | NO | Hashtag names (e.g. `["earnings", "fed"]`). Maximum 1. |
5959

6060
### Request Example
6161

docs/en/docs/quote/individual/watchlist_groups.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,8 @@ func main() {
229229
"market": "HK",
230230
"name": "Tencent",
231231
"watched_price": "364.4",
232-
"watched_at": 1652855022
232+
"watched_at": 1652855022,
233+
"is_pinned": true
233234
}
234235
]
235236
}
@@ -266,3 +267,4 @@ func main() {
266267
| ∟∟ name | string | true | Name |
267268
| ∟∟ watched_price | string | true | Watched price |
268269
| ∟∟ watched_at | integer | true | Watched time |
270+
| ∟∟ is_pinned | boolean | true | Whether the security is pinned |

docs/zh-CN/docs/content/create_topic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ longbridge topic create AAPL.US "Apple WWDC 前瞻"
5555
| body | string | YES | 正文。`post` 类型为纯文本,Markdown 不渲染;`article` 类型支持 Markdown。 |
5656
| topic_type | string | NO | 内容类型:`post`(纯文本,默认)或 `article`(Markdown) |
5757
| tickers | string[] | NO | 关联标的代码,格式 `{symbol}.{market}`,如 `["AAPL.US", "700.HK"]`,最多 10 个。**注意:** 正文中提到的标的代码(如 `700.HK``TSLA.US`)会被平台自动识别并关联,`tickers` 用于补充正文中未显式提及的标的。 |
58-
| hashtags | string[] | NO | 讨论标签名称列表,如 `["earnings", "fed"]`,最多 5|
58+
| hashtags | string[] | NO | 讨论标签名称列表,如 `["earnings", "fed"]`,最多 1|
5959

6060
### Request Example
6161

docs/zh-CN/docs/quote/individual/watchlist_groups.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,8 @@ func main() {
230230
"market": "HK",
231231
"name": "腾讯控股",
232232
"watched_price": "364.4",
233-
"watched_at": 1652855022
233+
"watched_at": 1652855022,
234+
"is_pinned": true
234235
}
235236
]
236237
}
@@ -267,3 +268,4 @@ func main() {
267268
| ∟∟ name | string | true | 名称 |
268269
| ∟∟ watched_price | string | true | 关注时的价格 |
269270
| ∟∟ watched_at | integer | true | 关注时间 |
271+
| ∟∟ is_pinned | boolean | true | 是否置顶 |

docs/zh-HK/docs/content/create_topic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ longbridge topic create AAPL.US "Apple WWDC 前瞻"
5555
| body | string | YES | 正文。`post` 類型為純文本,Markdown 不渲染;`article` 類型支持 Markdown。 |
5656
| topic_type | string | NO | 內容類型:`post`(純文本,默認)或 `article`(Markdown) |
5757
| tickers | string[] | NO | 關聯標的代碼,格式 `{symbol}.{market}`,如 `["AAPL.US", "700.HK"]`,最多 10 個。**注意:** 正文中提到的標的代碼(如 `700.HK``TSLA.US`)會被平台自動識別並關聯,`tickers` 用於補充正文中未顯式提及的標的。 |
58-
| hashtags | string[] | NO | 討論標籤名稱列表,如 `["earnings", "fed"]`,最多 5|
58+
| hashtags | string[] | NO | 討論標籤名稱列表,如 `["earnings", "fed"]`,最多 1|
5959

6060
### Request Example
6161

docs/zh-HK/docs/quote/individual/watchlist_groups.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,8 @@ func main() {
229229
"market": "HK",
230230
"name": "騰訊控股",
231231
"watched_price": "364.4",
232-
"watched_at": 1652855022
232+
"watched_at": 1652855022,
233+
"is_pinned": true
233234
}
234235
]
235236
}
@@ -266,3 +267,4 @@ func main() {
266267
| ∟∟ name | string | true | 名稱 |
267268
| ∟∟ watched_price | string | true | 關注時的價格 |
268269
| ∟∟ watched_at | integer | true | 關注時間 |
270+
| ∟∟ is_pinned | boolean | true | 是否置頂 |

openapi.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -530,11 +530,13 @@ paths:
530530
name: Apple Inc.
531531
watched_price: '211.59'
532532
watched_at: '1741690995'
533+
is_pinned: true
533534
- symbol: 700.HK
534535
market: HK
535536
name: 腾讯控股
536537
watched_price: '460.00'
537538
watched_at: '1725511157'
539+
is_pinned: false
538540
default:
539541
description: Unexpected error
540542
content:
@@ -1540,7 +1542,7 @@ paths:
15401542
hashtags:
15411543
type: array
15421544
nullable: true
1543-
description: Associated hashtag names (e.g. `["earnings", "fed"]`). Maximum 5.
1545+
description: Associated hashtag names (e.g. `["earnings", "fed"]`). Maximum 1.
15441546
items:
15451547
type: string
15461548
responses:

0 commit comments

Comments
 (0)