From 44b5b9e1a744574965062e85656e3917e3fc555d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20Renault?= <clement@meilisearch.com>
Date: Thu, 29 Jun 2023 10:28:23 +0200
Subject: [PATCH] Improve the documentation of the FacetSearchQuery struct

---
 meilisearch/src/routes/indexes/facet_search.rs | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/meilisearch/src/routes/indexes/facet_search.rs b/meilisearch/src/routes/indexes/facet_search.rs
index 5dd2ac039..5a5c04f99 100644
--- a/meilisearch/src/routes/indexes/facet_search.rs
+++ b/meilisearch/src/routes/indexes/facet_search.rs
@@ -22,7 +22,9 @@ pub fn configure(cfg: &mut web::ServiceConfig) {
     cfg.service(web::resource("").route(web::post().to(search)));
 }
 
-// TODO improve the error messages
+/// # Important
+///
+/// Intentionally don't use `deny_unknown_fields` to ignore search parameters sent by user
 #[derive(Debug, Clone, Default, PartialEq, deserr::Deserr)]
 #[deserr(error = DeserrJsonError, rename_all = camelCase)]
 pub struct FacetSearchQuery {