[datadog_dashboard] Add description field to widget definitions#3596
Open
SarthakC wants to merge 1 commit intoDataDog:masterfrom
Open
[datadog_dashboard] Add description field to widget definitions#3596SarthakC wants to merge 1 commit intoDataDog:masterfrom
SarthakC wants to merge 1 commit intoDataDog:masterfrom
Conversation
Expose the `description` attribute on all applicable dashboard widget definition types. The Datadog API stores this as an extra field in the widget definition JSON (returned as a tooltip via the widget's ? icon in the UI), which the Go client surfaces via AdditionalProperties. Fixes DataDog#3595 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #3595
The Datadog dashboard UI supports adding a description to individual widgets (shown as a tooltip on the widget's
?icon). This PR exposes that field in the Terraform provider for all applicable widget definition types.descriptioninside each widget'sdefinitionJSON object — confirmed viaGET /api/v1/dashboard/{id}. The Go API client surfaces it throughAdditionalPropertiessince it's not yet in the typed spec.getWidgetDescriptionSchema()helper returning an optionalTypeStringfieldbuildDatadog*Definition, andbuildTerraform*Definitionfor eachgroup,powerpack,split_graph) and text-only widgets (note,free_text)Example usage:
Affected widget types
alert_graph,alert_value,change,check_status,distribution,event_stream,event_timeline,geomap,heatmap,hostmap,image,list_stream,log_stream,manage_status,query_table,query_value,run_workflow,scatterplot,service_level_objective,servicemap,slo_list,timeseries,toplist,topology_map,trace_service,treemap,sunburstTest plan
datadog_dashboardwith aquery_value_definitionthat includes adescriptionterraform applysets the description on the widget in the Datadog UIterraform planshows no drift when description is set🤖 Generated with Claude Code