Mettre à jour la documentation de l'API pour refléter la nouvelle route DELETE /comments/event/:eventId. Cette route permet de supprimer tous les commentaires d'un événement spécifique en utilisant son ID et est accessible uniquement aux administrateurs.
Context
Avec l'introduction de la nouvelle route DELETE /comments/event/:eventId, il est essentiel de mettre à jour la documentation de l'API pour que les développeurs puissent comprendre comment utiliser cette fonctionnalité correctement.
Objectives
Ajouter la nouvelle route DELETE /comments/event/:eventId à la documentation de l'API.
Inclure des exemples de requêtes et de réponses.
Préciser les conditions d'authentification et d'autorisation.
Acceptance Criteria
La documentation de l'API doit inclure une section pour la route DELETE /comments/event/:eventId.
Les exemples de requêtes et de réponses doivent être clairs et précis.
Les conditions d'authentification et d'autorisation doivent être correctement documentées.
Tasks
[ ] Ajouter une section pour la route DELETE /comments/event/:eventId dans le fichier API_DOCUMENTATION.md.
[ ] Inclure un exemple de requête HTTP pour cette route.
[ ] Fournir un exemple de réponse HTTP pour cette route.
[ ] Documenter les conditions d'authentification et d'autorisation requises.
Description:
Summary
Mettre à jour la documentation de l'API pour refléter la nouvelle route DELETE /comments/event/:eventId. Cette route permet de supprimer tous les commentaires d'un événement spécifique en utilisant son ID et est accessible uniquement aux administrateurs.
Context
Avec l'introduction de la nouvelle route DELETE /comments/event/:eventId, il est essentiel de mettre à jour la documentation de l'API pour que les développeurs puissent comprendre comment utiliser cette fonctionnalité correctement.
Objectives
Acceptance Criteria
Tasks
API_DOCUMENTATION.md
.Resources
UML Diagrams References
Branch Name
docs/207-update-api-doc-delete-comments-by-event-id
Complementary Suggested Tasks