meilisearch/MeiliSearch

API reference: code samples input and output don't match

Open

#6293 opened on Mar 17, 2026

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (20,887 stars) (733 forks)batch import
documentationgood first issue

Description

I noticed the API reference code samples’ input and output don’t match, see here:

  • request has limit = 3
  • response has limit = 1

It's acceptable for this example, but it can become confusing for a less self-explanatory API example.

Contributor guide

Tech stack
rustrest api
Domain
documentationapi
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Locate the documentation file containing the API reference for this endpoint, likely in the /docs folder. Find the code sample where the request has `limit=3` and the response has `limit=1`. Change the response value to `limit=3` to match the request. Verify the fix by checking the rendered example.