This repository has been archived by the owner on Mar 21, 2024. It is now read-only.
Error Format #61
Merged
Error Format #61
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
added
In Progress
gmourier
force-pushed
the
update-error-object-format
branch
from
a03b3a4
to
9b725be
Compare
gmourier
force-pushed
the
update-error-object-format
branch
from
9b725be
to
a2d39b5
Compare
gmourier
force-pushed
the
update-error-object-format
branch
from
a2d39b5
to
caefa3d
Compare
gmourier
added
Ready For Review
gmourier
requested review from
bidoubiwa,
guimachiavelli,
MarinPostma and
curquiza
Merged
curquiza
approved these changes
Aug 20, 2021
gmourier
added
In Progress
|
Status changed to |
|
I've fleshed out the specification by doing a complete error cleanup and listing thanks to @Kerollmops, @MarinPostma, @irevoire and @bidoubiwa who helped to dig into it. Errors added by external specifications like ndjson, csv, geo search, and sort are also included. I have completed an overview of our known API errors which you can see here https://miro.com/app/board/o9J_l0i--Zo=/ as a mind map. |
gmourier
added
Ready For Review
Co-authored-by: gui machiavelli <gui@meilisearch.com>
gmourier
force-pushed
the
update-error-object-format
branch
from
e335c88
to
087e4f3
Compare
gmourier
force-pushed
the
update-error-object-format
branch
from
8d2b628
to
474bfba
Compare
gmourier
force-pushed
the
update-error-object-format
branch
from
474bfba
to
5016827
Compare
gmourier
force-pushed
the
update-error-object-format
branch
from
5016827
to
d3f6152
Compare
|
🚨 Breaking API change detected:
|
Specification Workflow
automation
moved this from In Progress
to Ready to be implemented
Oct 13, 2021
gmourier
added
Ready To Be Implemented
gmourier
added a commit
that referenced
this pull request
Nov 1, 2021
* 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 * add descending order capability for _geoPoint built-in sort (#77) * Sort (#55) * initialize sort specification * wip specification body * fix typos and details * Add OpenAPI changes * Rename API routes * fix typo * add a part about measuring success * specify metrics to send on Amplitude * add lexicographical order for string type * Typos, invalid_sort error definition * Apply suggestions from code review Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> * remove non correct information about mistyped ranking rule that do not raise error * fix typos from reviews * Update text/0055-sort.md Co-authored-by: gui machiavelli <gui@meilisearch.com> Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: gui machiavelli <gui@meilisearch.com> * Initialize draft specification for error object format * reorganize and fix typos * update oas with the new error format * Add full list of errors * Add invalid_geo_field error description * Add task_not_found definition * Add mention of error object fields order in response * Apply suggestions from code review Co-authored-by: gui machiavelli <gui@meilisearch.com> * enhance the missing_primary_key error * add know variants for message for a given error * fix oas * remove invalid_sort variant message for _geoPoint descending order * fix typos * sync new variants with geosearch error handling on ranking rule * Update variants for invalid_filter and invalid_sort regarding geosearch * add missing dot at the end of error message * experiment bump.sh diff fixs * update bump.yml * update errors in oas Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: gui machiavelli <gui@meilisearch.com>
gmourier
added a commit
that referenced
this pull request
Nov 16, 2021
* Raise `1000` positions limit to `65535` for document attribute (#80) * Add specification file * fix typos * Update text/0077-words-position-limit.md Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> * Error Format (#61) * 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 * add descending order capability for _geoPoint built-in sort (#77) * Sort (#55) * initialize sort specification * wip specification body * fix typos and details * Add OpenAPI changes * Rename API routes * fix typo * add a part about measuring success * specify metrics to send on Amplitude * add lexicographical order for string type * Typos, invalid_sort error definition * Apply suggestions from code review Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> * remove non correct information about mistyped ranking rule that do not raise error * fix typos from reviews * Update text/0055-sort.md Co-authored-by: gui machiavelli <gui@meilisearch.com> Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: gui machiavelli <gui@meilisearch.com> * Initialize draft specification for error object format * reorganize and fix typos * update oas with the new error format * Add full list of errors * Add invalid_geo_field error description * Add task_not_found definition * Add mention of error object fields order in response * Apply suggestions from code review Co-authored-by: gui machiavelli <gui@meilisearch.com> * enhance the missing_primary_key error * add know variants for message for a given error * fix oas * remove invalid_sort variant message for _geoPoint descending order * fix typos * sync new variants with geosearch error handling on ranking rule * Update variants for invalid_filter and invalid_sort regarding geosearch * add missing dot at the end of error message * experiment bump.sh diff fixs * update bump.yml * update errors in oas Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: gui machiavelli <gui@meilisearch.com> * Patch error format and messages (#87) * Describes invalid_document_id error * fix document_fields_limit_reached payload representation * add backtick character for interpolated value on all error message * Add variant for malformed_payload and add current primaryKey information on index_primary_key_already_exist error message * update index_primary_key_already_exists error message since behavior has changed * update index_primary_key_already_exists error message * update payload_too_large message * update payload_too_large message * bump open-api file MeiliSearch version to v0.24.0 * update error examples * Rework Analytics Stack (#84) * Rework analytics specification * Rephrase and fix typos * Apply suggestions from code review Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: Irevoire <tamo@meilisearch.com> * Add requests count on search endpoints * Update context.app and infos * Add an event table and a summarized Metrics/Events table views * Rephrase aggregated metrics * remove launched as trigger for instance system, stats, infos metrics * Standardize metric and event descriptions (#86) * update primary_key on aggregated events Documents Added and Documents Updated * fix typos * Keep native content-type * Update text/0034-telemetry-policies.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> * Remove usage of /tmp and use common config_dir instead * fix typos * fix uuid to uid * remove stats before start_since_days * fix order of magnitude for database_size, disk_size and ram_size Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: Irevoire <tamo@meilisearch.com> Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> * Fix documentation of search `sort` query param (#91) It seems there's a missing empty line to differentiate two call-outs in the documentation of the `sort` query parameter of the `GET` search route. Strangely enough, the `POST` search route doesn't have this `info` call-out maybe it's an oversight? Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: gui machiavelli <gui@meilisearch.com> Co-authored-by: Irevoire <tamo@meilisearch.com> Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> Co-authored-by: Paul B <paul+gh@bonaud.fr>
gmourier
added
Implemented
gmourier
moved this from Ready to be implemented
to Implemented
in Specification Workflow
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
The error format is updated to no longer contain unnecessary
errorprefix terms in the names of these attributes. e.g.errorType. The context is clear enough to understand that this is anerrorobject.This specification also serves as a reference point for the complete list of API errors that the user may encounter.
Summary Key Points
erroris removed from the attributes name andtypevalues.Motivation
The main motivation is to stabilize the current
errorresource to a version that conforms to our API convention and thus allows future evolutions on a more solid base. This specification avoids adding unnecessary information in the error object's attribute names.The second motivation is to describe in an exhaustive way all the errors that the user may encounter during his use of the API.