Update 'api_doc'

api_doc.md

@@ -1,121 +1,122 @@
-# Documentation API
+# Documentation API
-## User
+## User
-### Création du compte
+### Création du compte
-Requete:
+Requete:
-```
+```
-POST /user
+POST /user
-Header(Content-Type: application/json)
+Header(Content-Type: application/json)
-{
+{
-"email":"EMAIL",
+"email":"EMAIL",
-"hash":"HASH",
+"hash":"HASH",
-"username":"USERNAME"
+"username":"USERNAME"
-}
+}
-```
+```
-
+
-Réponse:
+Réponse:
-```
+```
-200 OK + {"token":"TOKEN"}
+200 OK + {"token":"TOKEN"}
-409 CONFLICT - Déja un compte avec cet email
+409 CONFLICT - Déja un compte avec cet email
-400 BAD REQUEST - Json mal formaté
+400 BAD REQUEST - Json mal formaté
-```
+```
-
+
-### Suppression compte
+### Suppression compte
-Requete:
+Requete:
-```
+```
-DELETE /user
+DELETE /user
-Header(Authorization: TOKEN)
+Header(Authorization: TOKEN)
-```
+```
-
+
-Réponse:
+Réponse:
-```
+```
-200 OK
+200 OK
-401 UNAUTHORIZED - Mauvais ou pas de token
+401 UNAUTHORIZED - Mauvais ou pas de token
-404 NOT FOUND - Pas de compte lié
+404 NOT FOUND - Pas de compte lié
-```
+```
-
+
-### Connexion
+### Connexion
-Requete:
+Requete:
-```
+```
-GET /user/login/{email}/{hash}
+GET /user/login/{email}/{hash}
-```
+```
-
+
-Réponse:
+Réponse:
-```
+```
-200 OK + {"token":"TOKEN"}
+200 OK + {"token":"TOKEN"}
-401 UNAUTHORIZED
+401 UNAUTHORIZED
-```
+```
-
+
-### Modification Attribut
+### Modification Attribut
-X peut etre remplacé "email" et "username"
+X peut etre remplacé "email" et "username"
-Requete:
+Requete:
-```
+```
-PUT /user/X
+PUT /user/X
-Header(
+Header(
-Authorization: TOKEN
+Authorization: TOKEN
-Content-Type: application/json)
+Content-Type: application/json)
-{"X":"X"}
+{"X":"X"}
-```
+```
-
+
-Réponse:
+Réponse:
-```
+```
-200 OK
+200 OK
-400 BAD REQUEST
+400 BAD REQUEST
-401 UNAUTHORIZED
+401 UNAUTHORIZED
-```
+```
-
+
-## File
+## File
-### Upload
+### Upload
-Requete:
+Requete:
-```
+```
-POST /user/files
+POST /user/files
-Header(Authorization: TOKEN)
+Header(Authorization: TOKEN)
-```
+https://stackoverflow.com/questions/71424265/how-to-send-multipart-file-with-flutter
-
+```
-Réponse:
+
-```
+Réponse:
-200 OK
+```
-400 BAD REQUEST
+200 OK
-401 UNAUTHORIZED
+400 BAD REQUEST
-409 CONFLICT
+401 UNAUTHORIZED
-```
+409 CONFLICT
-
+```
-### Download
+
-Requete:
+### Download
-```
+Requete:
-GET /user/files/{file_uuid}
+```
-Header(Authorization: TOKEN)
+GET /user/files/{file_uuid}
-```
+Header(Authorization: TOKEN)
-
+```
-Réponse:
+
-```
+Réponse:
-200 OK + Stream du fichier
+```
-401 UNAUTHORIZED
+200 OK + Stream du fichier
-404 NOT FOUND
+401 UNAUTHORIZED
-```
+404 NOT FOUND
-
+```
-### Supprime fichier
+
-Requete:
+### Supprime fichier
-```
+Requete:
-DELETE /user/files/{file_uuid}
+```
-Header(Authorization: TOKEN)
+DELETE /user/files/{file_uuid}
-```
+Header(Authorization: TOKEN)
-
+```
-Réponse:
+
-```
+Réponse:
-200 OK
+```
-401 UNAUTHORIZED
+200 OK
-404 NOT FOUND
+401 UNAUTHORIZED
-```
+404 NOT FOUND
-
+```
-### Liste tout les fichiers
+
-Requete:
+### Liste tout les fichiers
-```
+Requete:
-GET /user/files
+```
-Header(Authorization: TOKEN)
+GET /user/files
-```
+Header(Authorization: TOKEN)
-
+```
-Réponse:
+
-```
+Réponse:
-200 OK + [{"uuid":"UUID", "filename":"FILENAME"}]
+```
-401 UNAUTHORIZED
+200 OK + [{"uuid":"UUID", "filename":"FILENAME"}]
+401 UNAUTHORIZED
 ```