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 swagger #59

Merged
merged 1 commit into from
Aug 26, 2024
Merged

update swagger #59

merged 1 commit into from
Aug 26, 2024

Conversation

beer-1
Copy link
Member

@beer-1 beer-1 commented Aug 26, 2024

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features
    • Added new API endpoints for querying ACLs and module parameters.
      • GET /initia/ibchooks/v1/acls to retrieve a list of ACL entries.
      • GET /initia/ibchooks/v1/acls/{address} to retrieve a specific ACL entry.
      • GET /initia/ibchooks/v1/params to query all parameters related to the ibchooks module.
    • Enhanced API documentation with clearer parameter naming conventions and structured response types.

@beer-1 beer-1 requested a review from a team as a code owner August 26, 2024 07:33
Copy link

coderabbitai bot commented Aug 26, 2024

Walkthrough

The changes introduce new API endpoints and response structures for the ibchooks module, enhancing the API documentation and functionality. A new Swagger API endpoint entry is added to the configuration file, along with several endpoints for retrieving ACL entries and module parameters. The updates include detailed response types to ensure structured data is returned for each query.

Changes

Files Change Summary
client/docs/config.json Added Swagger API endpoint for "IBCHooks" with parameter renaming from "Params" to "IBCHooksParams".
client/docs/swagger-ui/swagger.yaml Introduced new endpoints: GET /initia/ibchooks/v1/acls, GET /initia/ibchooks/v1/acls/{address}, and GET /initia/ibchooks/v1/params. Defined new response types: QueryACLResponse, QueryACLsResponse, and QueryParamsResponse.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Database

    Client->>API: GET /initia/ibchooks/v1/acls
    API->>Database: Retrieve ACLs
    Database-->>API: Return list of ACLs
    API-->>Client: Return ACLs response

    Client->>API: GET /initia/ibchooks/v1/acls/{address}
    API->>Database: Retrieve ACL for address
    Database-->>API: Return ACL entry
    API-->>Client: Return ACL entry response

    Client->>API: GET /initia/ibchooks/v1/params
    API->>Database: Retrieve module parameters
    Database-->>API: Return parameters
    API-->>Client: Return parameters response
Loading

Poem

🐇 In fields of code, we hop with glee,
New paths unveiled, for all to see.
ACLs and params, all in a row,
With clearer names, our APIs glow!
Hooray for changes, let's dance and play,
A brighter future, hip-hip-hooray! 🌼


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

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

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.

Copy link
Contributor

@Vritra4 Vritra4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 971506e and c9e41b7.

Files selected for processing (2)
  • client/docs/config.json (1 hunks)
  • client/docs/swagger-ui/swagger.yaml (2 hunks)
Additional comments not posted (2)
client/docs/swagger-ui/swagger.yaml (1)

Line range hint 1-1: File is empty.

There are no code changes to review in this file.

client/docs/config.json (1)

149-156: LGTM!

The new entry for the ibchooks module is correctly formatted and follows the existing structure of the file.

The code changes are approved.

@beer-1 beer-1 merged commit 814c496 into main Aug 26, 2024
6 checks passed
@beer-1 beer-1 deleted the swagger branch August 26, 2024 07:39
Copy link

codecov bot commented Aug 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.17%. Comparing base (971506e) to head (c9e41b7).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #59   +/-   ##
=======================================
  Coverage   74.17%   74.17%           
=======================================
  Files          15       15           
  Lines        1460     1460           
=======================================
  Hits         1083     1083           
  Misses        328      328           
  Partials       49       49           

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants