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/api/datadogV2/api_widgets.go b/api/datadogV2/api_widgets.go index ec8d1928def..ffdd828321d 100644 --- a/api/datadogV2/api_widgets.go +++ b/api/datadogV2/api_widgets.go @@ -312,7 +312,16 @@ func (r *SearchWidgetsOptionalParameters) WithPageSize(pageSize int32) *SearchWi } // SearchWidgets Search widgets. -// 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. func (a *WidgetsApi) SearchWidgets(ctx _context.Context, experienceType WidgetExperienceType, o ...SearchWidgetsOptionalParameters) (WidgetListResponse, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet diff --git a/api/datadogV2/model_widget_attributes.go b/api/datadogV2/model_widget_attributes.go index f8c1d20bf22..9a0cc7f4700 100644 --- a/api/datadogV2/model_widget_attributes.go +++ b/api/datadogV2/model_widget_attributes.go @@ -16,7 +16,11 @@ type WidgetAttributes struct { CreatedAt string `json:"created_at"` // The definition of a widget, including its type and configuration. Definition WidgetDefinition `json:"definition"` - // 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 bool `json:"is_favorited"` // ISO 8601 timestamp of when the widget was last modified. ModifiedAt string `json:"modified_at"`