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

docs: cli + api #15

Merged
merged 5 commits into from
Jul 24, 2023
Merged

docs: cli + api #15

merged 5 commits into from
Jul 24, 2023

Conversation

zsystm
Copy link

@zsystm zsystm commented Jul 23, 2023

Description

  • Closes: docs: add api, cli docs #11
  • fix redundant restful path
    • before: /canto/liquidstaking/v1/chunks/redelegation_infos
    • after: /canto/liquidstaking/v1/redelegation_infos

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

  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • included the necessary unit and integration tests
  • reviewed "Files changed" and left comments if necessary

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 all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@zsystm zsystm self-assigned this Jul 23, 2023
@zsystm zsystm requested review from dongsam and poorphd July 23, 2023 08:09
docs/api/liquidstaking.md Outdated Show resolved Hide resolved
docs/api/liquidstaking.md Outdated Show resolved Hide resolved
docs/cli/liquidstaking.md Outdated Show resolved Hide resolved
@poorphd poorphd self-requested a review July 24, 2023 01:45
* unify format
* reduce huge response
Copy link

@poorphd poorphd left a comment

Choose a reason for hiding this comment

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

LGTM

@zsystm
Copy link
Author

zsystm commented Jul 24, 2023

@dongsam
Could you review my PR?

@zsystm zsystm merged commit cd670b1 into liquidstaking-module Jul 24, 2023
9 checks passed
zsystm added a commit that referenced this pull request Jul 24, 2023
* add api docs and fix duplicate restful path

* complete api and cli docs

* chore: fix link

* apply feedback

* unify format
* reduce huge response

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

Successfully merging this pull request may close these issues.

docs: add api, cli docs
3 participants