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

Patch error codes for csv and ndjson formats specs #64

Merged

Conversation

gmourier
Copy link
Member

@gmourier gmourier commented Aug 22, 2021

On closer inspection, the previous error definitions for the first iteration of the specifications are insufficient.

This patch adds a more detailed error definitions concerning content-type and request body payload for POST/PUT routes for the indexes/:index_uid/documents endpoint

@gmourier gmourier changed the title Patch error codes for csv and ndjson specifications Patch error codes for csv and ndjson formats specs Aug 22, 2021
@curquiza curquiza self-requested a review August 25, 2021 10:30
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.

Thanks for the update 👍

text/0028-indexing-csv.md Show resolved Hide resolved
text/0028-indexing-csv.md Show resolved Hide resolved
text/0028-indexing-csv.md Outdated Show resolved Hide resolved
@gmourier gmourier force-pushed the specify-error-codes-post-put-documents-payload-format branch from 2983cb6 to fd68f8b Compare August 26, 2021 12:56
text/0028-indexing-csv.md Show resolved Hide resolved
text/0028-indexing-csv.md Show resolved Hide resolved
@gmourier gmourier requested a review from curquiza August 31, 2021 11:55
@gmourier gmourier merged commit de21afe into develop Aug 31, 2021
@gmourier gmourier deleted the specify-error-codes-post-put-documents-payload-format branch August 31, 2021 15:07
gmourier added a commit that referenced this pull request Sep 13, 2021
* specify error codes dedicated to payload format for post/put documents endpoints

* Udpdate error codes naming

* Add errors definition

* update errors and cURL examples
gmourier added a commit that referenced this pull request Oct 11, 2021
* specify error codes dedicated to payload format for post/put documents endpoints

* Udpdate error codes naming

* Add errors definition

* update errors and cURL examples
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.

4 participants