docs(api): documente les opérateurs (filtres + agrégation) dans Swagger (#78)

Remplace la description du paramètre <colonne>__<opérateur> par une
documentation complète listant tous les opérateurs de filtre (exact, differs,
contains, notcontains, in, notin, less, greater, strictly_less,
strictly_greater, isnull, isnotnull, sort) et les agrégations (groupby, count,
sum, avg, min, max).

Met à jour le docstring de data() pour documenter le mode agrégation et les
paramètres réservés.

Ajoute test_openapi_doc.py qui valide la présence des mots-clés clés dans
l'OpenAPI généré.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Colin Maudry
2026-06-22 14:09:34 +02:00
parent 7c9a95355b
commit b87eb4328c
2 changed files with 48 additions and 9 deletions
+15
View File
@@ -0,0 +1,15 @@
def test_openapi_documents_new_keywords(api_client):
client, _ = api_client
resp = client.get("/api/v1/openapi.json")
assert resp.status_code == 200
raw = resp.get_data(as_text=True)
for keyword in [
"count_results",
"differs",
"groupby",
"__sum",
"__avg",
"__min",
"__max",
]:
assert keyword in raw, f"{keyword} absent de la doc OpenAPI"