meilisearch / meilisearch/meilisearch-ruby

[Meilisearch 1.35] Add `showPerformanceDetails` option to search endpoints

Open
#674 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Ruby
Stars
224
Forks
54
PR merge metrics
No merged PRs in 30d

Description

Description

Meilisearch v1.35.0 adds a new showPerformanceDetails option to search endpoints.

When set to true, the search response contains a performanceDetails object with the performance trace.

Important: the SDK should return the object as "raw" data and not add accessors/types. The fields of the object are subject to change in the future.

Tasks

  • Update methods for search, multi-search, and similar documents
  • Add test cases

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the SDK methods for search, multi-search, and similar documents, then inspect their existing option handling and test coverage. Add coverage for showPerformanceDetails and verify that the response exposes performanceDetails as raw data without SDK accessors or types.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.