From aecbd1476138fbf18e072b911509c294d96434d7 Mon Sep 17 00:00:00 2001
From: Kerollmops <clement@meilisearch.com>
Date: Tue, 22 Jun 2021 11:31:58 +0200
Subject: [PATCH] Improve the error message for InvalidDocumentId

---
 milli/src/error.rs | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/milli/src/error.rs b/milli/src/error.rs
index 31012c690..d927407f0 100644
--- a/milli/src/error.rs
+++ b/milli/src/error.rs
@@ -206,7 +206,13 @@ impl fmt::Display for UserError {
             Self::InvalidCriterionName { name } => write!(f, "invalid criterion {}", name),
             Self::InvalidDocumentId { document_id } => {
                 let json = serde_json::to_string(document_id).unwrap();
-                write!(f, "document identifier is invalid {}", json)
+                write!(
+                    f,
+                    "document identifier is invalid {}, \
+a document id can be of type integer or string \
+only composed of alphanumeric characters (a-z A-Z 0-9), hyphens (-) and underscores (_)",
+                    json
+                )
             }
             Self::InvalidFilterAttribute(error) => error.fmt(f),
             Self::MissingDocumentId { document } => {