meilisearch/MeiliSearch

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

Open

#6,293 opened on Mar 17, 2026

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)Rust (2,542 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (57,572 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Update the code sample to have matching input and output values, e.g., change the response limit to 3 or the request limit to 1.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
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