This is documentation for an unreleased version. For the latest API, see version 3.3.
Version: Next
HasItems
Structural contract for a single page of results from a paginated API endpoint.
Implementations must expose items. They may optionally expose count - the number of rows the API scanned to
produce this page, which len(items) can land below (filters drop items) or above (unwind splits one row into
several items). The iterator helpers consult count opportunistically via getattr for offset bookkeeping and
fall back to len(items) when it is absent.
Structural contract for a single page of results from a paginated API endpoint.
Implementations must expose
items. They may optionally exposecount- the number of rows the API scanned to produce this page, whichlen(items)can land below (filters drop items) or above (unwindsplits one row into several items). The iterator helpers consultcountopportunistically viagetattrfor offset bookkeeping and fall back tolen(items)when it is absent.