-
Notifications
You must be signed in to change notification settings - Fork 11
Indexing NDJSONs #29
Indexing NDJSONs #29
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed it in some places but then realise it was used everywhere. I suggest changing the wording ndjson file to ndjson body. As file sending implies 'Multiple-form-data' as a content-type.
But what we send is a text-body in a given format (in this case ndjson).
Co-authored-by: cvermand <[email protected]>
|
I've updated this specification regarding similar points from @Kerollmops review on CSV file support. |
text/0029-indexing-ndjson.md
Outdated
|
|
||
| ### I. Technical details | ||
|
|
||
| ⚠ A missing Content-Type will be interpreted as `application/json` since it's the current behavior. Giving an `application/json` Content-Type leads to the same behavior. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it a technical detail? The users and the documentation should be aware of this. Technical details are for internal implementation from my POV.
This information is as important as any information in Explanation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice point @curquiza. I will update the specification according to this feedback!
* 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 <[email protected]> * 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 <[email protected]>
* 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 <[email protected]> * 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 <[email protected]>
* 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 <[email protected]> * 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 <[email protected]>
* 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 <[email protected]> * 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 <[email protected]>
* 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * Change curl --data param to --binary-data in examples Co-authored-by: Clément Renault <[email protected]> * updates error codes * moved behavior about missing content-type in explanation part * Apply suggestions from code review Co-authored-by: Clément Renault <[email protected]> Co-authored-by: Clément Renault <[email protected]> * 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 <[email protected]> * remove - char in geo-search * update invalid_geo_field error definition Co-authored-by: gui machiavelli <[email protected]> * 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 <[email protected]> Co-authored-by: Clément Renault <[email protected]> Co-authored-by: gui machiavelli <[email protected]>
The goal of this PR is to specify NDJSON indexing.