Skip to content

docs: add missing OpenAPI spec for historySince, ADL rankings, and chart#155

Open
0x-SquidSol wants to merge 1 commit intodcccrypto:mainfrom
0x-SquidSol:docs/add-missing-openapi-endpoints
Open

docs: add missing OpenAPI spec for historySince, ADL rankings, and chart#155
0x-SquidSol wants to merge 1 commit intodcccrypto:mainfrom
0x-SquidSol:docs/add-missing-openapi-endpoints

Conversation

@0x-SquidSol
Copy link
Copy Markdown
Contributor

Summary

  • Issue: Three fully implemented, registered endpoints were completely absent from openapi.yaml. An external auditor comparing spec to implementation would flag these immediately.
  • Fix: Adds complete OpenAPI 3.0.3 path entries and component schemas for all three endpoints.

Endpoints added

Endpoint Description Schemas added
GET /funding/{slab}/historySince Funding history with required since timestamp Reuses existing FundingHistoryEntry
GET /api/adl/rankings ADL trigger state and ranked positions AdlRankingsResponse, AdlRankedPosition
GET /chart/{mint} OHLCV candlestick data via GeckoTerminal ChartResponse, OhlcvCandle

Details

  • All parameters, defaults, constraints, and status codes verified against actual route implementations
  • ADL endpoint documents X-Cache header and 504 timeout response
  • Chart endpoint notes timeframe-dependent aggregate defaults in description
  • Added ADL and Chart tags to the tags section

Test plan

  • vitest run passes (186/186 tests)
  • YAML has no tab indentation issues
  • Cross-checked all params, response shapes, and status codes against source

🤖 Generated with Claude Code

…, and chart

Three fully implemented endpoints were absent from openapi.yaml:

- GET /funding/{slab}/historySince — funding history with required `since` param
- GET /api/adl/rankings — ADL trigger state and ranked profitable positions
- GET /chart/{mint} — OHLCV candlestick data via GeckoTerminal

Adds path entries with accurate parameters, response schemas, status codes,
and custom headers (X-Cache for ADL). Also adds corresponding component
schemas: AdlRankingsResponse, AdlRankedPosition, ChartResponse, OhlcvCandle.

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 6 minutes and 57 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 6 minutes and 57 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: ef4b15fd-c103-4191-b983-69a3d152de9d

📥 Commits

Reviewing files that changed from the base of the PR and between fb94c29 and 1488f52.

📒 Files selected for processing (1)
  • openapi.yaml
✨ 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