Problem: gov param is outdated in swagger #1616

mmsqe · 2024-10-03T09:39:37Z

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

New Features
- Introduced a new governance API entry with updated operation IDs for improved clarity.
Improvements
- Standardized parameter naming across various APIs for consistency and better organization.

coderabbitai · 2024-10-03T09:39:48Z

Walkthrough

The changes involve updates to the client/docs/config.json file, focusing on renaming operation IDs for various API endpoints, particularly for the governance API (gov/v1). New entries have been added with parameters prefixed by GovV1, indicating a versioning change. Additionally, existing API parameters across multiple modules have been renamed for consistency and clarity, enhancing the overall organization of the API configuration.

Changes

File Path	Change Summary
client/docs/config.json	Renamed operation IDs for governance API parameters (e.g., `Params` to `GovV1Params`). New entries added for `gov/v1` API. Other API parameters updated for consistency (e.g., `Params` to `EvmParams`, `AuthParams`, etc.).

Poem

In the land of code where rabbits play,
New names hop in, brightening the day.
GovV1 leads with a cheerful cheer,
Clarity blooms, confusion disappears.
With every change, our paths align,
Hopping forward, all will be fine! 🐇✨

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

🪧 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>, please review it.
- Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
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/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

client/docs/config.json (1)
87-101: LGTM! Consider adding a comment for clarity.

The addition of the gov/v1 API entry with renamed operation IDs is well-structured and consistent with the existing naming conventions. This change effectively addresses the PR objective of updating governance parameters in Swagger.

Consider adding a brief comment above this new entry to explain the purpose of the gov/v1 API and its relationship to the existing gov/v1beta1 API. This would enhance maintainability and provide context for future developers. For example:
+    // New entry for gov/v1 API, which is an updated version of the governance API
     {
       "url": "./tmp-swagger-gen/cosmos/gov/v1/query.swagger.json",
       "operationIds": {
         "rename": {
           "Params": "GovV1Params",
           "Proposal": "GovV1Proposal",
           "Proposals": "GovV1Proposal",
           "Vote": "GovV1Vote",
           "Votes": "GovV1Votes",
           "Deposit": "GovV1Deposit",
           "Deposits": "GovV1Deposit",
           "TallyResult": "GovV1TallyResult"
         }
       }
     },

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3766e6a and 1d1a306.

📒 Files selected for processing (1)

client/docs/config.json (1 hunks)

codecov · 2024-10-03T09:48:22Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 17.73%. Comparing base (3766e6a) to head (1d1a306).
Report is 1 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (3766e6a) and HEAD (1d1a306). Click for more details.

HEAD has 12 uploads less than BASE

Flag BASE (3766e6a) HEAD (1d1a306)

2 0

integration_tests 20 10

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #1616       +/-   ##
===========================================
- Coverage   36.88%   17.73%   -19.15%     
===========================================
  Files         102       72       -30     
  Lines        8055     5204     -2851     
===========================================
- Hits         2971      923     -2048     
+ Misses       4706     4158      -548     
+ Partials      378      123      -255

see 47 files with indirect coverage changes

Problem: gov param is outdated in swagger

1d1a306

mmsqe requested a review from a team as a code owner October 3, 2024 09:39

mmsqe requested review from calvinaco and devashishdxt and removed request for a team October 3, 2024 09:39

coderabbitai bot reviewed Oct 3, 2024

View reviewed changes

yihuang approved these changes Oct 3, 2024

View reviewed changes

mmsqe added this pull request to the merge queue Oct 3, 2024

Merged via the queue into crypto-org-chain:main with commit 2685ed7 Oct 3, 2024
34 of 35 checks passed

coderabbitai bot mentioned this pull request Oct 14, 2024

Problem: cosmos-sdk x/tx not up to date #1638

Merged

13 tasks

This was referenced Oct 23, 2024

Problem: attributes for ibc timeout event are not aligned #1663

Merged

Problem: v1.4.0-rc2 is not released #1661

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Problem: gov param is outdated in swagger #1616

Problem: gov param is outdated in swagger #1616

mmsqe commented Oct 3, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 3, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

codecov bot commented Oct 3, 2024 •

edited

Loading

Problem: gov param is outdated in swagger #1616

Problem: gov param is outdated in swagger #1616

Conversation

mmsqe commented Oct 3, 2024 • edited by coderabbitai bot Loading

PR Checklist:

Summary by CodeRabbit

coderabbitai bot commented Oct 3, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 3, 2024 • edited Loading

Codecov Report

mmsqe commented Oct 3, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 3, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Oct 3, 2024 •

edited

Loading