You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .generator/schemas/v2/openapi.yaml
+25-4Lines changed: 25 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -82785,7 +82785,12 @@ components:
82785
82785
definition:
82786
82786
$ref: "#/components/schemas/WidgetDefinition"
82787
82787
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.
82789
82794
example: false
82790
82795
type: boolean
82791
82796
modified_at:
@@ -144482,7 +144487,17 @@ paths:
144482
144487
- teams_read
144483
144488
/api/v2/widgets/{experience_type}:
144484
144489
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.
144486
144501
operationId: SearchWidgets
144487
144502
parameters:
144488
144503
- description: The experience type for the widget.
@@ -144518,8 +144533,14 @@ paths:
144518
144533
schema:
144519
144534
type: string
144520
144535
- description: |-
144521
-
Sort field for the results. Prefix with `-` for descending order.
# @option opts [Boolean] :filter_is_favorited Filter to only widgets favorited by the current user.
270
279
# @option opts [String] :filter_title Filter widgets by title (substring match).
271
280
# @option opts [String] :filter_tags Filter widgets by tags. Format as bracket-delimited CSV, e.g. `[tag1,tag2]`.
272
-
# @option opts [String] :sort Sort field for the results. Prefix with `-` for descending order. Allowed values: `title`, `created_at`, `modified_at`.
281
+
# @option opts [String] :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.
273
282
# @option opts [Integer] :page_number Page number for pagination (0-indexed).
274
283
# @option opts [Integer] :page_size Number of widgets per page.
275
284
# @return [Array<(WidgetListResponse, Integer, Hash)>] WidgetListResponse data, response status code and response headers
0 commit comments