v0.28: New pagination setting

[guimachiavelli]

With v0.27, Meilisearch introduced a hardcoded limit restricting the amount of search results a query can return to 1000.

In v0.28, this harcoded limit will be a configurable index setting, pagination. pagination accepts a settings object with one field, limitedTo maxTotalHits, which accepts an integer and has a default value of 1000.

Users may update the full settings object or use the direct API route indexes/:index/settings/pagination with GET, PATCH, and DELETE endpoints.

When implementing this change in the docs, we should review the hardcoded limits from the "Known limitations" page. When doing so, we should take into account that the current text can be confusing and might not properly explain how the search results limit interacts with the limit and offset search parameters.

Reference

• spec: Settings API - Customize the hard limits for pagination and faceting specifications#157
• issue on core: Add settings to customize the maximum number of reachable documents during the search meilisearch#2495
• SME: @Kerollmops