[dashboards] Add new Dashboard API docs#3924
Conversation
MLaureB
left a comment
There was a problem hiding this comment.
The docs look good to me!
I have one overall suggestion: I think the Dashboards section should stand right before the Dashboard Lists section (and not at the end).
| @@ -0,0 +1,26 @@ | |||
| { | |||
| "dash": { | |||
There was a problem hiding this comment.
This is an example for the legacy timeboard API: we need to change it with the new one 🙂
There was a problem hiding this comment.
oops. Thanks for catching that.
|
@l0k0ms , so we should not remove the timeboard API doc completely as we're gonna still have a bunch of people using it who might want to refer to it, but would that be possible to only show the new |
|
@DataDog/baklava for visibility: this PR now removes the current Timeboard API endpoint doc and replaces it with the new Dashboard endpoint. It removes the current graphing/dashboard/widget/page and put it into the FAQ section for now. as a freeze. Next steps are: 1 - Create a new branch to re-introduce the timeboard API as a stand-alone page in the FAQ section in order to keep documentation available in case customers would like to refer to it. 2 - Create a new branch to create a whole widget sub-section in the graphing section that will directly implement the new widget logic, and will be an update on the current widget doc. |
|
PR to introduce the new widget section: #3948 |
Timeboard freezed doc
What does this PR do?
Adds documentation and code examples for the new
dashboardsAPI.Motivation
New API.
Preview link
https://docs-staging.datadoghq.com/rami/add_new_dashboard_api/api/#dashboards
Additional Notes
timeboardsAPI and soon will also replacescreenboardsAPI.