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.

Sign up for GitHub

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

Jump to bottom

[Logs UI] Decouple log view HTTP API schema from saved object schema #152278

Closed
weltenwort opened this issue Feb 27, 2023 · 1 comment · Fixed by #158098
Closed

[Logs UI] Decouple log view HTTP API schema from saved object schema #152278

weltenwort opened this issue Feb 27, 2023 · 1 comment · Fixed by #158098
Assignees
@neptunian
Labels
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

Comments

@weltenwort
Copy link
Member

📓 Summary

In order to allow the browser-side code to work seamlessly across Kibana server upgrade without a page reload, we want to have fully versioned HTTP APIs that are not tied to any the internal saved object schema. To that end, we must not leak the saved object schema in HTTP requests and responses that read or write log views.

🔗 part of #149098

✔️ Acceptance criteria

  • The static and runtime types used for the saved object are distinct from those returned by the log view client both on the server and browser sides and from the HTPP API payload types.

💡 Implementation hints

  • For now this would amount to copying the type for the saved object's attributes instead of referencing the types from common. There already is a translation step in the server-side LogViewsClient, which can remain the identity until a breaking change is required.
  • The exact guidelines for implementing versioned APIs and the corresponding migrations are not defined yet, so we should keep this simple.
@weltenwort weltenwort added 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 labels Feb 27, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/infra-monitoring-ui (Team:Infra Monitoring UI)

@Kerry350 Kerry350 mentioned this issue Mar 2, 2023
Merged
@neptunian neptunian self-assigned this May 18, 2023
@neptunian neptunian mentioned this issue May 18, 2023
Merged
delanni pushed a commit to delanni/kibana that referenced this issue May 25, 2023
@neptunian @delanni
[Logs UI] Decouple log view HTTP API schema from saved object schema (e…
d35ff0a 
…lastic#158098)

Resolves elastic#152278.

Separates out the type for saved object
`infrastructure-monitoring-log-view` so the HTTP API no longer
references the same type.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@neptunian neptunian

Labels
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
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Logs UI] Decouple log view HTTP API schema from saved object schema neptunian/kibana
3 participants
@weltenwort @neptunian @elasticmachine