From 9c362a10847c3766b4aa0066e1991963747e1950 Mon Sep 17 00:00:00 2001
From: RemRem <remrem@github.com>
Date: Thu, 26 Oct 2023 09:30:06 +0200
Subject: [PATCH] add api description

---
 api.md      | 23 +++++++++++++++++++++++
 database.md |  1 +
 2 files changed, 24 insertions(+)

diff --git a/api.md b/api.md
index 5932792..3fb9710 100644
--- a/api.md
+++ b/api.md
@@ -1 +1,24 @@
 # API
+
+## Links
+- [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete)
+- [HTTP Status Codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status)
+
+## Rappel
+**GET**: Récupère la ressource demandé.
+**HEAD**: GET - body. 
+**POST**: Création d'une ressource envoyé dans le body.
+**PUT**: POST + remplacement.
+**PATCH**: Modification d'une ressource.
+**DELETE**: Supprime la ressource spécifié.
+
+## Endpoints
+POST     /user/                            Création d'un user.
+DELETE   /user/{token}                     Suppression d'un user.
+GET      /user/{uuid}/{hash}/token         Récupération d'un token valide.
+GET      /user/{token}/files               Récupération de la liste des fichier de donnée.
+POST     /user/{token}/files               Upload d'un fichier par un user.
+GET      /user/{token}/files/{file_uuid}   Récupération d'un fichier par user.
+DELETE   /user/{token}/files/{file_uuid}   Suppression d'un fichier par user.
+PUT      /user/{token}/mail                Modification de l'email.
+PUT      /user/{token}/username            Modification du username.
\ No newline at end of file
diff --git a/database.md b/database.md
index 3ebddc4..260d8d5 100644
--- a/database.md
+++ b/database.md
@@ -18,6 +18,7 @@ classDiagram
 
     class File{
         uuid id
+        string title
         date import_date
         blob file
     }