v0.28: Document API changes

[guimachiavelli]

v0.28 introduces three main changes to /documents.

Resource pagination

As the name implies, getting a list of documents now returns paginated results using the new parameters limit and offset. Response bodies include a results array, together with limit, offset, and total fields.

Rename attributesToRetrieve to fields

The API endpoint for getting documents attributesToRetrieve is now called fields. This is to reduce confusion with the similarly named search parameter attributesToRetrieve.

displayedAttributes

There is no longer any relationship between displayedAttributes, the index setting, and the fields returned by the documents endpoint. Previously, attributesToRetrieve (now fields) would use the displayedAttributes list by default.

References

Specs:

• general: https://github.com/meilisearch/specifications/pull/143/files
• pagination: https://github.com/meilisearch/specifications/pull/138/files
  Issue on core: Changes in the Documents resources meilisearch#2372
  SME: @curquiza, @irevoire