Mettre à jour la documentation de l'API pour inclure la nouvelle route GET /comments/event/:eventId. Cette issue est liée à l'implémentation de la nouvelle route pour récupérer les commentaires d'un événement spécifique.
Context
Pour assurer que les utilisateurs et les développeurs comprennent comment utiliser la nouvelle route GET /comments/event/:eventId, il est essentiel de mettre à jour la documentation de l'API. Cela inclut la description de la route, les paramètres, les réponses attendues, et des exemples d'utilisation.
Objectives
Mettre à jour la documentation de l'API pour inclure la nouvelle route GET /comments/event/:eventId.
Décrire les paramètres requis et optionnels pour cette route.
Inclure les réponses attendues, y compris les cas de succès et d'erreur.
Fournir des exemples d'utilisation de la route.
Acceptance Criteria
La documentation de l'API doit inclure une section détaillée pour la route GET /comments/event/:eventId.
La documentation doit décrire les paramètres requis (eventId) et les en-têtes d'authentification nécessaires.
La documentation doit inclure des exemples de requêtes et de réponses pour les cas de succès et d'erreur.
La documentation doit être claire et facile à comprendre pour les développeurs.
Tasks
[ ] Ajouter une section pour la route GET /comments/event/:eventId dans la documentation de l'API.
[ ] Décrire les paramètres requis pour la route.
[ ] Inclure des exemples de requêtes et de réponses pour les cas de succès et d'erreur.
[ ] Assurer que la documentation est cohérente avec le reste de la documentation de l'API.
Summary
Mettre à jour la documentation de l'API pour inclure la nouvelle route GET /comments/event/:eventId. Cette issue est liée à l'implémentation de la nouvelle route pour récupérer les commentaires d'un événement spécifique.
Context
Pour assurer que les utilisateurs et les développeurs comprennent comment utiliser la nouvelle route GET /comments/event/:eventId, il est essentiel de mettre à jour la documentation de l'API. Cela inclut la description de la route, les paramètres, les réponses attendues, et des exemples d'utilisation.
Objectives
Acceptance Criteria
eventId) et les en-têtes d'authentification nécessaires.Tasks
Resources
UML Diagrams References
Branch Name
docs/update-api-doc-for-comments-by-event-routeLabels
documentation: Related to documentation tasksapi: Related to API developmentMilestone Suggestion
Milestone 7: Documentation