Skip to content

Commit 6de081e

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 7e41715 of spec repo (#3486)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent d4bddfd commit 6de081e

3 files changed

Lines changed: 49 additions & 8 deletions

File tree

.generator/schemas/v2/openapi.yaml

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82785,7 +82785,12 @@ components:
8278582785
definition:
8278682786
$ref: "#/components/schemas/WidgetDefinition"
8278782787
is_favorited:
82788-
description: "Will be implemented soon. Currently always returns false."
82788+
description: |-
82789+
Whether the current user has favorited this widget. Populated on get,
82790+
batch_get, update, and search responses; create responses always return
82791+
`false` because a widget can only be favorited after it exists.
82792+
Favoriting itself is performed through the shared favorites API, not
82793+
this service.
8278982794
example: false
8279082795
type: boolean
8279182796
modified_at:
@@ -144482,7 +144487,17 @@ paths:
144482144487
- teams_read
144483144488
/api/v2/widgets/{experience_type}:
144484144489
get:
144485-
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.
144490+
description: |-
144491+
Search and list widgets for a given experience type, with filtering, sorting, and pagination.
144492+
144493+
**Response meta** carries totals scoped to the current filter:
144494+
- `filtered_total` — widgets matching the filter.
144495+
- `created_by_you_total` — among the matches, how many the current user created.
144496+
- `favorited_by_you_total` — among the matches, how many the current user has favorited.
144497+
- `created_by_anyone_total` — total widgets in the experience type, ignoring filters.
144498+
144499+
Each returned widget includes `is_favorited` reflecting the current user's favorite status.
144500+
Favoriting itself is performed through the shared favorites API, not this endpoint.
144486144501
operationId: SearchWidgets
144487144502
parameters:
144488144503
- description: The experience type for the widget.
@@ -144518,8 +144533,14 @@ paths:
144518144533
schema:
144519144534
type: string
144520144535
- description: |-
144521-
Sort field for the results. Prefix with `-` for descending order.
144522-
Allowed values: `title`, `created_at`, `modified_at`.
144536+
Sort field for the results.
144537+
144538+
**`title`, `created_at`, `modified_at`** — both ascending and descending are
144539+
supported. Use the bare field name for ascending (e.g. `sort=title`) or prefix
144540+
with `-` for descending (e.g. `sort=-modified_at`).
144541+
144542+
**`is_favorited`** — returns favorites-first ordering (favorited widgets first,
144543+
then the rest). Direction is fixed; the `-` prefix is ignored for this field.
144523144544
in: query
144524144545
name: sort
144525144546
schema:

src/datadog_api_client/v2/api/widgets_api.py

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,17 @@ def search_widgets(
302302
) -> WidgetListResponse:
303303
"""Search widgets.
304304
305-
Search and list widgets for a given experience type. Supports filtering by widget type, creator, title, and tags, as well as sorting and pagination.
305+
Search and list widgets for a given experience type, with filtering, sorting, and pagination.
306+
307+
**Response meta** carries totals scoped to the current filter:
308+
309+
* ``filtered_total`` — widgets matching the filter.
310+
* ``created_by_you_total`` — among the matches, how many the current user created.
311+
* ``favorited_by_you_total`` — among the matches, how many the current user has favorited.
312+
* ``created_by_anyone_total`` — total widgets in the experience type, ignoring filters.
313+
314+
Each returned widget includes ``is_favorited`` reflecting the current user's favorite status.
315+
Favoriting itself is performed through the shared favorites API, not this endpoint.
306316
307317
:param experience_type: The experience type for the widget.
308318
:type experience_type: WidgetExperienceType
@@ -316,8 +326,14 @@ def search_widgets(
316326
:type filter_title: str, optional
317327
:param filter_tags: Filter widgets by tags. Format as bracket-delimited CSV, e.g. ``[tag1,tag2]``.
318328
:type filter_tags: str, optional
319-
:param sort: Sort field for the results. Prefix with ``-`` for descending order.
320-
Allowed values: ``title`` , ``created_at`` , ``modified_at``.
329+
:param sort: Sort field for the results.
330+
331+
**title, created_at, modified_at** — both ascending and descending are
332+
supported. Use the bare field name for ascending (e.g. ``sort=title`` ) or prefix
333+
with ``-`` for descending (e.g. ``sort=-modified_at`` ).
334+
335+
**is_favorited** — returns favorites-first ordering (favorited widgets first,
336+
then the rest). Direction is fixed; the ``-`` prefix is ignored for this field.
321337
:type sort: str, optional
322338
:param page_number: Page number for pagination (0-indexed).
323339
:type page_number: int, optional

src/datadog_api_client/v2/model/widget_attributes.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,11 @@ def __init__(
5555
:param definition: The definition of a widget, including its type and configuration.
5656
:type definition: WidgetDefinition
5757
58-
:param is_favorited: Will be implemented soon. Currently always returns false.
58+
:param is_favorited: Whether the current user has favorited this widget. Populated on get,
59+
batch_get, update, and search responses; create responses always return
60+
``false`` because a widget can only be favorited after it exists.
61+
Favoriting itself is performed through the shared favorites API, not
62+
this service.
5963
:type is_favorited: bool
6064
6165
:param modified_at: ISO 8601 timestamp of when the widget was last modified.

0 commit comments

Comments
 (0)