Document HTTP endpoints in query and collector services

[badiib]

We don't really define our API anywhere, and we should do so. This is probably a good issue to bring up the idea of using swagger for self-documentation.

[yurishkuro]

• update documentation in deployment.md

[pavolloffay]

Do you have any preference for the framework? What is the most used/mature one in Go?

I found this https://github.com/go-swagger/go-swagger

[yurishkuro]

When you say framework, it implies not just documenting but refactoring the endpoints to use that framework so that documentation and code are in sync. I'd agree swagger is the way to go. However, we first need to investigate how it will work with graphql, because we certainly need graphql to streamline interactions with UI. I don't know if graphql frameworks also help with auto documenting the API.

[pavolloffay]

Related discussion https://groups.google.com/forum/#!topic/jaeger-tracing/L27aTD9kXRc

[yurishkuro]

Duplicate of #456