Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 25 additions & 4 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -82741,7 +82741,12 @@ components:
definition:
$ref: "#/components/schemas/WidgetDefinition"
is_favorited:
description: "Will be implemented soon. Currently always returns false."
description: |-
Whether the current user has favorited this widget. Populated on get,
batch_get, update, and search responses; create responses always return
`false` because a widget can only be favorited after it exists.
Favoriting itself is performed through the shared favorites API, not
this service.
example: false
type: boolean
modified_at:
Expand Down Expand Up @@ -134588,7 +134593,17 @@ paths:
- teams_read
/api/v2/widgets/{experience_type}:
get:
description: Search and list widgets for a given experience type. Supports filtering by widget type, creator, title, and tags, as well as sorting and pagination.
description: |-
Search and list widgets for a given experience type, with filtering, sorting, and pagination.

**Response meta** carries totals scoped to the current filter:
- `filtered_total` — widgets matching the filter.
- `created_by_you_total` — among the matches, how many the current user created.
- `favorited_by_you_total` — among the matches, how many the current user has favorited.
- `created_by_anyone_total` — total widgets in the experience type, ignoring filters.

Each returned widget includes `is_favorited` reflecting the current user's favorite status.
Favoriting itself is performed through the shared favorites API, not this endpoint.
operationId: SearchWidgets
parameters:
- description: The experience type for the widget.
Expand Down Expand Up @@ -134624,8 +134639,14 @@ paths:
schema:
type: string
- description: |-
Sort field for the results. Prefix with `-` for descending order.
Allowed values: `title`, `created_at`, `modified_at`.
Sort field for the results.

**`title`, `created_at`, `modified_at`** — both ascending and descending are
supported. Use the bare field name for ascending (e.g. `sort=title`) or prefix
with `-` for descending (e.g. `sort=-modified_at`).

**`is_favorited`** — returns favorites-first ordering (favorited widgets first,
then the rest). Direction is fixed; the `-` prefix is ignored for this field.
in: query
name: sort
schema:
Expand Down
21 changes: 18 additions & 3 deletions packages/datadog-api-client-v2/apis/WidgetsApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -683,8 +683,14 @@ export interface WidgetsApiSearchWidgetsRequest {
*/
filterTags?: string;
/**
* Sort field for the results. Prefix with `-` for descending order.
* Allowed values: `title`, `created_at`, `modified_at`.
* Sort field for the results.
*
* **`title`, `created_at`, `modified_at`** — both ascending and descending are
* supported. Use the bare field name for ascending (e.g. `sort=title`) or prefix
* with `-` for descending (e.g. `sort=-modified_at`).
*
* **`is_favorited`** — returns favorites-first ordering (favorited widgets first,
* then the rest). Direction is fixed; the `-` prefix is ignored for this field.
* @type string
*/
sort?: string;
Expand Down Expand Up @@ -804,7 +810,16 @@ export class WidgetsApi {
}

/**
* Search and list widgets for a given experience type. Supports filtering by widget type, creator, title, and tags, as well as sorting and pagination.
* Search and list widgets for a given experience type, with filtering, sorting, and pagination.
*
* **Response meta** carries totals scoped to the current filter:
* - `filtered_total` — widgets matching the filter.
* - `created_by_you_total` — among the matches, how many the current user created.
* - `favorited_by_you_total` — among the matches, how many the current user has favorited.
* - `created_by_anyone_total` — total widgets in the experience type, ignoring filters.
*
* Each returned widget includes `is_favorited` reflecting the current user's favorite status.
* Favoriting itself is performed through the shared favorites API, not this endpoint.
* @param param The request object
*/
public searchWidgets(
Expand Down
6 changes: 5 additions & 1 deletion packages/datadog-api-client-v2/models/WidgetAttributes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ export class WidgetAttributes {
*/
"definition": WidgetDefinition;
/**
* Will be implemented soon. Currently always returns false.
* Whether the current user has favorited this widget. Populated on get,
* batch_get, update, and search responses; create responses always return
* `false` because a widget can only be favorited after it exists.
* Favoriting itself is performed through the shared favorites API, not
* this service.
*/
"isFavorited": boolean;
/**
Expand Down
Loading