Documentation for error codes #421

MarinPostma · 2020-06-22T12:05:31Z

errors.yaml

curquiza · 2020-06-23T09:47:31Z

errors.yaml

+    description: "There was an error in the search."
+  - code: unsupported_media_type
+    description: "The payload for the request is not supported by meilisearch. Meilisearch currently only support JSON payloads."
+...


Is this PR ready for review?

it's open for discussion

Does it mean there are missing information?

No all error codes are here, but we can discuss the descriptions

curquiza · 2020-06-23T10:07:40Z

errors.yaml

+  - code: open_index
+    description: "An error occured while trying to open the requested index, ..."
+  - code: invalid_state
+    description: "An error occuring when the database is in an invalid state. Deleting the database and reindexing should solve the problem."


Suggested change

description: "An error occuring when the database is in an invalid state. Deleting the database and reindexing should solve the problem."

description: "An error occurred when the database is in an invalid state. Deleting the database and reindexing should solve the problem."

curquiza · 2020-06-23T10:07:52Z

errors.yaml

+  - code: invalid_index_uid
+    description: "The provided index formatting is wrong, check out our guide on [index creation](link.com)"
+  - code: open_index
+    description: "An error occured while trying to open the requested index, ..."


Suggested change

description: "An error occured while trying to open the requested index, ..."

description: "An error occurred while trying to open the requested index, ..."

Don't have any idea to complete the ...

Also, I don't think it is clear what "opening" an index means

curquiza · 2020-06-23T10:08:38Z

errors.yaml

+    description: "All documents must be identified with a unique key. Meilisearch will try to infer the documetn field to use as primary key. If it can't, it has to be specified manually, and this error is returned. See <a href=\"https://docs.meilisearch.com/guides/main_concepts/documents.html#structure\">guide on primary keys</a>."
+  - code: primary_key_already_present
+    description: "Error thrown when trying to change the primary key for an index. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."
+  - code: max_field_limit_exceeded


Suggested change

- code: max_field_limit_exceeded

- code: max_fields_limit_exceeded

curquiza · 2020-06-23T10:08:55Z

errors.yaml

+  - code: primary_key_already_present
+    description: "Error thrown when trying to change the primary key for an index. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."
+  - code: max_field_limit_exceeded
+    description: "The maximum number of fields for a document is 65,535. When this number is exceded, this error is returned."


Suggested change

description: "The maximum number of fields for a document is 65,535. When this number is exceded, this error is returned."

description: "The maximum number of fields for a document is 65,535. When this number is exceeded, this error is returned."

curquiza · 2020-06-23T10:11:37Z

errors.yaml

+  - code: document_not_found
+    description: "The requested document can't be retieved. It either doesn't exists, or the database was left in an inconsistent state."
+  - code: internal
+    description: "An error with Meilisearch internals has occured. Check the error message, and fill an issue if necessary."


Suggested change

description: "An error with Meilisearch internals has occured. Check the error message, and fill an issue if necessary."

description: "An error with MeiliSearch internals has occurred. Check the error message, and open an issue if necessary."

Suggested change

description: "An error with Meilisearch internals has occured. Check the error message, and fill an issue if necessary."

description: "MeiliSearch experienced an internal error. Check the error message, and fill an issue if necessary."

curquiza · 2020-06-23T10:12:04Z

errors.yaml

+  - code: invalid_token
+    description: "The provided token is invalid."
+  - code: maintenance
+    description: "The Meilisearch instance in under maintenance."


Suggested change

description: "The Meilisearch instance in under maintenance."

description: "The MeiliSearch instance in under maintenance."

curquiza · 2020-06-23T10:12:28Z

errors.yaml

+  - code: not_found
+    description: "The requested ressources could not be found."
+  - code: payload_too_large
+    description: "The payload sent to the server was too large. Check out this [guide](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#options) to change the maximum payload size"


Suggested change

description: "The payload sent to the server was too large. Check out this [guide](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#options) to change the maximum payload size"

description: "The payload sent to the server was too large. Check out this [guide](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#options) to change the maximum payload size."

Suggested change

description: "The payload sent to the server was too large. Check out this [guide](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#options) to change the maximum payload size"

description: "The payload sent to the server was too large. Check out this [guide](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#options) to customize the maximum payload size accepted by MeiliSearch."

curquiza · 2020-06-23T10:13:03Z

errors.yaml

+  - code: search_error
+    description: "There was an error in the search."
+  - code: unsupported_media_type
+    description: "The payload for the request is not supported by meilisearch. Meilisearch currently only support JSON payloads."


Suggested change

description: "The payload for the request is not supported by meilisearch. Meilisearch currently only support JSON payloads."

description: "The payload for the request is not supported by MeiliSearch. MeiliSearch currently only supports JSON payloads."

Suggested change

description: "The payload for the request is not supported by meilisearch. Meilisearch currently only support JSON payloads."

description: "The payload content type is not supported by MeiliSearch. Currently MeiliSearch supports only JSON payloads."

eskombro

🎉

eskombro · 2020-06-23T12:41:52Z

errors.yaml

+---
+errors:
+  - code: create_index
+    description: "Error relative to index creation, check out our guide on [index creation](link.com)"


Suggested change

description: "Error relative to index creation, check out our guide on [index creation](link.com)"

description: "An error occurred while trying to create an index, check out our guide on [index creation](link.com)"

eskombro · 2020-06-23T12:42:40Z

errors.yaml

+  - code: existing_index
+    description: "An index with this name already exists, check out our guide on [index creation](link.com)"
+  - code: invalid_index_uid
+    description: "The provided index formatting is wrong, check out our guide on [index creation](link.com)"


Suggested change

description: "The provided index formatting is wrong, check out our guide on [index creation](link.com)"

description: "There is an error in the provided index format, check out our guide on [index creation](link.com)"

eskombro · 2020-06-23T12:48:36Z

errors.yaml

+  - code: invalid_index_uid
+    description: "The provided index formatting is wrong, check out our guide on [index creation](link.com)"
+  - code: open_index
+    description: "An error occured while trying to open the requested index, ..."


Also, I don't think it is clear what "opening" an index means

eskombro · 2020-06-23T12:50:09Z

errors.yaml

+  - code: invalid_state
+    description: "An error occuring when the database is in an invalid state. Deleting the database and reindexing should solve the problem."
+  - code: missing_primary_key
+    description: "All documents must be identified with a unique key. Meilisearch will try to infer the documetn field to use as primary key. If it can't, it has to be specified manually, and this error is returned. See <a href=\"https://docs.meilisearch.com/guides/main_concepts/documents.html#structure\">guide on primary keys</a>."


Suggested change

description: "All documents must be identified with a unique key. Meilisearch will try to infer the documetn field to use as primary key. If it can't, it has to be specified manually, and this error is returned. See <a href=\"https://docs.meilisearch.com/guides/main_concepts/documents.html#structure\">guide on primary keys</a>."

description: "All documents must be identified with a unique key. MeiliSearch will try to infer the document field to use it as a primary key. If it can't infer it, the primary key must be specified manually, and this error is returned. See <a href=\"https://docs.meilisearch.com/guides/main_concepts/documents.html#structure\">guide on primary keys</a>."

eskombro · 2020-06-23T12:51:10Z

errors.yaml

+  - code: missing_primary_key
+    description: "All documents must be identified with a unique key. Meilisearch will try to infer the documetn field to use as primary key. If it can't, it has to be specified manually, and this error is returned. See <a href=\"https://docs.meilisearch.com/guides/main_concepts/documents.html#structure\">guide on primary keys</a>."
+  - code: primary_key_already_present
+    description: "Error thrown when trying to change the primary key for an index. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."


Suggested change

description: "Error thrown when trying to change the primary key for an index. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."

description: "Error thrown when trying to modify the primary key of an index, when it has been already set. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."

eskombro · 2020-06-23T12:54:55Z

errors.yaml

+  - code: invalid_facet
+    description: "The facet filter provided with the search is invalid. Check our [guide on faceting](https://docs.meilisearch.com/guides/advanced_guides/faceted_search.html) to troubleshoot."
+  - code: invalid_filter
+    description: "The facet filter provided with the search is invalid. Check our [guide on faceting](https://docs.meilisearch.com/guides/advanced_guides/filtering.html) to troubleshoot."


Suggested change

description: "The facet filter provided with the search is invalid. Check our [guide on faceting](https://docs.meilisearch.com/guides/advanced_guides/filtering.html) to troubleshoot."

description: "The filter provided with the search is invalid. Check our [guide on faceting](https://docs.meilisearch.com/guides/advanced_guides/filtering.html) to troubleshoot."

eskombro · 2020-06-23T12:55:30Z

errors.yaml

+  - code: bad_request
+    description: "The request is invalid, check the error message for more information."
+  - code: document_not_found
+    description: "The requested document can't be retieved. It either doesn't exists, or the database was left in an inconsistent state."


Suggested change

description: "The requested document can't be retieved. It either doesn't exists, or the database was left in an inconsistent state."

description: "The requested document can't be retrieved. Either it doesn't exist, or the database was left in an inconsistent state."

eskombro · 2020-06-23T12:56:40Z

errors.yaml

+  - code: maintenance
+    description: "The Meilisearch instance in under maintenance."
+  - code: missing_authorization_header
+    description: "The requested ressources is protected with an API key, that was not provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."


Suggested change

description: "The requested ressources is protected with an API key, that was not provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."

description: "The requested resources are protected with an authentication system, and no API KEY was provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."

eskombro · 2020-06-23T12:57:44Z

errors.yaml

+  - code: missing_authorization_header
+    description: "The requested ressources is protected with an API key, that was not provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."
+  - code: missing_header
+    description: "The header is missing."


Suggested change

description: "The header is missing."

description: "A header is missing in the HTTP request."

eskombro · 2020-06-23T12:58:00Z

errors.yaml

+  - code: missing_header
+    description: "The header is missing."
+  - code: not_found
+    description: "The requested ressources could not be found."


Suggested change

description: "The requested ressources could not be found."

description: "The requested resources could not be found."

Replaces `GET` with `POST` in examples for update `searchable-attributes`, `displayed-attributes`, and `accept-new-fields`

bidoubiwa · 2020-06-24T14:06:40Z

I don't know if we talked about this but

code: create_index
code: open_index
code: retrieve_document

Are the only errors without a error connotation attached to it.

As we look at the other once:

create_index ❌
existing_index ✅
invalid_index_uid ✅
open_index ❌
invalid_state ✅
missing_primary_key ✅
primary_key_already_present ✅
max_fields_limit_exceeded ✅
missing_document_id ✅
invalid_facet ✅
invalid_filter ✅
bad_parameter ✅
bad_request ✅
document_not_found ✅
internal ✅
invalid_token ✅
maintenance ✅
missing_authorization_header ✅
missing_header ✅
not_found ✅
payload_too_large ✅
retrieve_document ❌
search_error ✅
unsupported_media_type ✅

Could we consider to add the error connotation to it?

could_not_create_index
could_not_open_index
could_not_retrieve_document

Of course this is possibly not important. I say that with the idea that a error code gives you an ultra minimalistic feedback of what happened. Which is the case for all the error codes except those 3.

MarinPostma · 2020-06-24T14:28:31Z

I understand your concern @bidoubiwa, and I remember wanting to append "error" to those errors in the beginning. Those are error code, so it is expected that something went wrong in the process, and in that sense I don't think that prepending "could_not" adds anything, neither does appending "error". This code's purpose is to be read by a computer, and we made them readable simply for devs comfort. What do you think?

bidoubiwa · 2020-06-24T15:16:41Z

If it is only meant to be read by computer it is indeed not usefull to add anything. But in this case I would suggest we add a title field in which we describe in a minimalistic way the error. So that I can use that title and not the error code as a header in the error page.

So it's either one or the other. Both are good for me.

curquiza · 2020-06-25T07:12:13Z

errors.yaml

+errors:
+  - code: create_index
+    description: "An error occurred while trying to create an index, check out our guide on [index creation](https://docs.meilisearch.com/guides/main_concepts/indexes.html)"
+  - code: existing_index


Suggested change

- code: existing_index

- code: index_already_exists

Sorry, I did not notice it before! We decided this name during a meeting because that's the only one we already use in our code since the v0.11 is out. Please don't change this one 🙏

curquiza · 2020-06-25T07:20:07Z

I agree with @bidoubiwa, this is not clear that these 3 ones are errors.
For me, the could_not as a prefix is ok (better than error as a suffix) and fixes this unclear naming. Except if you have a better suggestion.

When I look at Stripe code error, every naming is clear and means this is an error. I don't see any "non-error" naming like open_index equivalent.

curquiza · 2020-06-29T12:09:24Z

Hello @MarinPostma

We discuss with the team (@tpayet, @eskombro, and @bidoubiwa) about these 3 errors. We would rather rename it as:

index_creation_failed
index_not_accessible
unretrievable_document

We read the error descriptions to chose the naming.
Do you agree? 🙂

bidoubiwa · 2020-06-30T08:34:53Z

This is still in progress or is the list completed?

Add code-samples for PHP, Go and Ruby

MarinPostma · 2020-06-30T09:31:34Z

the list is complete

errors.yaml

Bumps [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import) from 2.21.2 to 2.22.0. - [Release notes](https://github.com/benmosher/eslint-plugin-import/releases) - [Changelog](https://github.com/benmosher/eslint-plugin-import/blob/master/CHANGELOG.md) - [Commits](import-js/eslint-plugin-import@v2.21.2...v2.22.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Bumps [bent](https://github.com/mikeal/bent) from 7.3.5 to 7.3.7. - [Release notes](https://github.com/mikeal/bent/releases) - [Commits](mikeal/bent@v7.3.5...v7.3.7) Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

matboivin · 2020-07-01T16:03:33Z

errors.yaml

+  - code: index_not_accessible
+    description: "An internal error occurred while trying to access the requested index."
+  - code: invalid_state
+    description: "An error that occurs when the database is in an invalid state. Deleting the database and re indexing should solve the problem."


Suggested change

description: "An error that occurs when the database is in an invalid state. Deleting the database and re indexing should solve the problem."

description: "An error that occurs when the database is in an invalid state. Deleting the database and re-indexing should solve the problem."

matboivin · 2020-07-01T16:04:15Z

errors.yaml

+  - code: invalid_state
+    description: "An error that occurs when the database is in an invalid state. Deleting the database and re indexing should solve the problem."
+  - code: missing_primary_key
+    description: "All documents must be identified with a unique key. MeiliSearch will try to infer the document field to use it as a primary key. If it can't infer it, the primary key must be specified manually, and this error is returned. . See  our [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."


Suggested change

description: "All documents must be identified with a unique key. MeiliSearch will try to infer the document field to use it as a primary key. If it can't infer it, the primary key must be specified manually, and this error is returned. . See our [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."

description: "All documents must be identified with a unique key. MeiliSearch will try to infer the document field to use it as a primary key. If it can't infer it, the primary key must be specified manually, and this error is returned. See our [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."

matboivin · 2020-07-01T16:05:00Z

errors.yaml

+  - code: missing_primary_key
+    description: "All documents must be identified with a unique key. MeiliSearch will try to infer the document field to use it as a primary key. If it can't infer it, the primary key must be specified manually, and this error is returned. . See  our [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."
+  - code: primary_key_already_present
+    description: "Error thrown when trying to modify the primary key of an index, when it has been already set. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."


Suggested change

description: "Error thrown when trying to modify the primary key of an index, when it has been already set. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."

description: "This error is thrown when trying to modify the primary key of an index when it has been already set. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."

matboivin · 2020-07-01T16:08:32Z

errors.yaml

+  - code: invalid_token
+    description: "The provided token is invalid."
+  - code: maintenance
+    description: "The MeiliSearch instance in under maintenance."


Suggested change

description: "The MeiliSearch instance in under maintenance."

description: "The MeiliSearch instance is under maintenance."

matboivin · 2020-07-01T16:08:56Z

errors.yaml

+  - code: maintenance
+    description: "The MeiliSearch instance in under maintenance."
+  - code: missing_authorization_header
+    description: "The requested resources is protected with an API key, that was not provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."


Suggested change

description: "The requested resources is protected with an API key, that was not provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."

description: "The requested resources are protected with an API key, that was not provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."

matboivin · 2020-07-01T16:13:34Z

errors.yaml

+  - code: search_error
+    description: "There was an error in the search."
+  - code: unsupported_media_type
+    description: "The payload content type is not supported by MeiliSearch. Currently MeiliSearch supports only JSON payloads."


Suggested change

description: "The payload content type is not supported by MeiliSearch. Currently MeiliSearch supports only JSON payloads."

description: "The payload content type is not supported by MeiliSearch. Currently, MeiliSearch supports only JSON payloads."

matboivin · 2020-07-01T16:18:35Z

Nice job! Voila! 😄

Bumps [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) from 0.23.1 to 0.23.2. - [Release notes](https://github.com/igorshubovych/markdownlint-cli/releases) - [Commits](igorshubovych/markdownlint-cli@v0.23.1...v0.23.2) Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Bumps [@popperjs/core](https://github.com/popperjs/popper-core) from 2.4.2 to 2.4.4. - [Release notes](https://github.com/popperjs/popper-core/releases) - [Commits](floating-ui/floating-ui@v2.4.2...v2.4.4) Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Bumps [vuepress-plugin-img-lazy](https://github.com/tolking/vuepress-plugin-img-lazy) from 1.0.3 to 1.0.4. - [Release notes](https://github.com/tolking/vuepress-plugin-img-lazy/releases) - [Commits](tolking/vuepress-plugin-img-lazy@v1.0.3...v1.0.4) Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

bidoubiwa requested review from bidoubiwa, curquiza, eskombro and matboivin June 23, 2020 09:41

curquiza requested changes Jun 23, 2020

View reviewed changes

eskombro requested changes Jun 23, 2020

View reviewed changes

should fix getting started

327ff2a

MarinPostma force-pushed the error-codes branch from f40d712 to 13a028f Compare June 24, 2020 08:27

Fix API Examples for Settings API Documentation

e1a9b1c

Replaces `GET` with `POST` in examples for update `searchable-attributes`, `displayed-attributes`, and `accept-new-fields`

curquiza requested changes Jun 25, 2020

View reviewed changes

Remove buggy warning in tabs

f69e604

MarinPostma mentioned this pull request Jun 29, 2020

rename error codes meilisearch/meilisearch#805

Merged

bidoubiwa approved these changes Jun 29, 2020

View reviewed changes

bidoubiwa and others added 2 commits June 29, 2020 16:20

lazy load images

7e59fae

Add code-samples for PHP, Go and Ruby

5257b11

bidoubiwa added 2 commits June 30, 2020 10:42

tests if code sample is not empty before adding it

8a70619

Add code-samples for PHP, Go and Ruby

Refactor getting started and fix bug

9af3915

Add comment at the top of the code-samples file

ce47042

bidoubiwa suggested changes Jun 30, 2020

View reviewed changes

errors.yaml Show resolved Hide resolved

dependabot-preview bot and others added 3 commits June 30, 2020 14:20

Bump bent from 7.3.5 to 7.3.7

0da9bf8

Bumps [bent](https://github.com/mikeal/bent) from 7.3.5 to 7.3.7. - [Release notes](https://github.com/mikeal/bent/releases) - [Commits](mikeal/bent@v7.3.5...v7.3.7) Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Update .code-samples.meilisearch.yaml

dd6c9e7

bidoubiwa previously approved these changes Jul 1, 2020

View reviewed changes

bidoubiwa mentioned this pull request Jul 1, 2020

Errors documentation #437

Merged

matboivin reviewed Jul 1, 2020

View reviewed changes

dependabot-preview bot and others added 9 commits July 6, 2020 10:55

Update resources page about SDKs/Integration

3ab632c

update faceting code example

0c5feea

Update gh-pages-scraping.yml

0c5d0b6

add error yaml

2a38ce7

requested changes

643b9a4

change error code names

e67ca24

MarinPostma dismissed bidoubiwa’s stale review via e67ca24 July 16, 2020 09:36

MarinPostma force-pushed the error-codes branch from 0f6e9da to e67ca24 Compare July 16, 2020 09:36

bidoubiwa changed the base branch from master to prepare-v0.12 July 16, 2020 10:36

bidoubiwa merged commit 8276a7b into meilisearch:prepare-v0.12 Jul 16, 2020

	description: "An error occuring when the database is in an invalid state. Deleting the database and reindexing should solve the problem."
	description: "An error occurred when the database is in an invalid state. Deleting the database and reindexing should solve the problem."

	description: "An error occured while trying to open the requested index, ..."
	description: "An error occurred while trying to open the requested index, ..."

	- code: max_field_limit_exceeded
	- code: max_fields_limit_exceeded

	description: "The maximum number of fields for a document is 65,535. When this number is exceded, this error is returned."
	description: "The maximum number of fields for a document is 65,535. When this number is exceeded, this error is returned."

	description: "An error with Meilisearch internals has occured. Check the error message, and fill an issue if necessary."
	description: "An error with MeiliSearch internals has occurred. Check the error message, and open an issue if necessary."

	description: "An error with Meilisearch internals has occured. Check the error message, and fill an issue if necessary."
	description: "MeiliSearch experienced an internal error. Check the error message, and fill an issue if necessary."

	description: "The Meilisearch instance in under maintenance."
	description: "The MeiliSearch instance in under maintenance."

	description: "The payload sent to the server was too large. Check out this [guide](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#options) to change the maximum payload size"
	description: "The payload sent to the server was too large. Check out this [guide](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#options) to change the maximum payload size."

	description: "The payload for the request is not supported by meilisearch. Meilisearch currently only support JSON payloads."
	description: "The payload for the request is not supported by MeiliSearch. MeiliSearch currently only supports JSON payloads."

	description: "The payload for the request is not supported by meilisearch. Meilisearch currently only support JSON payloads."
	description: "The payload content type is not supported by MeiliSearch. Currently MeiliSearch supports only JSON payloads."

	description: "Error relative to index creation, check out our guide on [index creation](link.com)"
	description: "An error occurred while trying to create an index, check out our guide on [index creation](link.com)"

	description: "The provided index formatting is wrong, check out our guide on [index creation](link.com)"
	description: "There is an error in the provided index format, check out our guide on [index creation](link.com)"

	description: "All documents must be identified with a unique key. Meilisearch will try to infer the documetn field to use as primary key. If it can't, it has to be specified manually, and this error is returned. See <a href=\"https://docs.meilisearch.com/guides/main_concepts/documents.html#structure\">guide on primary keys</a>."
	description: "All documents must be identified with a unique key. MeiliSearch will try to infer the document field to use it as a primary key. If it can't infer it, the primary key must be specified manually, and this error is returned. See <a href=\"https://docs.meilisearch.com/guides/main_concepts/documents.html#structure\">guide on primary keys</a>."

	description: "Error thrown when trying to change the primary key for an index. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."
	description: "Error thrown when trying to modify the primary key of an index, when it has been already set. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."

	description: "The facet filter provided with the search is invalid. Check our [guide on faceting](https://docs.meilisearch.com/guides/advanced_guides/filtering.html) to troubleshoot."
	description: "The filter provided with the search is invalid. Check our [guide on faceting](https://docs.meilisearch.com/guides/advanced_guides/filtering.html) to troubleshoot."

	description: "The requested document can't be retieved. It either doesn't exists, or the database was left in an inconsistent state."
	description: "The requested document can't be retrieved. Either it doesn't exist, or the database was left in an inconsistent state."

	description: "The requested ressources is protected with an API key, that was not provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."
	description: "The requested resources are protected with an authentication system, and no API KEY was provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."

	description: "The header is missing."
	description: "A header is missing in the HTTP request."

	description: "The requested ressources could not be found."
	description: "The requested resources could not be found."

	description: "An error that occurs when the database is in an invalid state. Deleting the database and re indexing should solve the problem."
	description: "An error that occurs when the database is in an invalid state. Deleting the database and re-indexing should solve the problem."

Documentation for error codes #421

Documentation for error codes #421

Conversation

MarinPostma commented Jun 22, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eskombro Jun 23, 2020 • edited Loading

Choose a reason for hiding this comment

eskombro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bidoubiwa commented Jun 24, 2020 • edited Loading

MarinPostma commented Jun 24, 2020

bidoubiwa commented Jun 24, 2020 • edited Loading

Choose a reason for hiding this comment

curquiza Jun 25, 2020 • edited Loading

Choose a reason for hiding this comment

curquiza commented Jun 25, 2020 • edited Loading

curquiza commented Jun 29, 2020 • edited Loading

bidoubiwa commented Jun 30, 2020

MarinPostma commented Jun 30, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matboivin commented Jul 1, 2020

MarinPostma commented Jun 22, 2020 •

edited

Loading

eskombro Jun 23, 2020 •

edited

Loading

bidoubiwa commented Jun 24, 2020 •

edited

Loading

bidoubiwa commented Jun 24, 2020 •

edited

Loading

curquiza Jun 25, 2020 •

edited

Loading

curquiza commented Jun 25, 2020 •

edited

Loading

curquiza commented Jun 29, 2020 •

edited

Loading

	description: "Error thrown when trying to modify the primary key of an index, when it has been already set. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."
	description: "This error is thrown when trying to modify the primary key of an index when it has been already set. See [guide on primary keys](https://docs.meilisearch.com/guides/main_concepts/documents.html#structure)."

	description: "The requested resources is protected with an API key, that was not provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."
	description: "The requested resources are protected with an API key, that was not provided in the request header. Check our guide on [authentication](https://docs.meilisearch.com/guides/advanced_guides/authentication.html) for more information."