search

guillaumeperes / strawpoll_backoffice

Laravel powered backoffice for the strawpoll application
GNU General Public License v3.0
1 stars 1 forks source link

Mettre à jour la documentation #18

Open guillaumeperes opened 7 years ago

guillaumeperes commented 7 years ago

Mettre à jour le README

guillaumeperes commented 7 years ago

La doc pour l'enregistrement des vote n'est pas correcte.

Il faudrait que la doc pour cette route soit déplacée dans la section des routes développée, alors qu'elle est pour le moment dans celle qui concerne les routes en développement.

D'autre part, la doc n'explique pas clairement quelles sont les données à envoyer à cette route pour l'utiliser. Les données en question sont : un tableau obligatoire contenant la liste des réponses pour lesquelles l'utilisateur souhaite voter (answers), ainsi qu'une chaine de caractères facultative contenant la valeur du strawpoll_cookie qui sera sauvegardée par l'api (cookie).

Par ailleurs, le json retourné par l'api en cas de succès n'est pas bon. Il faut que le redirect comporte l'url de la page des résultats : /poll/{poll_id}/results/

guillaumeperes commented 7 years ago

Il faut aussi mettre à jour la doc des routes /results et /channel pour l'affichage des résultats, et créer celle qui concerne l'utilisation du serveur de websocket (sous réserve des modifications apportées suite à l'issue #21)

guillaumeperes commented 7 years ago

Voila qui est fait grâce aux commits :

https://github.com/guillaumeperes/strawpoll_backoffice/commit/af8802acdccbd378266f76353a31d55fe0d4272b https://github.com/guillaumeperes/strawpoll_backoffice/commit/c7582a05bbb014accda3c0c2a1bec0a40a9383bf

Les seules fonctionnalités qui restent à documenter sont donc celles qui sont relatives à l'ajout de commentaires, l'inscription, la connexion, ainsi que toutes les fonctions accessibles aux utilisateurs connectés.