docs/update-api-doc-for-get-comments-route

[benoit-bremaud]

Summary

Mettre à jour la documentation de l'API pour inclure la nouvelle route GET /comments. Cette issue est liée à l'implémentation de la nouvelle route permettant aux administrateurs de récupérer tous les commentaires.

Context

Pour s'assurer que les utilisateurs et les développeurs comprennent comment utiliser la nouvelle route GET /comments, 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.
• 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.
• La documentation doit décrire les paramètres requis (headers d'authentification).
• 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 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.

Resources

• Swagger Documentation
• Postman API Documentation
• OpenAPI Specification

UML Diagrams References

• Sequence Diagram : Pour visualiser le flux d'opérations lors de la requête GET /comments.

Branch Name

docs/update-api-doc-for-get-comments-route