diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index df325279eec..3fb41557916 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -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: @@ -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. @@ -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: diff --git a/src/main/java/com/datadog/api/client/v2/api/WidgetsApi.java b/src/main/java/com/datadog/api/client/v2/api/WidgetsApi.java index 151b1205376..720979455e2 100644 --- a/src/main/java/com/datadog/api/client/v2/api/WidgetsApi.java +++ b/src/main/java/com/datadog/api/client/v2/api/WidgetsApi.java @@ -618,8 +618,12 @@ public SearchWidgetsOptionalParameters filterTags(String filterTags) { /** * Set sort. * - * @param sort Sort field for the results. Prefix with - for descending order. - * Allowed values: title, created_at, modified_at. + * @param sort 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. * (optional, default to "-modified_at") * @return SearchWidgetsOptionalParameters */ @@ -717,8 +721,17 @@ public CompletableFuture searchWidgetsAsync( } /** - * 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 experienceType The experience type for the widget. (required) * @param parameters Optional parameters for the request. diff --git a/src/main/java/com/datadog/api/client/v2/model/WidgetAttributes.java b/src/main/java/com/datadog/api/client/v2/model/WidgetAttributes.java index b7f0c9cbf2e..e1da3cb9492 100644 --- a/src/main/java/com/datadog/api/client/v2/model/WidgetAttributes.java +++ b/src/main/java/com/datadog/api/client/v2/model/WidgetAttributes.java @@ -111,7 +111,10 @@ public WidgetAttributes isFavorited(Boolean isFavorited) { } /** - * 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. * * @return isFavorited */