From 09a5b8cb97769853ac8a3982bcb340c4c1422498 Mon Sep 17 00:00:00 2001
From: Alban Gruin
Date: Tue, 5 Feb 2019 19:14:48 +0100
Subject: Documentation: ajout des nouvelles routes dans la doc et corrections

Signed-off-by: Alban Gruin <alban@pa1ch.fr>
---
 Documentation/usage/rest.rst | 71 ++++++++++++++++++++++++++++++++++++++------
 1 file changed, 62 insertions(+), 9 deletions(-)

diff --git a/Documentation/usage/rest.rst b/Documentation/usage/rest.rst
index 60c8d44..4908d8a 100644
--- a/Documentation/usage/rest.rst
+++ b/Documentation/usage/rest.rst
@@ -64,8 +64,8 @@ Exemple :
       "slug": "l3"
   }
 
-``api/years/<id>/timetables``
------------------------------
+``api/years/<id>/timetables/``
+------------------------------
 Liste les emplois du temps associés à une année par ordre alphabétique
 de nom.  :ref:`Le résultat peut être paginé <ref-pagination>`.
 
@@ -398,6 +398,41 @@ Exemple :
       ]
   }
 
+``api/groups/<id>/courses/days/current/``
+-----------------------------------------
+Retourne la liste des cours du groupe et de ses parents d’un groupe
+pendant le jour courant, par ordre de début.  :ref:`Le résultat peut
+être paginé <ref-pagination>`.  Le format du résultat est identique à
+celui de :ref:`api/groups/\<id>/courses/ <ref-groups-courses>`.
+
+.. _ref-groups-courses-day-arg:
+
+``api/groups/<id>/courses/days/<year>/<month>/<day>/``
+------------------------------------------------------
+Retourne la liste des cours du groupe et de ses parents pendant le
+jour spécifié, par ordre de début.  Si l’année, le mois ou le jour ne
+sont pas des nombres, un code 404 est renvoyé.  Si la date est
+invalide, une erreur 400 est renvoyée, et les erreurs rencontrées sont
+renvoyées.  :ref:`Le résultat peut être paginé <ref-pagination>`.  Le
+format du résultat est identique à celui de
+:ref:`api/groups/\<id>/courses/ <ref-groups-courses>`.
+
+Exemple d’erreur (``api/groups/<id>/courses/days/2018/111/22``) :
+`````````````````````````````````````````````````````````````````
+.. code:: json
+
+  {
+      "month": "Rentrez un mois valide"
+  }
+
+Exemple d’erreur (``api/groups/<id>/courses/days/2018/11/33``) :
+````````````````````````````````````````````````````````````````
+.. code:: json
+
+  {
+      "day": "Numéro de jour invalide pour le mois"
+  }
+
 ``api/groups/<id>/courses/weeks/``
 ----------------------------------
 Retourne la liste des semaines de cours d’un groupe.
@@ -423,7 +458,7 @@ Le format du résultat est identique à celui de
 ``api/groups/<id>/courses/weeks/<year>/<week>/``
 ------------------------------------------------
 Retourne la liste des cours du groupe et de ses parents pendant la
-semaine spécifiée, par ordre de début.  Si l’année et la semaine ne
+semaine spécifiée, par ordre de début.  Si l’année ou la semaine ne
 sont pas des nombres, un code 404 est renvoyé.  Si la semaine n’est
 pas comprise entre 1 et 53, une erreur 400 est renvoyée, et les
 erreurs rencontrées sont renvoyées.  :ref:`Le résultat peut être
@@ -473,8 +508,8 @@ Exemple :
       ]
   }
 
-``api/rooms/<id>``
-------------------
+``api/rooms/<id>/``
+-------------------
 Renvoie une seule salle.
 
 Exemple :
@@ -494,6 +529,24 @@ début.  :ref:`Le résultat peut être paginé <ref-pagination>`.  Le
 format du résultat est identique à celui de
 :ref:`api/groups/\<id>/courses/ <ref-groups-courses>`.
 
+``api/rooms/<id>/courses/days/current/``
+----------------------------------------
+Retourne la liste des cours se déroulant dans une salle pendant le
+jour courant, par ordre de début.  :ref:`Le résultat peut être paginé
+<ref-pagination>`.  Le format du résultat est identique à celui de
+:ref:`api/groups/\<id>/courses/ <ref-groups-courses>`.
+
+``api/rooms/<id>/courses/days/<year>/<month>/<day>/``
+-----------------------------------------------------
+Retourne la liste des cours se déroulant dans une salle pendant le
+jour spécifié, par ordre de début.  Si l’année, le mois ou le jour ne
+sont pas des nombres, un code 404 est renvoyé.  Si la date est
+invalide, une erreur 400 est renvoyée, et les erreurs rencontrées sont
+renvoyées.  :ref:`Le résultat peut être paginé <ref-pagination>`.  Le
+format du résultat est identique à celui de
+:ref:`api/groups/\<id>/courses/days/\<year>/\<month>/\<day>/
+<ref-groups-courses-day-arg>`.
+
 ``api/rooms/<id>/courses/weeks/current/``
 -----------------------------------------
 Renvoie la liste des cours se déroulant dans une salle pendant la
@@ -505,12 +558,12 @@ format du résultat est identique à celui de
 ``api/rooms/<id>/courses/weeks/<year>/<week>/``
 -----------------------------------------------
 Renvoie la liste des cours se déroulant dans une salle pendant la
-semaine spécifiée.  Si l’année et la semaine ne sont pas des nombres,
+semaine spécifiée.  Si l’année ou la semaine ne sont pas des nombres,
 un code 404 est renvoyé.  Si la semaine n’est pas comprise entre 1 et
 53, une erreur 400 est renvoyée, et les erreurs rencontrées sont
 renvoyées.  :ref:`Le résultat peut être paginé <ref-pagination>`.  Le
 format du résultat est identique à celui de
-:ref:`api/groups/\<id>/courses/weeks/\<year>/\<week>
+:ref:`api/groups/\<id>/courses/weeks/\<year>/\<week>/
 <ref-groups-courses-week-arg>`.
 
 ``api/rooms/qsjps/<day>/<begin>/<end>/``
@@ -629,8 +682,8 @@ Exemple :
       ]
     }
 
-``api/courses/<id>``
---------------------
+``api/courses/<id>/``
+---------------------
 Renvoie un seul cours.
 
 Exemple :
-- 
cgit v1.2.1