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

Patch GeoSearch specification to add descending order capability to _geoPoint built-in sort #77

Merged
merged 1 commit into from
Sep 21, 2021

Conversation

gmourier
Copy link
Member

We were able to find a solution to implement sorting around a _geoPoint in descending order.

The specification is updated to remove the mention of this initial limitation.

@meilisearch/docs-team FYI

Copy link
Member

@irevoire irevoire left a comment

Choose a reason for hiding this comment

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

lgtm 👍

@gmourier gmourier merged commit 8b1f3ae into develop Sep 21, 2021
@gmourier gmourier deleted the patch-geo-search-geo-point-desc-capability branch September 21, 2021 10:10
gmourier added a commit that referenced this pull request Oct 12, 2021
* Indexing NDJSONs (#29)

* initialize a draft for json lines indexation support specification

* update filename number to match related pull-request

* update specs

* update link to CSV spec

* update spec name

* Apply typos correction from code review

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

* fix typo

* update impact on documentation part

* replace file by data

* add information about giving application/json content-type or not for a json payload

* updates error codes, curl instructions

* moved behavior about missing content-type in explanation part

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

* Indexing CSVs (#28)

* Initiate csv indexation support specification

* update spec file name to match pull request id

* update csv indexation spec

* fix code examples and typos

* fix typos

* update spec name

* Update header part to match MeiliSearch Tracking-Issues

* update spec from the equivalent ndjson spec reviews

* update --data sample examples

* add information about giving application/json content-type or not for a json payload

* Apply suggestions from code review

Co-authored-by: Clément Renault <clement@meilisearch.com>

* Change curl --data param to --binary-data in examples

Co-authored-by: Clément Renault <clement@meilisearch.com>

* updates error codes

* moved behavior about missing content-type in explanation part

* Apply suggestions from code review

Co-authored-by: Clément Renault <clement@meilisearch.com>

Co-authored-by: Clément Renault <clement@meilisearch.com>

* Geosearch (#59)

* Initialize draft specification for geo-search feature

* add future possibilities

* Update specification

* mention errors and aspects about filterableAttributes and sortableAttributes

* Add measure and finalized key changes

* Add description in OpenApi

* remove old falsy sentence

* Add definition and explanation for  error

* fix rebase on develop

* Specify missing edge cases (#63)

* Initialize draft specification for geo-search feature

* add future possibilities

* Update specification

* mention errors and aspects about filterableAttributes and sortableAttributes

* Add measure and finalized key changes

* Add description in OpenApi

* remove old falsy sentence

* Add definition and explanation for  error

* fix rebase on develop

* update open-api.yml with description on _geoPoint built-in sort rule and _geo field

* Apply suggestions from code review

Co-authored-by: gui machiavelli <gui@meilisearch.com>

* remove - char in geo-search

* update invalid_geo_field error definition

Co-authored-by: gui machiavelli <gui@meilisearch.com>

* Patch GeoSearch specification to mention technical limit on `desc` ordering around a _geoPoint (#66)

* mention decision and expected behavior for a desc ordering around a geoPoint

* add desc ordering around a geoPoint as a future possibility

* Patch error codes for csv and ndjson formats specs (#64)

* specify error codes dedicated to payload format for post/put documents endpoints

* Udpdate error codes naming

* Add errors definition

* update errors and cURL examples

* Add alternative message for reserved keyword and update invalid_criterion error definition (#67)

* add alternative message for reserved keyword and update invalid_criterion error

* update error name in link field for invalid_ranking_rule error

* update invalid_geo_field error message

* fix typo

* Add future possibilities from irevoire to geosearch spec file (#74)

* add descending order capability for _geoPoint built-in sort (#77)

* Add variant message to ensure _geoPoint and _geoRadius expressions are not used as a ranking rule to help the user (#78)

* Mention the supported separator character (#81)

* Add content-type header requirements

* update bump.yml configuration

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: Clément Renault <clement@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>
gmourier added a commit that referenced this pull request Oct 13, 2021
* Patch GeoSearch specification to mention technical limit on `desc` ordering around a _geoPoint (#66)

* mention decision and expected behavior for a desc ordering around a geoPoint

* add desc ordering around a geoPoint as a future possibility

* add descending order capability for _geoPoint built-in sort (#77)

* Sort (#55)

* initialize sort specification

* wip specification body

* fix typos and details

* Add OpenAPI changes

* Rename API routes

* fix typo

* add a part about measuring success

* specify metrics to send on Amplitude

* add lexicographical order for string type

* Typos, invalid_sort error definition

* Apply suggestions from code review

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>

* remove non correct information about mistyped ranking rule that do not raise error

* fix typos from reviews

* Update text/0055-sort.md

Co-authored-by: gui machiavelli <gui@meilisearch.com>

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>

* Initialize draft specification for error object format

* reorganize and fix typos

* update oas with the new error format

* Add full list of errors

* Add invalid_geo_field error description

* Add task_not_found definition

* Add mention of error object fields order in response

* Apply suggestions from code review

Co-authored-by: gui machiavelli <gui@meilisearch.com>

* enhance the missing_primary_key error

* add know variants for message for a given error

* fix oas

* remove invalid_sort variant message for _geoPoint descending order

* fix typos

* sync new variants with geosearch error handling on ranking rule

* Update variants for invalid_filter and invalid_sort regarding geosearch

* add missing dot at the end of error message

* experiment bump.sh diff fixs

* update bump.yml

* update errors in oas

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>
@gmourier gmourier added the Patch This PR patch a feature specification label Oct 13, 2021
gmourier added a commit that referenced this pull request Nov 1, 2021
* Patch GeoSearch specification to mention technical limit on `desc` ordering around a _geoPoint (#66)

* mention decision and expected behavior for a desc ordering around a geoPoint

* add desc ordering around a geoPoint as a future possibility

* add descending order capability for _geoPoint built-in sort (#77)

* Sort (#55)

* initialize sort specification

* wip specification body

* fix typos and details

* Add OpenAPI changes

* Rename API routes

* fix typo

* add a part about measuring success

* specify metrics to send on Amplitude

* add lexicographical order for string type

* Typos, invalid_sort error definition

* Apply suggestions from code review

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>

* remove non correct information about mistyped ranking rule that do not raise error

* fix typos from reviews

* Update text/0055-sort.md

Co-authored-by: gui machiavelli <gui@meilisearch.com>

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>

* Initialize draft specification for error object format

* reorganize and fix typos

* update oas with the new error format

* Add full list of errors

* Add invalid_geo_field error description

* Add task_not_found definition

* Add mention of error object fields order in response

* Apply suggestions from code review

Co-authored-by: gui machiavelli <gui@meilisearch.com>

* enhance the missing_primary_key error

* add know variants for message for a given error

* fix oas

* remove invalid_sort variant message for _geoPoint descending order

* fix typos

* sync new variants with geosearch error handling on ranking rule

* Update variants for invalid_filter and invalid_sort regarding geosearch

* add missing dot at the end of error message

* experiment bump.sh diff fixs

* update bump.yml

* update errors in oas

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>
gmourier added a commit that referenced this pull request Nov 16, 2021
* Raise `1000` positions limit to `65535` for document attribute (#80)

* Add specification file

* fix typos

* Update text/0077-words-position-limit.md

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>

* Error Format (#61)

* Patch GeoSearch specification to mention technical limit on `desc` ordering around a _geoPoint (#66)

* mention decision and expected behavior for a desc ordering around a geoPoint

* add desc ordering around a geoPoint as a future possibility

* add descending order capability for _geoPoint built-in sort (#77)

* Sort (#55)

* initialize sort specification

* wip specification body

* fix typos and details

* Add OpenAPI changes

* Rename API routes

* fix typo

* add a part about measuring success

* specify metrics to send on Amplitude

* add lexicographical order for string type

* Typos, invalid_sort error definition

* Apply suggestions from code review

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>

* remove non correct information about mistyped ranking rule that do not raise error

* fix typos from reviews

* Update text/0055-sort.md

Co-authored-by: gui machiavelli <gui@meilisearch.com>

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>

* Initialize draft specification for error object format

* reorganize and fix typos

* update oas with the new error format

* Add full list of errors

* Add invalid_geo_field error description

* Add task_not_found definition

* Add mention of error object fields order in response

* Apply suggestions from code review

Co-authored-by: gui machiavelli <gui@meilisearch.com>

* enhance the missing_primary_key error

* add know variants for message for a given error

* fix oas

* remove invalid_sort variant message for _geoPoint descending order

* fix typos

* sync new variants with geosearch error handling on ranking rule

* Update variants for invalid_filter and invalid_sort regarding geosearch

* add missing dot at the end of error message

* experiment bump.sh diff fixs

* update bump.yml

* update errors in oas

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>

* Patch error format and messages (#87)

* Describes invalid_document_id error

* fix document_fields_limit_reached payload representation

* add backtick character for interpolated value on all error message

* Add variant for malformed_payload and add current primaryKey information on index_primary_key_already_exist error message

* update index_primary_key_already_exists error message since behavior has changed

* update index_primary_key_already_exists error message

* update payload_too_large message

* update payload_too_large message

* bump open-api file MeiliSearch version to v0.24.0

* update error examples

* Rework Analytics Stack (#84)

* Rework analytics specification

* Rephrase and fix typos

* Apply suggestions from code review

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: Irevoire <tamo@meilisearch.com>

* Add requests count on search endpoints

* Update context.app and infos

* Add an event table and a summarized Metrics/Events table views

* Rephrase aggregated metrics

* remove launched as trigger for instance system, stats, infos metrics

* Standardize metric and event descriptions (#86)

* update primary_key on aggregated events Documents Added and Documents Updated

* fix typos

* Keep native content-type

* Update text/0034-telemetry-policies.md

Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com>

* Remove usage of /tmp and use common config_dir instead

* fix typos

* fix uuid to uid

* remove stats before start_since_days

* fix order of magnitude for database_size, disk_size and ram_size

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: Irevoire <tamo@meilisearch.com>
Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com>

* Fix documentation of search `sort` query param (#91)

It seems there's a missing empty line to differentiate two call-outs in the documentation of the `sort` query parameter of the `GET` search route.

Strangely enough, the `POST` search route doesn't have this `info` call-out maybe it's an oversight?

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>
Co-authored-by: Irevoire <tamo@meilisearch.com>
Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com>
Co-authored-by: Paul B <paul+gh@bonaud.fr>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Patch This PR patch a feature specification
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants