certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Refactor swagger.json for API docs

This commit is contained in:
HaoyangLiu 2018-09-03 18:32:13 +08:00
parent 1e97074165
commit ed935181e6
3 changed files with 498 additions and 496 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
client/lcd/statik/statik.go
View File

File diff suppressed because one or more lines are too long

990
client/lcd/swaggerui/swagger.json
View File

File diff suppressed because it is too large Load Diff

2
docs/light/update_API_docs.md
View File

@ -9,7 +9,7 @@ Due to the rest handlers and related data structures are distributed in many sub
go get github.com/rakyll/statik
```
2. Edit API docs
1. Directly Edit API docs manually: `client/lcd/swaggerui/swagger.jso`
1. Directly Edit API docs manually: `client/lcd/swaggerui/swagger.json`
2. Edit API docs within this [SwaggerHub](https://app.swaggerhub.com). Please refer to this [link](https://app.swaggerhub.com/help/index) for how to use the about website to edit API docs.
3. Download `swagger.json` and replace the old `swagger.json` under `client/lcd/swaggerui` folds
4. Regenerate `client/lcd/statik/statik.go` file