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

[Infra/Logs UI] HTTP API Documentation (replaces graphql) #38164

Closed
jasonrhodes opened this issue Jun 5, 2019 · 3 comments
Closed

[Infra/Logs UI] HTTP API Documentation (replaces graphql) #38164

jasonrhodes opened this issue Jun 5, 2019 · 3 comments
Labels
Feature:Logs UI Logs UI feature Feature:Metrics UI Metrics UI feature R&D Research and development ticket (not meant to produce code, but to make a decision) Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services technical debt Improvement of the software architecture and operational architecture

Comments

@jasonrhodes
Copy link
Member

jasonrhodes commented Jun 5, 2019

After our discussion in #36674 we have decided to move forward with replacing the GraphQL layer in both the Infra and Logs UI with a simple HTTP interface. We should start by identifying the HTTP endpoints we will need to make available, the request parameters/data they accept, and the data/format they will return.

AC:

  • Basic documentation exists for all of the HTTP endpoints we need to make available to satisfy the existing Logs and Infra UI in Kibana
    • Docs should include inputs and outputs for each endpoint, as well as a rough description of the conventions chosen for these endpoints
    • Does not need to be ASCIIDOC or part of the actual build, just basic markdown docs to spark discussion is good for now

Notes:

  • In our discussion about this plan, we mentioned that we should consider using POST for all of these endpoints in order to remove the complexity of stringifying/parsing query string parameters. We should make sure we continue to think about whether or not that introduces any problems for us down the road (@skh already mentioned the lack of native caching on POST requests, which probably isn't a big problem for us).
@jasonrhodes jasonrhodes added Feature:Metrics UI Metrics UI feature technical debt Improvement of the software architecture and operational architecture Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services R&D Research and development ticket (not meant to produce code, but to make a decision) labels Jun 5, 2019
@elasticmachine
Copy link
Contributor

Pinging @elastic/infra-logs-ui

@jasonrhodes
Copy link
Member Author

No longer needed, we've decided to move forward with migrating routes to HTTP one at a time, as necessary.

@weltenwort
Copy link
Member

Well, documenting the routes would still be beneficial. There seems to be some kind of documentation system in use for the new platform APIs. Maybe we can use that?

@zube zube bot removed the [zube]: Done label Oct 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Logs UI Logs UI feature Feature:Metrics UI Metrics UI feature R&D Research and development ticket (not meant to produce code, but to make a decision) Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services technical debt Improvement of the software architecture and operational architecture
Projects
None yet
Development

No branches or pull requests

3 participants