-
Notifications
You must be signed in to change notification settings - Fork 11
fix: remove deprecated endpoints, update existing, add arenas #131
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR comprehensively updates the API documentation to support the new arena architecture and perpetual futures competitions while removing deprecated endpoints. The changes ensure API documentation accurately reflects the current API state and introduces better organization with arena-based competition grouping.
Key Changes:
- Added arena endpoints (
GET /api/arenas,GET /api/arenas/{id}) for browsing competition environments - Added perpetual futures endpoints for positions and account data
- Removed 4 deprecated competition endpoints (leaderboard, status, rules, upcoming)
- Updated field naming from
position→rankthroughout for consistency - Enhanced competition schemas with arena architecture fields and participation rules
Reviewed Changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
specs/competitions.json |
Core OpenAPI spec with new arena/perps endpoints, removed deprecated endpoints, added arena fields to competitions |
docs/reference/endpoints/arenas.mdx |
New documentation page for arena browsing endpoints |
docs/reference/endpoints/competitions.mdx |
New documentation page for perps-specific competition endpoints |
docs/reference/endpoints/leaderboard.mdx |
New documentation page for global and arena-specific leaderboards |
docs/reference/endpoints/agent.mdx |
Updated to include perps positions and account endpoints |
docs/reference/endpoints/competition.mdx |
Removed deprecated endpoints, updated descriptions |
docs/reference/endpoints/trade.mdx |
Added clarification that trade endpoints are paper trading only |
| Other markdown files | Minor formatting/line wrapping improvements for consistency |
app/api/chat/route.ts |
Code style improvements (arrow function formatting) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
derrekcoleman
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great. Thanks for linting.
One question in the review about "Competition" vs "Competitions" endpoints, since all of the endpoints on both pages are on the /competitions/ route. If there are good reasons that's true back in js-recall, totally fine. Just flagging that it's a little silly to see them split like that here, so I was wondering what's up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: generation script categorizing some /competitions endpoints on a separate /competition (singular) page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just noticed the .json spec does have a "Competition" section separate from "Competitions", but as far as I can tell the only two endpoints we're representing here from the "Competition" section are in the /competitions route.
Maybe an upstream change in the openapi spec is needed? @mzkrasner , what do you think of the two endpoints on the "Competition" page being separate from the others on the "Competitions" page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call - I just realized that - not sure how that happened in the main notation. Put in a pr to fix that in js-recall: recallnet/js-recall#1578
Also fixed in b984b48
API Documentation Update
Summary
Comprehensive update to API documentation to include new arena and perpetual futures endpoints.
Changes
Documentation (recall-docs)
GET /api/arenas,GET /api/arenas/{id}GET /api/agent/perps/*,GET /api/competitions/{id}/perps/*GET /api/leaderboard(supports both global and arena-specific queries)/api/competitions/leaderboard,/api/competitions/status,/api/competitions/rules,/api/competitions/upcomingposition→rankthroughout for consistencyarenas.mdx,competitions.mdx(perps only),leaderboard.mdxFiles Changed
recall-docs/specs/competitions.jsonrecall-docs/docs/reference/endpoints/*.mdx(10 files regenerated)