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

[Dashboards][Docs] Create overlay examples for Dashboards API endpoints #200097

Open
nickpeihl opened this issue Nov 13, 2024 · 1 comment
Open

[Dashboards][Docs] Create overlay examples for Dashboards API endpoints #200097

nickpeihl opened this issue Nov 13, 2024 · 1 comment
Labels
impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:medium Medium Level of Effort Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas

Comments

@nickpeihl
Copy link
Member

To avoid Bump trying to create examples from the schema in our API documentation, we should explicitly define a few examples as yaml overlays. Some endpoints have already showed how this is possible in https://github.com/elastic/kibana/tree/main/oas_docs/examples.
@nickpeihl nickpeihl added the Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas label Nov 13, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-presentation (Team:Presentation)

@Heenawter Heenawter added loe:medium Medium Level of Effort impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. labels Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:medium Medium Level of Effort Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@nickpeihl @Heenawter @elasticmachine