Expand description
Query parameter types for list endpoints.
Provides reusable structs for sorting, filtering, and full-text search so consumers don’t reinvent query parameter handling for every collection endpoint.
§Overview
SortDirection— ascending or descending orderSortParams— field name + directionFilterParams— field/operator/value triples for structured filteringSearchParams— full-text query with optional field scoping
Structs§
- Filter
Entry - A single filter triple:
field,operator,value. - Filter
Params - Query parameters for structured filtering on a collection endpoint.
- Search
Params - Query parameters for full-text search on a collection endpoint.
- Sort
Params - Query parameters for sorting a collection endpoint.
Enums§
- Sort
Direction - Sort order for list endpoints.