From 9d8f47115c82b60348b5564ca88619afd9907ddd Mon Sep 17 00:00:00 2001
From: Yohann D'ANELLO <yohann.danello@gmail.com>
Date: Wed, 23 Dec 2020 21:50:48 +0100
Subject: [PATCH] ConsumerViewSet is a bit tricky

Signed-off-by: Yohann D'ANELLO <yohann.danello@gmail.com>
---
 docs/api/basic.rst | 7 +++++++
 docs/api/note.rst  | 7 +++++++
 2 files changed, 14 insertions(+)

diff --git a/docs/api/basic.rst b/docs/api/basic.rst
index 8ff28d9b..6e5ced76 100644
--- a/docs/api/basic.rst
+++ b/docs/api/basic.rst
@@ -111,6 +111,13 @@ Filtres Django
 * ``note__alias__name``
 * ``note__alias__normalized_name``
 
+Filtres de recherche
+~~~~~~~~~~~~~~~~~~~~
+
+* ``note__alias`` (expression régulière, cherche en priorité les alias les plus proches, puis cherche les alias normalisés)
+* ``last_name`` (expression régulière)
+* ``first_name`` (expression régulière)
+
 Type de contenu
 ---------------
 
diff --git a/docs/api/note.rst b/docs/api/note.rst
index bba1d03d..87a87cc1 100644
--- a/docs/api/note.rst
+++ b/docs/api/note.rst
@@ -128,6 +128,7 @@ Tris possible
 Filtres de recherche
 ~~~~~~~~~~~~~~~~~~~~
 
+* ``alias`` (cherche en priorité les alias les plus proches, puis cherche les alias normalisés)
 * ``normalized_name`` (expression régulière)
 * ``name`` (expression régulière)
 * ``note__polymorphic_ctype__model`` (expression régulière)
@@ -156,9 +157,15 @@ Options
       ]
   }
 
+.. note::
+
+   Cette page est en lecture seule. Elle offre l'avantage de fournir directement les informations sur la note associée
+   à l'alias au lieu de l'identifiant uniquement, afin de minimiser les appels à l'API.
+
 Filtres Django
 ~~~~~~~~~~~~~~
 
+* ``alias`` (expression régulière, cherche en priorité les alias les plus proches, puis cherche les alias normalisés)
 * ``note``
 * ``note__noteuser__user``
 * ``note__noteclub__club``
-- 
GitLab