Skip to content

Widgets API - add complete create/update example for cloud_cost_summary #3789

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

Merged
api-clients-generation-pipeline merged 1 commit into from
May 5, 2026
+97 −14
Merged

Widgets API - add complete create/update example for cloud_cost_summary #3789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 61 additions & 6 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134587,16 +134587,45 @@ paths:
application/json:
examples:
default:
summary: CCM cost summary widget
value:
data:
attributes:
definition:
title: My Widget
type: bar_chart
graph_options:
- type: query_value
view: total
- type: query_value
view: change
- display_type: bars
type: timeseries
- type: cloud_cost_table
view: summary
requests:
- formulas:
- formula: query1
queries:
- data_source: cloud_cost
name: query1
query: sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, daily)
response_format: timeseries
time:
type: live
unit: day
value: 30
title: AWS spend by service (last 30 days)
type: cloud_cost_summary
tags: ["finops", "aws"]
type: widgets
schema:
$ref: "#/components/schemas/CreateOrUpdateWidgetRequest"
description: Widget request body.
description: |-
Widget request body. The `definition` object's required fields vary
by `widget.definition.type`: every type requires `requests`, and
some types require additional fields (e.g. `cloud_cost_summary`
requires `graph_options`, `geomap` requires `style` and `view`).
The example below shows a complete `cloud_cost_summary` payload
for the `ccm_reports` experience type.
required: true
responses:
"200":
Expand Down Expand Up @@ -134766,16 +134795,42 @@ paths:
application/json:
examples:
default:
summary: CCM cost summary widget
value:
data:
attributes:
definition:
title: My Widget
type: bar_chart
graph_options:
- type: query_value
view: total
- type: query_value
view: change
- display_type: bars
type: timeseries
- type: cloud_cost_table
view: summary
requests:
- formulas:
- formula: query1
queries:
- data_source: cloud_cost
name: query1
query: sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, daily)
response_format: timeseries
time:
type: live
unit: day
value: 30
title: AWS spend by service (last 30 days)
type: cloud_cost_summary
tags: ["finops", "aws"]
type: widgets
schema:
$ref: "#/components/schemas/CreateOrUpdateWidgetRequest"
description: Widget request body.
description: |-
Widget request body. The `definition` object's required fields vary
by `widget.definition.type`; see `CreateWidget` above for a complete
worked payload. Update is a full replacement of the widget definition.
required: true
responses:
"200":
Expand Down
44 changes: 36 additions & 8 deletions src/main/java/com/datadog/api/client/v2/api/WidgetsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,12 @@ public void setApiClient(ApiClient apiClient) {
* <p>See {@link #createWidgetWithHttpInfo}.
*
* @param experienceType The experience type for the widget. (required)
* @param body Widget request body. (required)
* @param body Widget request body. The <code>definition</code> object's required fields vary by
* <code>widget.definition.type</code>: every type requires <code>requests</code>, and some
* types require additional fields (e.g. <code>cloud_cost_summary</code> requires <code>
* graph_options</code>, <code>geomap</code> requires <code>style</code> and <code>view</code>
* ). The example below shows a complete <code>cloud_cost_summary</code> payload for the
* <code>ccm_reports</code> experience type. (required)
* @return WidgetResponse
* @throws ApiException if fails to make API call
*/
Expand All @@ -70,7 +75,12 @@ public WidgetResponse createWidget(
* <p>See {@link #createWidgetWithHttpInfoAsync}.
*
* @param experienceType The experience type for the widget. (required)
* @param body Widget request body. (required)
* @param body Widget request body. The <code>definition</code> object's required fields vary by
* <code>widget.definition.type</code>: every type requires <code>requests</code>, and some
* types require additional fields (e.g. <code>cloud_cost_summary</code> requires <code>
* graph_options</code>, <code>geomap</code> requires <code>style</code> and <code>view</code>
* ). The example below shows a complete <code>cloud_cost_summary</code> payload for the
* <code>ccm_reports</code> experience type. (required)
* @return CompletableFuture&lt;WidgetResponse&gt;
*/
public CompletableFuture<WidgetResponse> createWidgetAsync(
Expand All @@ -86,7 +96,12 @@ public CompletableFuture<WidgetResponse> createWidgetAsync(
* Create a new widget for a given experience type.
*
* @param experienceType The experience type for the widget. (required)
* @param body Widget request body. (required)
* @param body Widget request body. The <code>definition</code> object's required fields vary by
* <code>widget.definition.type</code>: every type requires <code>requests</code>, and some
* types require additional fields (e.g. <code>cloud_cost_summary</code> requires <code>
* graph_options</code>, <code>geomap</code> requires <code>style</code> and <code>view</code>
* ). The example below shows a complete <code>cloud_cost_summary</code> payload for the
* <code>ccm_reports</code> experience type. (required)
* @return ApiResponse&lt;WidgetResponse&gt;
* @throws ApiException if fails to make API call
* @http.response.details
Expand Down Expand Up @@ -149,7 +164,12 @@ public ApiResponse<WidgetResponse> createWidgetWithHttpInfo(
* <p>See {@link #createWidgetWithHttpInfo}.
*
* @param experienceType The experience type for the widget. (required)
* @param body Widget request body. (required)
* @param body Widget request body. The <code>definition</code> object's required fields vary by
* <code>widget.definition.type</code>: every type requires <code>requests</code>, and some
* types require additional fields (e.g. <code>cloud_cost_summary</code> requires <code>
* graph_options</code>, <code>geomap</code> requires <code>style</code> and <code>view</code>
* ). The example below shows a complete <code>cloud_cost_summary</code> payload for the
* <code>ccm_reports</code> experience type. (required)
* @return CompletableFuture&lt;ApiResponse&lt;WidgetResponse&gt;&gt;
*/
public CompletableFuture<ApiResponse<WidgetResponse>> createWidgetWithHttpInfoAsync(
Expand Down Expand Up @@ -859,7 +879,9 @@ public CompletableFuture<ApiResponse<WidgetListResponse>> searchWidgetsWithHttpI
*
* @param experienceType The experience type for the widget. (required)
* @param uuid The UUID of the widget. (required)
* @param body Widget request body. (required)
* @param body Widget request body. The <code>definition</code> object's required fields vary by
* <code>widget.definition.type</code>; see <code>CreateWidget</code> above for a complete
* worked payload. Update is a full replacement of the widget definition. (required)
* @return WidgetResponse
* @throws ApiException if fails to make API call
*/
Expand All @@ -876,7 +898,9 @@ public WidgetResponse updateWidget(
*
* @param experienceType The experience type for the widget. (required)
* @param uuid The UUID of the widget. (required)
* @param body Widget request body. (required)
* @param body Widget request body. The <code>definition</code> object's required fields vary by
* <code>widget.definition.type</code>; see <code>CreateWidget</code> above for a complete
* worked payload. Update is a full replacement of the widget definition. (required)
* @return CompletableFuture&lt;WidgetResponse&gt;
*/
public CompletableFuture<WidgetResponse> updateWidgetAsync(
Expand All @@ -894,7 +918,9 @@ public CompletableFuture<WidgetResponse> updateWidgetAsync(
*
* @param experienceType The experience type for the widget. (required)
* @param uuid The UUID of the widget. (required)
* @param body Widget request body. (required)
* @param body Widget request body. The <code>definition</code> object's required fields vary by
* <code>widget.definition.type</code>; see <code>CreateWidget</code> above for a complete
* worked payload. Update is a full replacement of the widget definition. (required)
* @return ApiResponse&lt;WidgetResponse&gt;
* @throws ApiException if fails to make API call
* @http.response.details
Expand Down Expand Up @@ -967,7 +993,9 @@ public ApiResponse<WidgetResponse> updateWidgetWithHttpInfo(
*
* @param experienceType The experience type for the widget. (required)
* @param uuid The UUID of the widget. (required)
* @param body Widget request body. (required)
* @param body Widget request body. The <code>definition</code> object's required fields vary by
* <code>widget.definition.type</code>; see <code>CreateWidget</code> above for a complete
* worked payload. Update is a full replacement of the widget definition. (required)
* @return CompletableFuture&lt;ApiResponse&lt;WidgetResponse&gt;&gt;
*/
public CompletableFuture<ApiResponse<WidgetResponse>> updateWidgetWithHttpInfoAsync(
Expand Down
Loading