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

Conversation

@gmourier
Copy link
Member

@gmourier gmourier commented Apr 12, 2021

The goal of this PR is to specify NDJSON indexing.

@gmourier gmourier marked this pull request as draft April 12, 2021 09:54
@gmourier gmourier added the Draft Feature specification is in draft state. Summary and Motivation parts need to be written. label Apr 12, 2021
@gmourier gmourier changed the title JSON Lines Indexation NDJSON Support Apr 15, 2021
@gmourier gmourier marked this pull request as ready for review April 15, 2021 09:27
@gmourier gmourier added Ready For Review Feature specification must be reviewed. and removed Draft Feature specification is in draft state. Summary and Motivation parts need to be written. labels Apr 15, 2021
@gmourier gmourier changed the title NDJSON Support Indexing NDJSONs Apr 16, 2021
Copy link
Contributor

@bidoubiwa bidoubiwa left a 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).

@gmourier
Copy link
Member Author

I've updated this specification regarding similar points from @Kerollmops review on CSV file support.


### 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.
Copy link
Member

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.

Copy link
Member Author

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!

@gmourier gmourier merged commit e813afb into main Jun 10, 2021
@gmourier gmourier deleted the json-lines-support branch June 10, 2021 07:54
@gmourier gmourier added Ready To Be Implemented Feature specification is ready to be implemented. Missing Tracking-Issue and removed Ready For Review Feature specification must be reviewed. Ready To Be Implemented Feature specification is ready to be implemented. labels Jun 10, 2021
gmourier added a commit that referenced this pull request Aug 17, 2021
* 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]>
gmourier added a commit that referenced this pull request Aug 17, 2021
* 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]>
gmourier added a commit that referenced this pull request Sep 13, 2021
* 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]>
@gmourier gmourier added v0.23 Ready To Be Implemented Feature specification is ready to be implemented. and removed Missing Tracking-Issue labels Sep 15, 2021
gmourier added a commit that referenced this pull request Oct 11, 2021
* 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]>
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 <[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]>
@gmourier gmourier added Implemented Feature specification has been implemented. and removed Ready To Be Implemented Feature specification is ready to be implemented. labels Oct 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Implemented Feature specification has been implemented. Q3:2021 v0.23

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants