Mettre à jour la documentation de l'API pour inclure la nouvelle route DELETE /comments/user/:userId. Cette mise à jour est nécessaire pour informer les utilisateurs et les développeurs de l'existence de cette route et de son fonctionnement.
Context
La route DELETE /comments/user/:userId permet aux utilisateurs authentifiés de supprimer tous les commentaires d'un utilisateur spécifique en utilisant son ID. Il est crucial de mettre à jour la documentation de l'API pour inclure cette nouvelle fonctionnalité, en décrivant les paramètres requis, les réponses possibles, et en fournissant des exemples d'utilisation.
Objectives
Mettre à jour la documentation de l'API pour inclure la nouvelle route DELETE /comments/user/:userId.
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 DELETE /comments/user/:userId.
La documentation doit décrire les paramètres requis (userId) 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 DELETE /comments/user/:userId 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.
Description:
Summary
Mettre à jour la documentation de l'API pour inclure la nouvelle route
DELETE /comments/user/:userId
. Cette mise à jour est nécessaire pour informer les utilisateurs et les développeurs de l'existence de cette route et de son fonctionnement.Context
La route
DELETE /comments/user/:userId
permet aux utilisateurs authentifiés de supprimer tous les commentaires d'un utilisateur spécifique en utilisant son ID. Il est crucial de mettre à jour la documentation de l'API pour inclure cette nouvelle fonctionnalité, en décrivant les paramètres requis, les réponses possibles, et en fournissant des exemples d'utilisation.Objectives
DELETE /comments/user/:userId
.Acceptance Criteria
DELETE /comments/user/:userId
.userId
) et les en-têtes d'authentification nécessaires.Tasks
DELETE /comments/user/:userId
dans la documentation de l'API.Resources
UML Diagrams References
DELETE /comments/user/:userId
.Branch Name
docs/update-api-doc-for-delete-comments-user-route