QA Swagger HTTP API documentation (2.1.1)

tendermint / liquidity

Cosmos SDK Liquidity module

Apache License 2.0

136 stars 56 forks source link

QA Swagger HTTP API documentation (2.1.1) #178

Open minkyraccoon opened 3 years ago

minkyraccoon commented 3 years ago

The purpose of the issue is to QA the Swagger documentation

Source code is https://github.com/tendermint/liquidity/tree/develop/proto
This is created using make proto-all call and then deployed to the Swagger hub
Documentation can be found 2.1.1#/Query/LiquidityPools harvest repo

Outcomes will include

Edits suggested via PR
Comments that will outline areas for improvements and identify
It may also include plans for remediation and how to write better documentation

dongsam commented 3 years ago

@SenorMonito @barriebyron I would appreciate it if you could review the Swagger HTTP API v2.2.0 that additionally applied Jordan's feedback I'm sorry I updated the review version.

dongsam commented 3 years ago

@barriebyron I just open PR https://github.com/tendermint/liquidity/pull/188 to get suggestions based on the source for swagger documentation QA (2.2.0)

barriebyron commented 3 years ago

First review completed https://github.com/tendermint/liquidity/pull/206