Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

GeoSearch — Add the _geoBoundingBox built-in filter #223

Merged
merged 4 commits into from
Apr 3, 2023

Conversation

gmourier
Copy link
Member

@gmourier gmourier commented Feb 22, 2023

🤖 API Diff Put the link of the GitHub comment generated by bump.sh if generated; Apply the OpenApi label


Summary

Specify meilisearch/meilisearch#2761

Add the _geoBoundingBox([lat, lng], [lat, lng]) built-in rule to filter documents within/outside a square/rectangle shape where:

_geoBoundingBox([lat, lng] <-- top right corner coordinates, [lat, lng] <-- bottom left corner coordinates) to follow the Google / MapBox APIs coordinates for a bounding box


Changes

Explain in a clear way the changes bring by the specification; Bullet points FTW;

Out Of Scope

Explain in clear way subjects that are out of scope and shouldn't be discussed by the reviewers


Attention To Reviewers

N/A


Misc

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

@gmourier gmourier added Implemented Feature specification has been implemented. v1.1.0 Ready For Review Feature specification must be reviewed. OpenAPI Update OpenAPI specification. Telemetry Update the telemetry collect. labels Feb 22, 2023
text/0059-geo-search.md Outdated Show resolved Hide resolved
Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

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

Looks clear enough to me 👀

@gmourier gmourier removed the Ready For Review Feature specification must be reviewed. label Feb 22, 2023
@gmourier
Copy link
Member Author

gmourier commented Feb 22, 2023

📡 @meilisearch/docs-team @meilisearch/integration-team This specification is already implemented on main and reviewed if you want to prepare before entering the RC phase ✨

bors bot added a commit to meilisearch/meilisearch that referenced this pull request Mar 2, 2023
3529: Add an analytics on the geo bounding box feature r=ManyTheFish a=irevoire

Fixes #3527

[The specification of the geoBoundingBox](meilisearch/specifications#223) feature has been updated and now introduces a new analytics to follow the usage of the geoBoundingBox feature in the search requests.

Co-authored-by: Tamo <[email protected]>
bors bot added a commit to meilisearch/meilisearch-rust that referenced this pull request Mar 29, 2023
455: Add the csv_delimiter r=irevoire a=bidoubiwa

As per the specification: meilisearch/specifications#223

You can now specify a `csv_delimiter` when using `add_or_replace_unchecked_payload` and  `add_or_update_unchecked_payload`. 

If your payload is in `csv`, it is used to know how the values are separated.

Co-authored-by: Charlotte Vermandel <[email protected]>
bors bot added a commit to meilisearch/meilisearch-rust that referenced this pull request Apr 3, 2023
455: Add the csv_delimiter r=bidoubiwa a=bidoubiwa

As per the specification: meilisearch/specifications#223

You can now specify a `csv_delimiter` when using `add_or_replace_unchecked_payload` and  `add_or_update_unchecked_payload`. 

If your payload is in `csv`, it is used to know how the values are separated.

Co-authored-by: Charlotte Vermandel <[email protected]>
@gmourier gmourier merged commit 3d792cc into release-v1.1.0 Apr 3, 2023
@gmourier gmourier deleted the add-geoboundingbox-filter branch April 3, 2023 14:17
gmourier added a commit that referenced this pull request Apr 3, 2023
* 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 <[email protected]>

* Update open-api.yaml

Co-authored-by: Guillaume Mourier <[email protected]>

* Update text/0085-api-keys.md

Co-authored-by: Guillaume Mourier <[email protected]>

* Apply suggestions from code review

Co-authored-by: Tamo <[email protected]>

---------

Co-authored-by: Tamo <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>

* Replace the top left / bottom right signature to a top right / bottom left signature

---------

Co-authored-by: Tamo <[email protected]>

* 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 <[email protected]>

* rephrase

* Clarify that facet stats are for all search results

---------

Co-authored-by: Louis Dureuil <[email protected]>

* 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 <[email protected]>

* Apply review suggestions for multi search API

Co-authored-by: Guillaume Mourier <[email protected]>

* Add queries/results keys to openAPI examples

Co-authored-by: Guillaume Mourier <[email protected]>

* fix indent

* Apply review suggestions for multi search API

Co-authored-by: cvermand <[email protected]>

* 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 <[email protected]>

* remove superfluous newline from telemetry file

Co-authored-by: Guillaume Mourier <[email protected]>

---------

Co-authored-by: Guillaume Mourier <[email protected]>
Co-authored-by: cvermand <[email protected]>
Co-authored-by: Maryam <[email protected]>

* Add small blurb on index count / max size (#226)

---------

Co-authored-by: Tamo <[email protected]>
Co-authored-by: Clément Renault <[email protected]>
Co-authored-by: Louis Dureuil <[email protected]>
Co-authored-by: cvermand <[email protected]>
Co-authored-by: Maryam <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Implemented Feature specification has been implemented. OpenAPI Update OpenAPI specification. Q1:2023 Telemetry Update the telemetry collect. v1.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants