Enable swagger in dev and staging.

[vincentwschau]

Changelist

Update the setup for dev/staging containers to enable swagger.

Test Plan

N/A

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 the PR has breaking postgres changes to the indexer add the indexer-postgres-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.

[coderabbitai]

Walkthrough

These updates introduce Swagger support for the application, allowing for enhanced API documentation and testing capabilities. This is achieved by setting a configuration flag to enable Swagger in both development and local testnet environments. Additionally, the update includes an adjustment to the timeout_commit parameter in the local testnet, extending block times to accommodate longer transactions or network delays.

Changes

File(s)	Change Summary
.../testnet-dev/dev.sh	Added Swagger support in the application configuration.
.../testnet-local/local.sh	Enabled Swagger in local testnet API configuration; increased timeout_commit.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 24259f0 and a95ea71.

Files selected for processing (2)

• protocol/testing/testnet-dev/dev.sh (1 hunks)
• protocol/testing/testnet-local/local.sh (1 hunks)

Path-based instructions used (2)

protocol/testing/testnet-local/local.sh (1)

**/**:
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

protocol/testing/testnet-dev/dev.sh (1)

**/**:
Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

Additional comments not posted (4)

protocol/testing/testnet-local/local.sh (2)

180-181: Enabling Swagger by setting .api.swagger to true is correctly implemented and aligns with the PR's objectives. Ensure that all dependent services and scripts are aware of this new configuration to avoid any unexpected behavior.

---

179-179: Consider quoting variables in shell scripts to prevent globbing and word splitting, enhancing the robustness and reliability of the script. For example, when referencing variables, use "$VARIABLE" instead of $VARIABLE.

protocol/testing/testnet-dev/dev.sh (2)

214-215: Enabling Swagger by setting .api.swagger to true is correctly implemented and aligns with the PR's objectives for the development environment. Ensure that all dependent services and scripts are aware of this new configuration to avoid any unexpected behavior.

---

213-213: Consider quoting variables in shell scripts to prevent globbing and word splitting, enhancing the robustness and reliability of the script. For example, when referencing variables, use "$VARIABLE" instead of $VARIABLE.