Document Governance LCD Routes

[jackzampolin]

Currently the LCD routes for governance are completely undocumented

https://github.com/cosmos/cosmos-sdk/blob/develop/x/gov/client/rest/rest.go#L27

[jackzampolin]

They might want to be added to this doc: https://github.com/cosmos/cosmos-sdk/blob/develop/docs/light/api.md but we also may want to split LCD routes up by module based on my understanding.

[fedekunze]

@jackzampolin I'm working on this with @NodeGuy through #1813, maybe we could also document those routes

[jackzampolin]

That would be awesome @fedekunze!

[fedekunze]

@jackzampolin Cool, will work on this too then !

[fedekunze]

@jackzampolin we should have one issue for LCD routes in each of the modules. Note that there's also this LCD .yaml file with this information (with is clearly outdated).
You can paste the content to Swagger editor to have a better perspective

[jackzampolin]

@fedekunze Agree on issue for each module. I'll get those opened.

On the swagger file, we should be able to generate the API docs from that if we have it updated. Why don't we just change this issue to be one to update the swagger doc?

This also raises the question weather or not each module needs it's own swagger.yaml...

Thoughts @fedekunze

[fedekunze]

@jackzampolin Agree on changing the issue and update the API docs for swagger automatically. Since we'll eventually have independent developers creating their own modules, I guess it makes sense for each of them to have it's own swagger.yaml file.

We currently have have this file for modules but it isn't included. I'd suggest for each module to have at least links to the Specs, GoDocs ( which are referred as API on the file) and Gaia-lite API (i.e LCD), as well as an overall description of the module and it's functionalities. This Modules file would be within the Cosmos documentation under the Modules section, which currently has a tutorial/walk-through (would also suggest moving that content to another section with another name).

[fedekunze]

@jackzampolin This is also related #1020

[fedekunze]

Closed by #2066