Skip to content
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

Merged
merged 1 commit into from
Nov 30, 2023
Merged

Update api documentation #781

merged 1 commit into from
Nov 30, 2023

Conversation

Christopher-Li
Copy link
Contributor

@Christopher-Li Christopher-Li commented Nov 9, 2023

Changelist

Update testnet endpoint

Test Plan

None

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Copy link
Contributor

coderabbitai bot commented Nov 9, 2023

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.
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.

Commits Files that changed from the base of the PR and between 9ed26bd and 75cbc6f.

Walkthrough

The 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

File Path Change Summary
.../comlink/public/api-documentation.md Base URLs for API endpoint calls have been updated from https://indexer.v4testnet.dydx.exchange/v4 to https://indexer.dydx.trade/v4 and a new base URL https://dydx-testnet.imperator.co has been added.
.../comlink/src/scripts/generate-swagger.ts The mainnet and testnet URLs for the dYdX API in the swaggerDocument.servers array have been updated. A description field has been added to both server objects.

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits Files that changed from the base of the PR and between 9ed26bd and acd82ca.
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.

@Christopher-Li Christopher-Li merged commit 7d78a89 into main Nov 30, 2023
11 checks passed
@Christopher-Li Christopher-Li deleted the cl_update_docs branch November 30, 2023 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants