Library Elements: Deprecate folderFilter query param; update docs for folderFilterUIDs (#116048)

This commit is contained in:
Stephanie Hingtgen
2026-01-09 04:24:18 -07:00
committed by GitHub
parent b0785e506f
commit 0cf4f7c4de
5 changed files with 29 additions and 4 deletions
@@ -41,7 +41,8 @@ Query parameters:
- `sortDirection`: Sort order of elements. Use `alpha-asc` for ascending and `alpha-desc` for descending sort order.
- `typeFilter`: A comma separated list of types to filter the elements by.
- `excludeUid`: Element UID to exclude from search results.
- `folderFilter`: A comma separated list of folder IDs to filter the elements by.
- `folderFilter`: **Deprecated.** A comma separated list of folder IDs to filter the elements by. Use `folderFilterUIDs` instead.
- `folderFilterUIDs`: A comma separated list of folder UIDs to filter the elements by.
- `perPage`: The number of results per page; default is 100.
- `page`: The page for a set of records, given that only `perPage` records are returned at a time. Numbering starts at `1`.
@@ -1021,6 +1021,7 @@ const injectedRtkApi = api
typeFilter: queryArg.typeFilter,
excludeUid: queryArg.excludeUid,
folderFilter: queryArg.folderFilter,
folderFilterUIDs: queryArg.folderFilterUiDs,
perPage: queryArg.perPage,
page: queryArg.page,
},
@@ -2915,8 +2916,11 @@ export type GetLibraryElementsApiArg = {
typeFilter?: string;
/** Element UID to exclude from search results. */
excludeUid?: string;
/** A comma separated list of folder ID(s) to filter the elements by. */
/** A comma separated list of folder ID(s) to filter the elements by.
Deprecated: Use FolderFilterUIDs instead. */
folderFilter?: string;
/** A comma separated list of folder UID(s) to filter the elements by. */
folderFilterUiDs?: string;
/** The number of results per page. */
perPage?: number;
/** The page for a set of records, given that only perPage records are returned at a time. Numbering starts at 1. */
+6
View File
@@ -501,9 +501,15 @@ type GetLibraryElementsParams struct {
// required:false
ExcludeUID string `json:"excludeUid"`
// A comma separated list of folder ID(s) to filter the elements by.
// Deprecated: Use FolderFilterUIDs instead.
// in:query
// required:false
// deprecated:true
FolderFilter string `json:"folderFilter"`
// A comma separated list of folder UID(s) to filter the elements by.
// in:query
// required:false
FolderFilterUIDs string `json:"folderFilterUIDs"`
// The number of results per page.
// in:query
// required:false
+7 -1
View File
@@ -6167,10 +6167,16 @@
},
{
"type": "string",
"description": "A comma separated list of folder ID(s) to filter the elements by.",
"description": "A comma separated list of folder ID(s) to filter the elements by.\nDeprecated: Use FolderFilterUIDs instead.",
"name": "folderFilter",
"in": "query"
},
{
"type": "string",
"description": "A comma separated list of folder UID(s) to filter the elements by.",
"name": "folderFilterUIDs",
"in": "query"
},
{
"type": "integer",
"format": "int64",
+9 -1
View File
@@ -20721,13 +20721,21 @@
}
},
{
"description": "A comma separated list of folder ID(s) to filter the elements by.",
"description": "A comma separated list of folder ID(s) to filter the elements by.\nDeprecated: Use FolderFilterUIDs instead.",
"in": "query",
"name": "folderFilter",
"schema": {
"type": "string"
}
},
{
"description": "A comma separated list of folder UID(s) to filter the elements by.",
"in": "query",
"name": "folderFilterUIDs",
"schema": {
"type": "string"
}
},
{
"description": "The number of results per page.",
"in": "query",