diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index df325279ee..3fb4155791 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/datadog_api_client/v2/api/widgets_api.py b/src/datadog_api_client/v2/api/widgets_api.py index 2e830c7469..c2e7c75abf 100644 --- a/src/datadog_api_client/v2/api/widgets_api.py +++ b/src/datadog_api_client/v2/api/widgets_api.py @@ -302,7 +302,17 @@ def search_widgets( ) -> WidgetListResponse: """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. :param experience_type: The experience type for the widget. :type experience_type: WidgetExperienceType @@ -316,8 +326,14 @@ def search_widgets( :type filter_title: str, optional :param filter_tags: Filter widgets by tags. Format as bracket-delimited CSV, e.g. ``[tag1,tag2]``. :type filter_tags: str, optional - :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. :type sort: str, optional :param page_number: Page number for pagination (0-indexed). :type page_number: int, optional diff --git a/src/datadog_api_client/v2/model/widget_attributes.py b/src/datadog_api_client/v2/model/widget_attributes.py index 462a6caf78..cc4efd852a 100644 --- a/src/datadog_api_client/v2/model/widget_attributes.py +++ b/src/datadog_api_client/v2/model/widget_attributes.py @@ -55,7 +55,11 @@ def __init__( :param definition: The definition of a widget, including its type and configuration. :type definition: WidgetDefinition - :param is_favorited: Will be implemented soon. Currently always returns false. + :param is_favorited: 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. :type is_favorited: bool :param modified_at: ISO 8601 timestamp of when the widget was last modified.