meilisearch/MeiliSearch

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

Open

#6,293 建立於 2026年3月17日

在 GitHub 查看
 (4 留言) (0 反應) (0 負責人)Rust (20,887 star) (733 fork)batch import
documentationgood first issue

描述

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.

貢獻者指南

技術棧
rustrest api
領域
documentationapi
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
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.
API reference: code samples input and output don't match · meilisearch/MeiliSearch#6293 | Good First Issue