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

Cleanup API endpoints and rename ICSxx references on Swagger docs #4357

Closed
4 tasks
fedekunze opened this issue May 17, 2019 · 3 comments
Closed
4 tasks

Cleanup API endpoints and rename ICSxx references on Swagger docs #4357

fedekunze opened this issue May 17, 2019 · 3 comments
Assignees
Labels
T:Docs Changes and features related to documentation.

Comments

@fedekunze
Copy link
Collaborator

fedekunze commented May 17, 2019

Summary

Currently the API docs from swagger have ICS (InterChain Standards) that we haven't agreed upon. These will conflict with the real ICS in the future (cc: @cwgoes).

Proposal

Structure the endpoints categories according to the following:

  • Tendermint RPC: endpoints from https://tendermint.com/rpc that are not overwritten by others on the SDK (/tx and /tx_search)
  • Transactions: endpoints matching/txs*. Currently under ICS0
  • Misc: currently under Version
  • Auth
  • Bank: delete GET /bank/balances/{address} which is a dup from GET /auth/accounts/{address}
  • Staking: delete GET /staking/delegators/{delegatorAddr}/txs which is a dup from the tx query
  • Distribution
  • Slashing
  • Governance
  • Minting

cc: @hschoenburg @gamarin2


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@fedekunze fedekunze added T:Docs Changes and features related to documentation. API labels May 17, 2019
@cwgoes
Copy link
Contributor

cwgoes commented May 17, 2019

Thanks - yes, I think we want to restrict the "ICS" designator to specifications in the cosmos/ics repo.

@jackzampolin
Copy link
Member

This is a great comment. Going to assign @hschoenburg

@hschoenburg
Copy link
Contributor

ok I've got this PR up https://github.com/cosmos/cosmos-sdk/pull/4429/files

Note, I can't seem to build the docs to double check. The swagger.yaml file is valied YAML according to swagger.io but I can't figure out how to verify further.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

No branches or pull requests

4 participants