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

Document HTTP endpoints in query and collector services #158

Closed
badiib opened this Issue May 12, 2017 · 5 comments

Comments

Projects
None yet
3 participants
@badiib
Contributor

badiib commented May 12, 2017

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

This comment has been minimized.

Member

yurishkuro commented Jun 16, 2017

  • update documentation in deployment.md
@pavolloffay

This comment has been minimized.

Member

pavolloffay commented Jul 4, 2017

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

This comment has been minimized.

Member

yurishkuro commented Jul 4, 2017

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

This comment has been minimized.

Member

pavolloffay commented Sep 28, 2017

@yurishkuro yurishkuro added this to the Release 1.0 milestone Oct 8, 2017

@yurishkuro

This comment has been minimized.

Member

yurishkuro commented Dec 23, 2017

Duplicate of #456

@yurishkuro yurishkuro marked this as a duplicate of #456 Dec 23, 2017

@yurishkuro yurishkuro closed this Dec 23, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment