Expand description
Request parameter types for API queries. Request parameter types for API queries.
This module provides types for building API requests with filters, field selection, and limits. These parameters allow you to customize API responses to only include the data you need.
§Building Requests
Use RequestParams with its builder methods to construct requests:
use wme_models::RequestParams;
let params = RequestParams::new()
.field("name")
.field("url")
.filter("in_language.identifier", "en")
.filter("is_part_of.identifier", "enwiki")
.limit(5);§Filters
Filters narrow results to specific subsets. Field names use dot notation
(e.g., is_part_of.identifier). Only single-value fields can be filtered.
§Field Selection
The fields parameter specifies which fields to include. When fields are
specified, only those fields are returned (sparse fieldset). Omitting the
fields parameter returns all available fields.
§Limits
Limits restrict the number of results. Default is 3, maximum is 10. Limits only work with On-demand endpoints.
Structs§
- Filter
- Filter for API requests to narrow down results.
- Request
Params - Request parameters for API endpoints that support filtering, field selection, and limits.
Enums§
- Filter
Value - Value types that can be used in filters.