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 V1 API #17

Open
6 tasks
Sytten opened this issue Mar 29, 2021 · 0 comments
Open
6 tasks

Document V1 API #17

Sytten opened this issue Mar 29, 2021 · 0 comments

Comments

@Sytten
Copy link
Member

Sytten commented Mar 29, 2021

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help us know what to work on
  • Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request

Description

Currently the V1 API is considered an internal implementation detail, but we want to open it up so people can build on it.
We should make it clear that we won't do breaking changes to it, but we don't promise how long it will be used either.

Steps

  • document the JSON format
  • document the compression (gzip)
  • document the auth
  • document the current limitations (reporting service is pretty dumb)
  • document the DDSketch
  • document the operation signature creation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant