This repository has been archived by the owner on Mar 21, 2024. It is now read-only.
Documents API — Support a csv delimiter customization #221
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gmourier
changed the title
bors bot
added a commit
to meilisearch/meilisearch
that referenced
this pull request
Feb 20, 2023
3505: Csv delimiter r=irevoire a=irevoire Fixes #3442 Closes #2803 Specified in meilisearch/specifications#221 This PR is a reimplementation of #2803, on the new engine. Thanks for your idea and initial PR `@MixusMinimax;` sorry I couldn’t update/merge your PR. Way too many changes happened on the engine in the meantime. **Attention to reviewer**; I had to update deserr to implement the support of deserializing `char`s ------- It introduces four new error messages; - Invalid value in parameter csvDelimiter: expected a string of one character, but found an empty string - Invalid value in parameter csvDelimiter: expected a string of one character, but found the following string of 5 characters: doggo - csv delimiter must be an ascii character. Found: 🍰 - The Content-Type application/json does not support the use of a csv delimiter. The csv delimiter can only be used with the Content-Type text/csv. And one error code; - `invalid_index_csv_delimiter` The `invalid_content_type` error code is now also used when we encounter the `csvDelimiter` query parameter with a non-csv content type. Co-authored-by: Tamo <[email protected]>
2 tasks
gmourier
suggested changes
Feb 22, 2023
curquiza
approved these changes
Feb 22, 2023
|
📡 @irevoire I've updated the spec to replace |
gmourier
approved these changes
Feb 23, 2023
3 tasks
|
🤖 API change detected: Modified (2)
|
|
will this also be able to customize new line delimiters (instead of |
|
Hello @ahmednfwela 👋 No, it's out-of-scope for this change! If you need this customization, I invite you to share your need and use case here by creating a new discussion 🙇♂️ Thanks! |
This was referenced Mar 27, 2023
gmourier
added a commit
that referenced
this pull request
Apr 3, 2023
* Bump API version * Metrics API — Introduce a `/metrics` route for observability / monitoring purposes (#174) * init spec for /metrics * Rename spec filename and add description for metrics * update metrics name and type col in the metrics table; add auth errors * Add --enable-metrics-route to instance-options.md specification * Precise metrics * update open-api.yml * Add telemetry instance property * Mention metrics route on stats.get action * Add action * Precise action description * Rephrase future possibility * Add MEILI_ENABLE_METRICS_ROUTE * rename all the cli parameter to the experimental variant * Update text/0174-metrics-api.md Co-authored-by: Guillaume Mourier <[email protected]> * Update open-api.yaml Co-authored-by: Guillaume Mourier <[email protected]> * Update text/0085-api-keys.md Co-authored-by: Guillaume Mourier <[email protected]> * Apply suggestions from code review Co-authored-by: Tamo <[email protected]> --------- Co-authored-by: Tamo <[email protected]> * API Keys - Introduce `*` wildcard char at the last position to express access to multiple indexes starting with the same string (#189) * Bump open-api spec * Precise that the * wildcard char can be used at the last position to match multiple indexes starting with the same string * Update future possibilities * Update the index wildcard pattern error message --------- Co-authored-by: Clément Renault <[email protected]> * Documents API — Support a csv delimiter customization (#221) * specify the support of the csv-delimiter * Apply suggestions from code review * get rid of the last 'future possibility' that is being described in this PR * Update openAPI specification --------- Co-authored-by: Guillaume Mourier <[email protected]> * Update the geo-search spec to mention the fact that null is a valid geo field (#222) * GeoSearch — Add the `_geoBoundingBox` built-in filter (#223) * Add geoBoundingBox built-in filter description * Add missing parts * Update text/0059-geo-search.md Co-authored-by: Tamo <[email protected]> * Replace the top left / bottom right signature to a top right / bottom left signature --------- Co-authored-by: Tamo <[email protected]> * Search API — Add `facetStats` description (#224) * update search-api.md * rephrase * update open-api.yml * rephrase, add example on open-api.yml * Add examples * fix * Update text/0118-search-api.md Co-authored-by: Louis Dureuil <[email protected]> * rephrase * Clarify that facet stats are for all search results --------- Co-authored-by: Louis Dureuil <[email protected]> * Multi Search API (#225) * Add multi-search spec * Change possible HTTP return codes for index_not_found * Add multi-search to openAPI * Update telemetry * openAPI: shorter summary for multi-search * openAPI: attempt to remove superfluous "values" field in multisearch request/response * Apply review suggestions for openAPI Co-authored-by: Guillaume Mourier <[email protected]> * Apply review suggestions for multi search API Co-authored-by: Guillaume Mourier <[email protected]> * Add queries/results keys to openAPI examples Co-authored-by: Guillaume Mourier <[email protected]> * fix indent * Apply review suggestions for multi search API Co-authored-by: cvermand <[email protected]> * OpenAPI: Change summary to `Multi Search` * use backticks instead of ticks in multi search API example * Apply review suggestions for multi search API Co-authored-by: Maryam <[email protected]> * remove superfluous newline from telemetry file Co-authored-by: Guillaume Mourier <[email protected]> --------- Co-authored-by: Guillaume Mourier <[email protected]> Co-authored-by: cvermand <[email protected]> Co-authored-by: Maryam <[email protected]> * Add small blurb on index count / max size (#226) --------- Co-authored-by: Tamo <[email protected]> Co-authored-by: Clément Renault <[email protected]> Co-authored-by: Louis Dureuil <[email protected]> Co-authored-by: cvermand <[email protected]> Co-authored-by: Maryam <[email protected]>
This was referenced Apr 27, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Specify the usage of the new query parameter
csvDelimiterthat lets you customize the csv delimiter you wants to use in your document addition.Attention To Reviewers
Added the
primaryKeyin the OpenAPI schema as a catch upMisc
OpenApilabel)Telemetrylabel)