Multi Search API by dureuill · Pull Request #225 · meilisearch/specifications

dureuill · 2023-02-27T15:28:41Z

🤖 API Diff

Summary

Specify the new /multi-search route.

Changes

Add multi-search-api text
Update HTTP codes returned in case of index_not_found error since it triggers a 400 Bad Request in case of non-existing index in the post of multi-search
Update telemetry policies to include the information returned by multi-search
Update OpenAPI

Out Of Scope

N/A

Attention To Reviewers

I tried my best to update the OpenAPI specification, but I'm not experienced with this format nor with $ref, so I could have broken something inadervently

Misc

Update OpenAPI specification file (if needed; Apply the OpenApi label)
Update telemetry datapoints (if needed; Apply the Telemetry label)

github-actions · 2023-02-27T15:29:08Z

🤖 API change detected:

Added (1)

POST /multi-search

View documentation diff

Powered by Bump

…request/response

gmourier

Thank @dureuill, this is a first review, adding some precisions.

I've also added two errors in the listing. I'm sure about the index_not_found; can you confirm for the invalid_index_uid one? Thanks!

open-api.yaml

text/0061-error-format-and-definitions.md

text/0192-multi-search-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

dureuill · 2023-02-28T10:18:50Z

can you confirm for the invalid_index_uid one? Thanks!

yes it's in :)

open-api.yaml

text/0192-multi-search-api.md

open-api.yaml

gmourier

If it breaks the open-api validation after merging those changes, I will do a proper commit @dureuill

open-api.yaml

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

text/0192-multi-search-api.md

Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com>

text/0034-telemetry-policies.md

gmourier

Other than that double newline character, it looks great to me @dureuill Thank you! 🧱

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

bidoubiwa

🔥 LGTM 🔥

maryamsulemani97

🦢

brunoocasali · 2023-03-08T03:07:11Z

The bump diff link is not working. Is it only for me?

gmourier · 2023-03-08T07:43:32Z

The bump diff link is not working. Is it only for me?

It was working last week; I will check that asap. Thank you @brunoocasali

1458: Add multi search method of Meilisearch v1.1 r=bidoubiwa a=bidoubiwa Introduces the `client.multiSearch()` method as per the [specifications](meilisearch/specifications#225) SDK requirements: meilisearch/integration-guides#251 1459: Add facetStats type in searchResponse for MS v1.1.0 r=bidoubiwa a=bidoubiwa As per [the specification](meilisearch/specifications#224) SDK requirements: meilisearch/integration-guides#251 A new response field, `facetStats` is returned when `facets` is used in the search parameters. It contains the min max value of facets that contain numeric values. I added some test `@brunoocasali` to ensure my typing is correct Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> Co-authored-by: Charlotte Vermandel <charlottevermandel@gmail.com>

1458: Add multi search method of Meilisearch v1.1 r=bidoubiwa a=bidoubiwa Introduces the `client.multiSearch()` method as per the [specifications](meilisearch/specifications#225) SDK requirements: meilisearch/integration-guides#251 Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

* Bump API version * Metrics API — Introduce a `/metrics` route for observability / monitoring purposes (#174) * init spec for /metrics * Rename spec filename and add description for metrics * update metrics name and type col in the metrics table; add auth errors * Add --enable-metrics-route to instance-options.md specification * Precise metrics * update open-api.yml * Add telemetry instance property * Mention metrics route on stats.get action * Add action * Precise action description * Rephrase future possibility * Add MEILI_ENABLE_METRICS_ROUTE * rename all the cli parameter to the experimental variant * Update text/0174-metrics-api.md Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Update open-api.yaml Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Update text/0085-api-keys.md Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Apply suggestions from code review Co-authored-by: Tamo <tamo@meilisearch.com> --------- Co-authored-by: Tamo <tamo@meilisearch.com> * API Keys - Introduce `*` wildcard char at the last position to express access to multiple indexes starting with the same string (#189) * Bump open-api spec * Precise that the * wildcard char can be used at the last position to match multiple indexes starting with the same string * Update future possibilities * Update the index wildcard pattern error message --------- Co-authored-by: Clément Renault <clement@meilisearch.com> * Documents API — Support a csv delimiter customization (#221) * specify the support of the csv-delimiter * Apply suggestions from code review * get rid of the last 'future possibility' that is being described in this PR * Update openAPI specification --------- Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Update the geo-search spec to mention the fact that null is a valid geo field (#222) * GeoSearch — Add the `_geoBoundingBox` built-in filter (#223) * Add geoBoundingBox built-in filter description * Add missing parts * Update text/0059-geo-search.md Co-authored-by: Tamo <tamo@meilisearch.com> * Replace the top left / bottom right signature to a top right / bottom left signature --------- Co-authored-by: Tamo <tamo@meilisearch.com> * Search API — Add `facetStats` description (#224) * update search-api.md * rephrase * update open-api.yml * rephrase, add example on open-api.yml * Add examples * fix * Update text/0118-search-api.md Co-authored-by: Louis Dureuil <louis.dureuil@gmail.com> * rephrase * Clarify that facet stats are for all search results --------- Co-authored-by: Louis Dureuil <louis.dureuil@gmail.com> * Multi Search API (#225) * Add multi-search spec * Change possible HTTP return codes for index_not_found * Add multi-search to openAPI * Update telemetry * openAPI: shorter summary for multi-search * openAPI: attempt to remove superfluous "values" field in multisearch request/response * Apply review suggestions for openAPI Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Apply review suggestions for multi search API Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Add queries/results keys to openAPI examples Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * fix indent * Apply review suggestions for multi search API Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> * OpenAPI: Change summary to `Multi Search` * use backticks instead of ticks in multi search API example * Apply review suggestions for multi search API Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com> * remove superfluous newline from telemetry file Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> --------- Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com> * Add small blurb on index count / max size (#226) --------- Co-authored-by: Tamo <tamo@meilisearch.com> Co-authored-by: Clément Renault <clement@meilisearch.com> Co-authored-by: Louis Dureuil <louis.dureuil@gmail.com> Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com>

dureuill added 4 commits February 27, 2023 16:01

Add multi-search spec

b726fe5

Change possible HTTP return codes for index_not_found

c6df987

Add multi-search to openAPI

493c758

Update telemetry

b5df790

dureuill added Implemented Feature specification has been implemented. OpenAPI Update OpenAPI specification. Telemetry Update the telemetry collect. Q1:2023 labels Feb 27, 2023

dureuill requested a review from gmourier February 27, 2023 15:28

dureuill added 2 commits February 27, 2023 16:36

openAPI: shorter summary for multi-search

3bb1498

openAPI: attempt to remove superfluous "values" field in multisearch …

d496fe5

…request/response

dureuill mentioned this pull request Feb 27, 2023

Perform multiple searches in a single query meilisearch/meilisearch#3427

Closed

3 tasks

gmourier added Ready For Review Feature specification must be reviewed. v1.1.0 labels Feb 27, 2023

gmourier changed the title ~~Multi search~~ Multi Search API Feb 27, 2023

gmourier mentioned this pull request Feb 27, 2023

Release v1.1.0 #220

Merged

1 task

gmourier requested review from bidoubiwa and maryamsulemani97 February 28, 2023 09:11

gmourier suggested changes Feb 28, 2023

View reviewed changes

dureuill and others added 2 commits February 28, 2023 10:58

Apply review suggestions for openAPI

8ef6dd7

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

Apply review suggestions for multi search API

6cd7c59

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

bidoubiwa reviewed Feb 28, 2023

View reviewed changes

open-api.yaml Outdated Show resolved Hide resolved

text/0192-multi-search-api.md Outdated Show resolved Hide resolved

text/0192-multi-search-api.md Outdated Show resolved Hide resolved

text/0192-multi-search-api.md Outdated Show resolved Hide resolved

gmourier reviewed Feb 28, 2023

View reviewed changes

open-api.yaml Show resolved Hide resolved

gmourier suggested changes Feb 28, 2023

View reviewed changes

open-api.yaml Show resolved Hide resolved

open-api.yaml Outdated Show resolved Hide resolved

dureuill and others added 4 commits February 28, 2023 16:11

Add queries/results keys to openAPI examples

40d3b6f

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

fix indent

03feed4

Apply review suggestions for multi search API

858fea8

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

OpenAPI: Change summary to Multi Search

ee5a2bc

bidoubiwa suggested changes Mar 1, 2023

View reviewed changes

text/0192-multi-search-api.md Outdated Show resolved Hide resolved

use backticks instead of ticks in multi search API example

9d12bdc

maryamsulemani97 reviewed Mar 2, 2023

View reviewed changes

text/0192-multi-search-api.md Outdated Show resolved Hide resolved

text/0192-multi-search-api.md Outdated Show resolved Hide resolved

Apply review suggestions for multi search API

b92b36a

Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com>

gmourier reviewed Mar 2, 2023

View reviewed changes

text/0034-telemetry-policies.md Show resolved Hide resolved

gmourier approved these changes Mar 2, 2023

View reviewed changes

remove superfluous newline from telemetry file

f261a25

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

bidoubiwa approved these changes Mar 2, 2023

View reviewed changes

gmourier removed the Ready For Review Feature specification must be reviewed. label Mar 3, 2023

maryamsulemani97 approved these changes Mar 7, 2023

View reviewed changes

brunoocasali mentioned this pull request Mar 8, 2023

Changes regarding Meilisearch v1.1.0 meilisearch/integration-guides#251

Closed

This was referenced Mar 8, 2023

v1.1: Perform multiple searches in a single query meilisearch/documentation#2199

Closed

v1.1: Telemetry table updates meilisearch/documentation#2202

Closed

bidoubiwa mentioned this pull request Mar 15, 2023

Add multi search method of Meilisearch v1.1 meilisearch/meilisearch-js#1458

Merged

This was referenced Mar 20, 2023

Add multiple searches meilisearch/meilisearch-python#714

Merged

Add multiple searches meilisearch/meilisearch-go#422

Merged

bidoubiwa mentioned this pull request Mar 28, 2023

Add multi search method for v1.1.0 of Meilisearch meilisearch/meilisearch-rust#454

Merged

gmourier merged commit 518d005 into release-v1.1.0 Apr 3, 2023

gmourier deleted the multi-search branch April 3, 2023 14:18

bidoubiwa mentioned this pull request Apr 4, 2023

Implement multi-search method meilisearch/meilisearch-dotnet#415

Closed

Conversation

dureuill commented Feb 27, 2023 • edited by gmourier Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🤖 API Diff

Summary

Changes

Out Of Scope

Attention To Reviewers

Misc

Uh oh!

github-actions bot commented Feb 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Added (1)

Uh oh!

gmourier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dureuill commented Feb 28, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gmourier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gmourier left a comment

Choose a reason for hiding this comment

Uh oh!

bidoubiwa left a comment

Choose a reason for hiding this comment

Uh oh!

maryamsulemani97 left a comment

Choose a reason for hiding this comment

Uh oh!

brunoocasali commented Mar 8, 2023

Uh oh!

gmourier commented Mar 8, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dureuill commented Feb 27, 2023 •

edited by gmourier

Loading

github-actions bot commented Feb 27, 2023 •

edited

Loading