Refresh API docs: spec sync, WebSocket section, AI-agent artifacts - #14
Open
guiviaje wants to merge 10 commits into
Open
Refresh API docs: spec sync, WebSocket section, AI-agent artifacts#14guiviaje wants to merge 10 commits into
guiviaje wants to merge 10 commits into
Conversation
Spec regenerated from the current api-gw code: - listenKey endpoint (WebSocket auth) and 429 rate-limit responses - OrderDetails extended (trades, fees, strategy, timestamps) + TradeDetails - include_trades / include_fees params on order/byId - request exchange enum published as TradingExchange with the list the API actually accepts (incl. the newly enabled HYPERLIQUID); the wider Exchange enum remains for response fields - corrected auth description (signatures are Base64, not hex) and typos WebSocket API documented on the same page via a Slate include (source/includes/_websocket.md, wired with widdershins --includes): listenKey authentication, keep-alive, subscribe protocol, error codes and the six topics (order, child_order, trade, position, position_risk, balance) with example frames. docs/ rebuilt with middleman (ruby 3.3, mirroring the Build action). 🤖 Generated with [Claude Code](https://claude.com/claude-code)
…artifacts - New 'For AI Agents' docs section (source/includes/_agents.md) with MCP quickstart, guardrail flags, and machine-readable doc links; wired into the Widdershins regeneration (--includes websocket,agents) - llms.txt index served from docs/, llms-full.txt generated at build (all Markdown concatenated, HTML stripped) - Publish raw Markdown variants (index.md, websocket.md, agents.md) and the AsyncAPI WebSocket spec (asynapi.yml) alongside the OpenAPI spec - Spec fixes: add missing /api/v2/trading/listenKey path; correct response schemas for /trading/balance (AssetBalance[]), /trading/position (AccountPosition[]), /trading/userTrades (TradeDetailsList), /data/exchanges and /data/instruments and funding endpoints (arrays); point API intro at the agent tooling Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ise large-file cap for the generated page 🤖 Generated with [Claude Code](https://claude.com/claude-code)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
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
1 participant
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.
What
Single-page docs refresh, aligned with the current API code and the WebSocket stream server (GitLab MR 2422 / BAC-912):
Spec refresh (
anboto-trading-api-2.0.yml) — regenerated from code:listenKeyendpoint (WebSocket auth), 429 rate-limit responses on all authenticated endpointsOrderDetailsextended (trades, fees, strategy, timing) + newTradeDetailsschemainclude_trades/include_feesparams onorder/byIdTradingExchangewith the list the API actually accepts (incl. newly enabled HYPERLIQUID); response-sideExchangeenum unchangedWebSocket API section (same page) — new Slate include
source/includes/_websocket.md, wired viawiddershins --includes:listenKey auth, keep-alive, subscribe protocol, error codes, and all nine topics (
order,child_order,trade,position,position_risk,balance,ticker,ohlcv,open_interest) with example frames.AI-agent artifacts — builds on the "For AI Agents" section: post-build workflow step now generates the machine-readable files it links to (
llms.txt,llms-full.txt,index.md,websocket.md,agents.md,asynapi.yml).Also: duplicate
argskey fixed in.pre-commit-config.yaml; large-file cap raised to 1500 KB (the generated page crossed 500 KB).Merge timing
api-docs-refreshMR).Site rebuilt locally with ruby 3.3 mirroring the Build action;
docs/in this PR is the rendered result.🤖 Generated with Claude Code