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

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

Merged
merged 4 commits into from
Sep 6, 2021

Conversation

gmourier
Copy link
Member

@gmourier gmourier commented Sep 2, 2021

Summary Key Points

  • Add an alternative message for invalid_sort and invalid_filter errors to handle reserved keywords.
  • invalid_criterion is renamed to invalid_ranking_rule and add an alternative message to handle reserved keywords.
  • Update invalid_geo_field error message.

Pinging @guimachiavelli for information sharing.

@irevoire
Copy link
Member

irevoire commented Sep 2, 2021

Following our discussion this is the new error message when the indexing part fails on a bad geo field:

{
    "message": "the document with the id: :docid contains an invalid _geo field: :geo_field.",
    "code": "invalid_geo_field",
    "type": "invalid_request",
    "link": "https://docs.meilisearch.com/errors#invalid_geo_field"
}

text/0059-geo-search.md Outdated Show resolved Hide resolved
@gmourier gmourier merged commit 829b0ca into develop Sep 6, 2021
@gmourier gmourier deleted the patch-geosearch-reserved-fields-expression-error branch September 6, 2021 16:19
gmourier added a commit that referenced this pull request Sep 13, 2021
…rion 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
gmourier added a commit that referenced this pull request Oct 11, 2021
…rion 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
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 gmourier added the Patch This PR patch a feature specification label Oct 13, 2021
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.

3 participants