From 0df77b20fb7006f31446761b31a881a47a5d8b11 Mon Sep 17 00:00:00 2001
From: ilona <ilona@scodoc.org>
Date: Tue, 6 Aug 2024 09:22:27 +0200
Subject: [PATCH] =?UTF-8?q?Modifie=20test=5Fapi.sh=20pour=20g=C3=A9n=C3=A9?=
 =?UTF-8?q?rer=20les=20exemples=20de=20la=20documentation=20(samples).?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 app/templates/doc/ScoDoc9API.j2 |  3 +++
 tools/test_api.sh               | 16 +++++++++++++---
 2 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/app/templates/doc/ScoDoc9API.j2 b/app/templates/doc/ScoDoc9API.j2
index 032c2280..e8fa5311 100644
--- a/app/templates/doc/ScoDoc9API.j2
+++ b/app/templates/doc/ScoDoc9API.j2
@@ -270,6 +270,9 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
 
 Voir exemples d'utilisation de l'API en Python, dans `tests/api/`.
 
+!!! info
+    Cette page a été générée par la commande `flask gen-api-doc`, et les exemples de résultats
+    sont créés par `tools/test_api.sh --make-samples`.
 
 !!! note "Voir aussi"
 
diff --git a/tools/test_api.sh b/tools/test_api.sh
index 4a915d33..609c9e78 100755
--- a/tools/test_api.sh
+++ b/tools/test_api.sh
@@ -11,13 +11,17 @@
 #
 # Toutes les autres options sont passées telles qu'elles à pytest
 #
+# Utilisation pour générer des exemples de documentation:
+#   tools/test_api.sh --make-samples
+#
 # Exemples:
 # - lancer tous les tests API: tools/test_api.sh
 # - lancer tous les tests, en mode debug (arrêt pdb sur le 1er):
 #       tools/test_api.sh -x --pdb tests/api
 # - lancer un module de test, en utilisant un server dev existant:
 #       tools/test_api.sh --dont-start-server  -x --pdb tests/api/test_api_evaluations.py
-#
+# - Générer les samples pour la doc:
+#       tools/test_api.sh --make-samples
 #
 # E. Viennet, Fev 2023
 
@@ -71,8 +75,14 @@ then
   echo "Starting pytest tests/api"
   pytest tests/api
 else
-  echo "Starting pytest $@"
-  pytest "$@"
+  if [ "$1" = "--make-samples" ]
+  then
+    echo "Generating API documentation samples"
+    python tests/api/make_samples.py -i /tmp/samples.csv
+  else
+    echo "Starting pytest $@"
+    pytest "$@"
+  fi
 fi
 
 # ------------------