Skip to content

docs: fix README endpoint table — remove non-existent /v1/ prefix#170

Open
0x-SquidSol wants to merge 1 commit intodcccrypto:mainfrom
0x-SquidSol:docs/fix-readme-route-paths
Open

docs: fix README endpoint table — remove non-existent /v1/ prefix#170
0x-SquidSol wants to merge 1 commit intodcccrypto:mainfrom
0x-SquidSol:docs/fix-readme-route-paths

Conversation

@0x-SquidSol
Copy link
Copy Markdown
Contributor

Summary

  • Issue: README documented routes with a /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.
  • Fix: Updates the endpoint table to match actual route registration. Also adds all endpoints that were previously missing from the table.

Changes

  • Removed /v1/ prefix from all routes (11 entries)
  • Added 14 missing endpoints: per-market routes (/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
  • Updated :address to :slab (matching actual param name)

Test plan

  • vitest run passes (186/186 tests)

🤖 Generated with Claude Code

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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

Warning

Rate limit exceeded

@0x-SquidSol has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 1 minutes and 50 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 048a42d1-5209-41ea-bd78-906a2ae19ce2

📥 Commits

Reviewing files that changed from the base of the PR and between fb94c29 and 88a8a88.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant