-
Notifications
You must be signed in to change notification settings - Fork 124
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
Update api documentation #781
Conversation
Warning Rate Limit Exceeded@Christopher-Li has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 4 minutes and 0 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the @coderabbitai review command. 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 repository. WalkthroughThe changes primarily involve updates to the base URLs used for API endpoint calls in the dYdX Indexer service. The base URLs have been updated in both the public API documentation and the Swagger document generator script. Additionally, descriptions have been added to the server objects in the Swagger document generator. Changes
TipsChat with CodeRabbit Bot (
|
acd82ca
to
9d46d04
Compare
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.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to filter (1)
- indexer/services/comlink/public/swagger.json
Files selected for processing (2)
- indexer/services/comlink/public/api-documentation.md (37 hunks)
- indexer/services/comlink/src/scripts/generate-swagger.ts (1 hunks)
Additional comments: 3
indexer/services/comlink/src/scripts/generate-swagger.ts (1)
- 17-27: The URLs and descriptions for the mainnet and testnet servers have been updated. Ensure that these new URLs are correct and that all API calls are functioning as expected with these changes.
indexer/services/comlink/public/api-documentation.md (2)
8-10: The base URLs have been updated. Ensure that these new URLs are correct and accessible.
1687-1687: All API endpoint calls have been updated to use the new base URLs. Ensure that these endpoints are correct and accessible with the new base URLs.
9d46d04
to
3853fb7
Compare
3853fb7
to
75cbc6f
Compare
Changelist
Update testnet endpoint
Test Plan
None
Author/Reviewer Checklist
state-breaking
label.PrepareProposal
orProcessProposal
, manually add the labelproposal-breaking
.feature:[feature-name]
.backport/[branch-name]
.refactor
,chore
,bug
.