feat(docs): add detailed features and business flow diagrams
- Introduced new interaction and community features, including comments and private messaging. - Added technical diagrams for critical workflows: authentication, content publication, and messaging. - Enhanced data model documentation with support for comments and messaging tables. - Updated API references with endpoints for comments, messaging, and user search. - Integrated post-quantum cryptography for improved data protection.
This commit is contained in:
@@ -216,6 +216,16 @@ Cette page documente tous les points de terminaison disponibles sur l'API Memego
|
||||
- `200 OK` : 2FA désactivée.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="GET /users/search">
|
||||
Recherche des utilisateurs par leur nom d'utilisateur ou nom d'affichage. Requiert l'authentification.
|
||||
|
||||
**Query Params :**
|
||||
- `q` (string) : Terme de recherche.
|
||||
|
||||
**Réponses :**
|
||||
- `200 OK` : Liste des utilisateurs correspondants.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="GET /users/admin">
|
||||
Liste tous les utilisateurs. **Réservé aux administrateurs.**
|
||||
|
||||
@@ -406,6 +416,92 @@ Cette page documente tous les points de terminaison disponibles sur l'API Memego
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### 💬 Commentaires (`/comments` & `/contents/:id/comments`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="GET /contents/:contentId/comments">
|
||||
Liste les commentaires d'un contenu.
|
||||
|
||||
**Réponses :**
|
||||
- `200 OK` : Liste des commentaires, incluant l'auteur et si l'utilisateur actuel a aimé le commentaire.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="POST /contents/:contentId/comments">
|
||||
Ajoute un commentaire à un contenu. Requiert l'authentification.
|
||||
|
||||
**Corps de la requête :**
|
||||
- `text` (string) : Contenu du commentaire.
|
||||
- `parentId` (uuid, optional) : ID du commentaire parent pour les réponses.
|
||||
|
||||
**Réponses :**
|
||||
- `201 Created` : Commentaire ajouté.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="DELETE /comments/:id">
|
||||
Supprime un commentaire. L'utilisateur doit être l'auteur ou un modérateur/admin.
|
||||
|
||||
**Réponses :**
|
||||
- `200 OK` : Commentaire supprimé.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="POST /comments/:id/like">
|
||||
Ajoute un "like" à un commentaire. Requiert l'authentification.
|
||||
|
||||
**Réponses :**
|
||||
- `201 Created` : Like ajouté.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="DELETE /comments/:id/like">
|
||||
Retire un "like" d'un commentaire. Requiert l'authentification.
|
||||
|
||||
**Réponses :**
|
||||
- `200 OK` : Like retiré.
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### ✉️ Messagerie (`/messages`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="GET /messages/conversations">
|
||||
Liste les conversations de l'utilisateur connecté. Requiert l'authentification.
|
||||
|
||||
**Réponses :**
|
||||
- `200 OK` : Liste des conversations avec le dernier message et le nombre de messages non lus.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="GET /messages/unread-count">
|
||||
Récupère le nombre total de messages non lus pour l'utilisateur. Requiert l'authentification.
|
||||
|
||||
**Réponses :**
|
||||
- `200 OK` : `{ "count": number }`.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="GET /messages/conversations/with/:userId">
|
||||
Récupère ou crée une conversation avec un utilisateur spécifique. Requiert l'authentification.
|
||||
|
||||
**Réponses :**
|
||||
- `200 OK` : Objet conversation.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="GET /messages/conversations/:id">
|
||||
Récupère les messages d'une conversation. Marque les messages comme lus. Requiert l'authentification.
|
||||
|
||||
**Réponses :**
|
||||
- `200 OK` : Liste des messages.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="POST /messages">
|
||||
Envoie un message. Requiert l'authentification.
|
||||
|
||||
**Corps de la requête :**
|
||||
- `recipientId` (uuid) : ID du destinataire.
|
||||
- `text` (string) : Contenu du message.
|
||||
|
||||
**Réponses :**
|
||||
- `201 Created` : Message envoyé.
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### ⭐ Favoris (`/favorites`)
|
||||
|
||||
<Accordions>
|
||||
|
||||
Reference in New Issue
Block a user