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] Add OpenAPI doc for Dashboard routes #192875

Closed
thomasneirynck opened this issue Sep 13, 2024 · 3 comments · Fixed by #199215
Closed

[Dashboards][Docs] Add OpenAPI doc for Dashboard routes #192875

thomasneirynck opened this issue Sep 13, 2024 · 3 comments · Fixed by #199215
Assignees
@nickpeihl
Labels
Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas

Comments

@thomasneirynck
Copy link
Contributor

thomasneirynck commented Sep 13, 2024 •
edited
Loading

Add OpenAPI documentation for Dashboard-routes.

This should include the generation of public website docs.

Make sure this gets published to Kibana API docs (https://www.elastic.co/docs/api/doc/kibana)
@botelastic botelastic bot added the needs-team Issues missing a team label label Sep 13, 2024
@lukasolson lukasolson added Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas and removed needs-team Issues missing a team label labels Sep 18, 2024
@elasticmachine
Copy link
Contributor

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

@thomasneirynck
Copy link
Contributor Author

Can we omit fields from the specification?

ie. we retain the type-definition in schema-json definition, but we exclude then from the docs.

this way, we can progressively tighten the specification and leave some parts undefined (e.g. the parts that we will know will need some typing-TLC).

@nickpeihl nickpeihl mentioned this issue Nov 6, 2024
Merged
@lcawl
Copy link
Contributor

lcawl commented Dec 5, 2024

This content is now live on https://www.elastic.co/docs/api/doc/kibana/group/endpoint-dashboards and https://www.elastic.co/docs/api/doc/serverless/group/endpoint-dashboards

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nickpeihl nickpeihl

Labels
Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Dashboards][OAS] Generate API docs for Dashboards API nickpeihl/kibana
5 participants
@lukasolson @nickpeihl @thomasneirynck @elasticmachine @lcawl