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

[Metrics UI] Decouple source config HTTP API schema from saved object schema #152279

Closed
Tracked by #152274
weltenwort opened this issue Feb 27, 2023 · 0 comments · Fixed by #158562
Closed
Tracked by #152274

[Metrics UI] Decouple source config HTTP API schema from saved object schema #152279

weltenwort opened this issue Feb 27, 2023 · 0 comments · Fixed by #158562
Assignees
@neptunian
Labels
Feature:Metrics UI Metrics 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

weltenwort commented Feb 27, 2023 •
edited
Loading

📓 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 infra source configs.

🔗 part of #149098

✔️ Acceptance criteria

  • The static and runtime types used for the infra source saved object are distinct from those used in the HTTP API payloads.

💡 Implementation hints

  • For now this would amount to copying the type for the saved object's attributes instead of referencing the types from common. The translation step could probably 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 mentioned this issue Feb 27, 2023
Closed
2 tasks
@botelastic botelastic bot added the needs-team Issues missing a team label label Feb 27, 2023
@weltenwort weltenwort added Feature:Metrics UI Metrics 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
@botelastic botelastic bot removed the needs-team Issues missing a team label label Feb 27, 2023
@neptunian neptunian mentioned this issue Mar 2, 2023
Closed
6 tasks
@neptunian neptunian self-assigned this May 18, 2023
@neptunian neptunian mentioned this issue May 26, 2023
Merged
neptunian added a commit that referenced this issue May 30, 2023
@neptunian @kibanamachine
[Infrastructure UI] Decouple source config HTTP API schema from saved…
13806c8 
… object schema (#158562)

Resolves #152279

Separates out the type for saved object `infrastructure-ui-source` so
the HTTP API no longer references the same type.

Co-authored-by: Kibana Machine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@neptunian neptunian

Labels
Feature:Metrics UI Metrics 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.

[Infrastructure UI] Decouple source config HTTP API schema from saved object schema neptunian/kibana
2 participants
@weltenwort @neptunian