Skip to content

Add missing 'filter_roles' to Search index_list#1376

Merged
sirosen merged 1 commit intoglobus:mainfrom
sirosen:search-filter-roles
Mar 20, 2026
Merged

Add missing 'filter_roles' to Search index_list#1376
sirosen merged 1 commit intoglobus:mainfrom
sirosen:search-filter-roles

Conversation

@sirosen
Copy link
Member

@sirosen sirosen commented Mar 20, 2026

This parameter was missing from SearchClient, although it was added last
year.

In terms of the client changes, this follows the patterns we have already
established for a query parameter which is a comma-delimited list. The
value type or an iterable thereof is acceptable, and our commajoin
remarshalling helper ensures proper handling. The parameter is merged in
with passthrough query params.

The valid values (since it is a string) are declared as a Literal, which
gives good typing-time assistance to developers/users but still allows
any value at runtime.

A new test for this usage is introduced, using a param class to define
test parameters in a compact manner.

This parameter was missing from SearchClient, although it was added last
year.

In terms of the client changes, this follows the patterns we have already
established for a query parameter which is a comma-delimited list. The
value type or an iterable thereof is acceptable, and our commajoin
remarshalling helper ensures proper handling. The parameter is merged in
with passthrough query params.

The valid values (since it is a string) are declared as a Literal, which
gives good typing-time assistance to developers/users but still allows
any value at runtime.

A new test for this usage is introduced, using a param class to define
test parameters in a compact manner.
@sirosen sirosen force-pushed the search-filter-roles branch from 1392131 to 352468a Compare March 20, 2026 17:15
Copy link
Contributor

@m1yag1 m1yag1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😎

@sirosen sirosen merged commit 652a522 into globus:main Mar 20, 2026
7 checks passed
@sirosen sirosen deleted the search-filter-roles branch March 20, 2026 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants