Fix mismatch between request and response in list indexes example by 0RBalaji · Pull Request #6315 · meilisearch/meilisearch · GitHub
Skip to content

Fix mismatch between request and response in list indexes example#6315

Open
0RBalaji wants to merge 1 commit intomeilisearch:mainfrom
0RBalaji:fix-list-indexes-example-limit
Open

Fix mismatch between request and response in list indexes example#6315
0RBalaji wants to merge 1 commit intomeilisearch:mainfrom
0RBalaji:fix-list-indexes-example-limit

Conversation

@0RBalaji
Copy link
Copy Markdown

@0RBalaji 0RBalaji commented Apr 6, 2026 •
edited
Loading

Related issue

Fixes #...

Generative AI tools

  • This PR does not use generative AI tooling
  • This PR uses generative AI tooling and respect the related policies
    • list of used tools and what they were used for

Requirements

⚠️ Ensure the following requirements before merging ⚠️

  • Automated tests have been added.
  • If some tests cannot be automated, manual rigorous tests should be applied.
  • ⚠️ If there is any change in the DB:
    • Test that any impacted DB still works as expected after using --experimental-dumpless-upgrade on a DB created with the last released Meilisearch
    • Test that during the upgrade, search is still available (artificially make the upgrade longer if needed)
    • Set the db change label.
  • If necessary, the feature have been tested in the Cloud production environment (with prototypes) and the Cloud UI is ready.
  • If necessary, the documentation related to the implemented feature in the PR is ready.
  • If necessary, the integrations related to the implemented feature in the PR are ready.

Closes #6293

This PR fixes an inconsistency in the list indexes API example where the request uses limit: 3 but the response example shows "limit": 1.

The response example has been updated to "limit": 3 so that it correctly reflects the request and pagination behavior.

Copilot AI review requested due to automatic review settings April 6, 2026 14:22
@0RBalaji 0RBalaji mentioned this pull request Apr 6, 2026
Open
Copilot AI reviewed Apr 6, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the OpenAPI/example response for the List indexes endpoint to resolve a mismatch between the documented request pagination (limit: 3) and the documented response ("limit": 1).

Changes:

  • Updated the list indexes 200-response example to return "limit": 3 to match the intended request pagination.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread crates/meilisearch/src/routes/indexes/mod.rs
Copy link

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The response example now shows "limit": 3, but the limit query parameter is still annotated with example = 1 in ListIndexes (used by OpenAPI/doc generation). This can keep request/response samples inconsistent in generated docs—consider updating the query param example to 3 (or aligning both to the same value).

Suggested change
"limit": 3,
"limit": 1,

Copilot uses AI. Check for mistakes.
@Kerollmops
Copy link
Copy Markdown
Member

Kerollmops commented Apr 9, 2026

Hey @0RBalaji 👋

I think you forgot that the JSON results must be updated accordingly, right? There is only one key in the list.

@0RBalaji 0RBalaji force-pushed the fix-list-indexes-example-limit branch from 65eb1b0 to 2fbd32d Compare April 10, 2026 14:11
@0RBalaji
Copy link
Copy Markdown
Author

0RBalaji commented Apr 10, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

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

3 participants

@0RBalaji @Kerollmops