Repository navigation
fix(api-reference): de-duplicate API page titles and descriptions - #1335
Merged
Merged
Conversation
- WS push depth/trades/candlesticks: add "Subscription" so they no longer share titles with the pull commands - fund_positions: zh title 账户基金持仓, distinct from fund_holdings - short_positions_hk/us, short_trades_hk/us: describe each endpoint's own market Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Merge Verdict
[APPROVE]
Summary
Several API Reference pages shared the same
<title>or meta description, which search engines treat as duplicate pages and which also misdescribed some endpoints. This PR fixes the copy inopenapi.yamlonly:ws-push-depth/ws-push-trade/ws-push-candlestick(en)Depth/Trades/Candlesticks, same as the pull commandsDepth Subscription/Trades Subscription/Candlesticks Subscriptionws-push-candlestick(zh-CN / zh-HK)K 线/K 線, same as pull实时 K 线订阅/K 線訂閱, matching the other push commands (实时盘口订阅/盤口訂閱)fund_positions(zh-CN / zh-HK)基金持仓/基金持倉, same asfund_holdings账户基金持仓/賬戶基金持倉short_positions_hk/short_positions_us(3 locales)short_trades_hk/short_trades_us(3 locales)Update cadences (daily / bi-monthly / each trading day / bi-weekly) are carried over unchanged from the original text.
Risk Analysis
… SubscriptionthereDesign Decisions
Subscriptionsuffix rather than renaming the pull side, so existing pull page titles stay stable.Code Concerns
[FYI]
symbolparameter text on the four short-selling endpoints still mentions both markets (openapi.yaml,x-parametersofshort_positions_hk/us,short_trades_hk/us): it still reads "e.g.TSLA.USor700.HK" on each market-specific endpoint. Out of scope for this copy fix; can be aligned in a follow-up.Verification
Conclusion basis: Verified
apiPageMeta(the same function the pages use): 13 duplicate groups before, 0 after.bun testinpackages/api-reference: 10 pass, 0 fail.🤖 Generated with Claude Code