docs: fix README endpoint table — remove non-existent /v1/ prefix#170
docs: fix README endpoint table — remove non-existent /v1/ prefix#1700x-SquidSol wants to merge 1 commit intodcccrypto:mainfrom
Conversation
The README documented routes with a /v1/ prefix (e.g., /v1/markets, /v1/prices) but all actual routes are registered without any version prefix. Clients following the README would get 404s on every endpoint. Updates the endpoint table to match the actual route registration in src/index.ts, including all endpoints that were previously missing from the table (oracle, chart, ADL, ws/stats, funding/historySince, per-market trades/volume/prices). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 1 minutes and 50 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
/v1/prefix (/v1/markets,/v1/prices, etc.) but all actual routes are registered without any version prefix. Clients following the README would get 404s on every endpoint.Changes
/v1/prefix from all routes (11 entries)/markets/:slab/trades,/markets/:slab/volume,/markets/:slab/prices,/markets/:slab/stats), oracle, chart, ADL, ws/stats, funding/historySince, trades/recent, prices/markets, prices/:slab, crank/status:addressto:slab(matching actual param name)Test plan
vitest runpasses (186/186 tests)🤖 Generated with Claude Code