diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index df325279eec0..3fb415579163 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/packages/datadog-api-client-v2/apis/WidgetsApi.ts b/packages/datadog-api-client-v2/apis/WidgetsApi.ts index 64ce9a9a40ac..bebfe79d1f62 100644 --- a/packages/datadog-api-client-v2/apis/WidgetsApi.ts +++ b/packages/datadog-api-client-v2/apis/WidgetsApi.ts @@ -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; @@ -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( diff --git a/packages/datadog-api-client-v2/models/WidgetAttributes.ts b/packages/datadog-api-client-v2/models/WidgetAttributes.ts index 08c7a665c241..fae64b75be30 100644 --- a/packages/datadog-api-client-v2/models/WidgetAttributes.ts +++ b/packages/datadog-api-client-v2/models/WidgetAttributes.ts @@ -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; /**