Api doc draft

2020-04-19 18:42:49 +02:00
parent a60fc317f3
commit 6af55ce61d
7 changed files with 628 additions and 8 deletions
@@ -0,0 +1,48 @@
+# Data Structures
+
+## Login (object)
+ username: babar (string)
+ password: tortue (string)
+
+## Token (object)
+ token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c (string)
+
+## InvalidCredentials (object)
+ description: Invalid credentials (string),
+ error: Bad Request (string),
+ status_code: 401 (number)
+
+# Group Accounts
+
+## Create an account [/register]
+
+### Register a new user [POST]
+
+ Request (application/json)
+    + Attributes (object)
+        + username: babar (string)
+        + email: michel@seed-it.eu (string)
+        + password: tortue (string)
+      
+ Response 200 (application/json)
+    + Attributes (object)
+        + message: Created (string)
+
+ Response 409 (application/json)
+    + Attributes (object)
+        + message: User already exists (string)
+
+
+## Authenticate user [/login]
+Authenticate one user to access protected routes.
+
+### Authenticate a user [POST]
+
+ Request (application/json)
+    + Attributes (Login)
+
+ Response 200 (application/json)
+    + Attributes (Token)
+
+ Response 401 (application/json)
+    + Attributes (InvalidCredentials)