Skip to content
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 all APIs #428

Closed
joe-elliott opened this issue Dec 18, 2020 · 3 comments · Fixed by #721
Closed

Document all APIs #428

joe-elliott opened this issue Dec 18, 2020 · 3 comments · Fixed by #721
Assignees
Labels
type/docs Improvements or additions to documentation

Comments

@joe-elliott
Copy link
Member

Is your feature request related to a problem? Please describe.
There is no concise place where all apis are documented for Tempo. We should add this. For the various ingestion protocols we should just link to external docs. There's no reason to replicate it.

@joe-elliott joe-elliott added the type/docs Improvements or additions to documentation label Dec 18, 2020
@annanay25
Copy link
Contributor

@swartz-k
Copy link
Contributor

Does this api docs are mostly about Querier and Query-Frontend?
Show API in here Such as in Querier /querier/api/traces/{traceID} to FindTraceByID

@joe-elliott
Copy link
Member Author

This does not need to cover the APIs of the receiver shims. However, it should link to appropriate documentation where possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants