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

thanos: Expose Thanos APIs to OpenAPI/protobuf and expose on website and UIs #4102

Closed
bwplotka opened this issue Apr 23, 2021 · 8 comments
Closed

Comments

@bwplotka
Copy link
Member

In order to improve Thanos usage for users, we would like to define our APIs both HTTP and gRPC in protobuf/OpenAPI and expose those in the website. This would allow users to use tools for documentation, validation, type checking and even code generation to use our APIs efficiently. During this, we also expect collaboration with the Prometheus project to be similar on Prometheus' side. https://github.com/cncf/mentoring/blob/master/summerofcode/2021.md#port-the-prometheus-api-to-openapi.

Acceptance Criteria:

  • Define all APIs in protobuf (for consistency).
  • Use protobuf to generate code to use on our server.
  • Be able to generate OpenAPI from protobuf.
  • Define all configuration potentially in protobuf too: https://github.com/openproto/protoconfig
  • Optionally we would like to have on the index page on every Thanos component server.
@NBNARADHYA
Copy link

NBNARADHYA commented May 13, 2021

Hey guys 🙋‍♂️, I'm Nikhil.

I saw this project on the LFX Mentorship site and it needs a mentee for the project. I have applied for this project on the LFX Mentorship website and I would love to work on this ! 😃

@bwplotka
Copy link
Member Author

bwplotka commented Jun 3, 2021

Asked for some feedback on buf Slack: https://bufbuild.slack.com/archives/CRZ680FUH/p1622737333123900

@stale
Copy link

stale bot commented Aug 2, 2021

Hello 👋 Looks like there was no activity on this issue for the last two months.
Do you mind updating us on the status? Is this still reproducible or needed? If yes, just comment on this PR or push a commit. Thanks! 🤗
If there will be no activity in the next two weeks, this issue will be closed (we can always reopen an issue if we need!). Alternatively, use remind command if you wish to be reminded at some point in future.

@stale stale bot added the stale label Aug 2, 2021
@GiedriusS GiedriusS removed the stale label Aug 11, 2021
@stale
Copy link

stale bot commented Oct 11, 2021

Hello 👋 Looks like there was no activity on this issue for the last two months.
Do you mind updating us on the status? Is this still reproducible or needed? If yes, just comment on this PR or push a commit. Thanks! 🤗
If there will be no activity in the next two weeks, this issue will be closed (we can always reopen an issue if we need!). Alternatively, use remind command if you wish to be reminded at some point in future.

@stale stale bot added the stale label Oct 11, 2021
@stale
Copy link

stale bot commented Oct 30, 2021

Closing for now as promised, let us know if you need this to be reopened! 🤗

@stale
Copy link

stale bot commented Jan 9, 2022

Closing for now as promised, let us know if you need this to be reopened! 🤗

@stale stale bot closed this as completed Jan 9, 2022
@yeya24 yeya24 reopened this Jan 10, 2022
@stale stale bot removed the stale label Jan 10, 2022
@stale
Copy link

stale bot commented Apr 17, 2022

Hello 👋 Looks like there was no activity on this issue for the last two months.
Do you mind updating us on the status? Is this still reproducible or needed? If yes, just comment on this PR or push a commit. Thanks! 🤗
If there will be no activity in the next two weeks, this issue will be closed (we can always reopen an issue if we need!). Alternatively, use remind command if you wish to be reminded at some point in future.

@stale stale bot added the stale label Apr 17, 2022
@stale
Copy link

stale bot commented May 1, 2022

Closing for now as promised, let us know if you need this to be reopened! 🤗

@stale stale bot closed this as completed May 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants