Skip to content

Commit 5660c7b

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 7e41715 of spec repo
1 parent 421fce0 commit 5660c7b

3 files changed

Lines changed: 48 additions & 8 deletions

File tree

.generator/schemas/v2/openapi.yaml

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82741,7 +82741,12 @@ components:
8274182741
definition:
8274282742
$ref: "#/components/schemas/WidgetDefinition"
8274382743
is_favorited:
82744-
description: "Will be implemented soon. Currently always returns false."
82744+
description: |-
82745+
Whether the current user has favorited this widget. Populated on get,
82746+
batch_get, update, and search responses; create responses always return
82747+
`false` because a widget can only be favorited after it exists.
82748+
Favoriting itself is performed through the shared favorites API, not
82749+
this service.
8274582750
example: false
8274682751
type: boolean
8274782752
modified_at:
@@ -134588,7 +134593,17 @@ paths:
134588134593
- teams_read
134589134594
/api/v2/widgets/{experience_type}:
134590134595
get:
134591-
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.
134596+
description: |-
134597+
Search and list widgets for a given experience type, with filtering, sorting, and pagination.
134598+
134599+
**Response meta** carries totals scoped to the current filter:
134600+
- `filtered_total` — widgets matching the filter.
134601+
- `created_by_you_total` — among the matches, how many the current user created.
134602+
- `favorited_by_you_total` — among the matches, how many the current user has favorited.
134603+
- `created_by_anyone_total` — total widgets in the experience type, ignoring filters.
134604+
134605+
Each returned widget includes `is_favorited` reflecting the current user's favorite status.
134606+
Favoriting itself is performed through the shared favorites API, not this endpoint.
134592134607
operationId: SearchWidgets
134593134608
parameters:
134594134609
- description: The experience type for the widget.
@@ -134624,8 +134639,14 @@ paths:
134624134639
schema:
134625134640
type: string
134626134641
- description: |-
134627-
Sort field for the results. Prefix with `-` for descending order.
134628-
Allowed values: `title`, `created_at`, `modified_at`.
134642+
Sort field for the results.
134643+
134644+
**`title`, `created_at`, `modified_at`** — both ascending and descending are
134645+
supported. Use the bare field name for ascending (e.g. `sort=title`) or prefix
134646+
with `-` for descending (e.g. `sort=-modified_at`).
134647+
134648+
**`is_favorited`** — returns favorites-first ordering (favorited widgets first,
134649+
then the rest). Direction is fixed; the `-` prefix is ignored for this field.
134629134650
in: query
134630134651
name: sort
134631134652
schema:

services/widgets/src/v2/WidgetsApi.ts

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -737,8 +737,14 @@ export interface WidgetsApiSearchWidgetsRequest {
737737
*/
738738
filterTags?: string;
739739
/**
740-
* Sort field for the results. Prefix with `-` for descending order.
741-
* Allowed values: `title`, `created_at`, `modified_at`.
740+
* Sort field for the results.
741+
*
742+
* **`title`, `created_at`, `modified_at`** — both ascending and descending are
743+
* supported. Use the bare field name for ascending (e.g. `sort=title`) or prefix
744+
* with `-` for descending (e.g. `sort=-modified_at`).
745+
*
746+
* **`is_favorited`** — returns favorites-first ordering (favorited widgets first,
747+
* then the rest). Direction is fixed; the `-` prefix is ignored for this field.
742748
* @type string
743749
*/
744750
sort?: string;
@@ -860,7 +866,16 @@ export class WidgetsApi {
860866
}
861867

862868
/**
863-
* Search and list widgets for a given experience type. Supports filtering by widget type, creator, title, and tags, as well as sorting and pagination.
869+
* Search and list widgets for a given experience type, with filtering, sorting, and pagination.
870+
*
871+
* **Response meta** carries totals scoped to the current filter:
872+
* - `filtered_total` — widgets matching the filter.
873+
* - `created_by_you_total` — among the matches, how many the current user created.
874+
* - `favorited_by_you_total` — among the matches, how many the current user has favorited.
875+
* - `created_by_anyone_total` — total widgets in the experience type, ignoring filters.
876+
*
877+
* Each returned widget includes `is_favorited` reflecting the current user's favorite status.
878+
* Favoriting itself is performed through the shared favorites API, not this endpoint.
864879
* @param param The request object
865880
*/
866881
public searchWidgets(

services/widgets/src/v2/models/WidgetAttributes.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@ export class WidgetAttributes {
1515
*/
1616
"definition": WidgetDefinition;
1717
/**
18-
* Will be implemented soon. Currently always returns false.
18+
* Whether the current user has favorited this widget. Populated on get,
19+
* batch_get, update, and search responses; create responses always return
20+
* `false` because a widget can only be favorited after it exists.
21+
* Favoriting itself is performed through the shared favorites API, not
22+
* this service.
1923
*/
2024
"isFavorited": boolean;
2125
/**

0 commit comments

Comments
 (0)