From dccb94bcdd6c0c4083a24111cf9987807208e9a3 Mon Sep 17 00:00:00 2001
From: viennet <emmanuel.viennet@gmail.com>
Date: Sun, 11 Feb 2024 12:44:33 +0100
Subject: [PATCH] API: routes annotations

---
 docs/ScoDoc9API.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md
index 20f8624..dd8f7c4 100644
--- a/docs/ScoDoc9API.md
+++ b/docs/ScoDoc9API.md
@@ -486,6 +486,9 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
 
 ##### Structure annotation
 
+Les annotations sur les étudiants ne sont accessibles qu'avec la permission `ViewEtudData`.
+Sur l'application, elles sont affichées et modifiables sur la fiche de l'étudiants.
+
 | attribut | type   | commentaire |
 |:---------|:-------|:------------|
 | date     | string |             |
@@ -616,7 +619,26 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
 * **Routes:** `/etudiant/edit.
 * **Résultat:** Modifie les données de l'étudiant.
 
+#### **`etudiant-annotation`**
 
+* **Méthode: POST**
+* **Permission: `ScoEtudInscrit`+`ViewEtudData`**
+* **Data:** `{ "comment" : "une annotation" }`
+* **Routes:**
+  * `/etudiant/etudid/<int:etudid>/annotation`
+  * `/etudiant/nip/<string:nip>/annotation`
+  * `/etudiant/ine/<string:ine>/annotation`
+* **Résultat:** Ajoute une annotation sur l'étudiant.
+
+#### **`etudiant-annotation-delete`**
+
+* **Méthode: POST**
+* **Permission: `ScoEtudInscrit`**
+* **Routes:**
+  * `/etudiant/etudid/<int:etudid>/annotation/<int:annotation_id>/delete`
+  * `/etudiant/nip/<string:nip>/annotation<int:annotation_id>/delete`
+  * `/etudiant/ine/<string:ine>/annotation<int:annotation_id>/delete`
+* **Résultat:** Supprimer une annotation sur l'étudiant.
 
 #### **departement-etudiants**