doc: api decks

Author: peterpeterparker

studio/docs/api.md

@@ -2,14 +2,14 @@
 
 ## List of endpoints
 
-| Endpoint | Guard | Details | Frontend`*` | Backend`*` |
-|---|---|---|---|---|
-| login | X | [Link](#login) |   |   |
-| logout | X | [Link](#logout)  |   |   |
-| decks | X |   |   |   |
-| slides | X |   |   |   |
-| publish | X |   |   |   |
-| feed |   |   |   |   |
+| Endpoint | Guard | Details | Frontend`*` | Backend`*` | Notes |
+|---|---|---|---|---|---|
+| login | X | [Link](#login) |   |   |   |
+| logout | X | [Link](#logout)  |   |   |   |
+| decks | X | [Link](#decks)  | POST PUT | POST PUT | Meta still TODO |
+| slides | X |   |   |   |   |
+| publish | X |   |   |   |   |
+| feed |   |   |   |   |   |
 
 `*`: already implemented in
 
@@ -19,8 +19,9 @@
 |-------------|-------------|
 | Title | Login |
 | Description | Verify Google ID Token, create or update user, convert anonymous data to "real" user |
+| URL | /login |
 | Reference | [https://firebase.google.com/docs/auth/admin/verify-id-tokens](https://firebase.google.com/docs/auth/admin/verify-id-tokens) |
-| Method | Post |
+| Method | POST |
 | Body | token (?) |
 | Success Response | `{backend_token: string}` |
 
@@ -29,6 +30,8 @@
 ```
 export interface User {
     token: string;
+    
+    backend_token: string;
 
     anonymous: boolean;
 
@@ -42,6 +45,10 @@ export interface User {
 }
 ```
 
+* Questions:
+
+- in the definition add `backend_user_id`?
+
 * Notes
 
 - If *verify-id-tokens* from Google doesn't return user data on the backend side, user data has to be provided as body of the request
@@ -54,10 +61,51 @@ export interface User {
 |-------------|-------------|
 | Title | Logout |
 | Description | Invalidate backend token |
-| Method | Post |
+| URL | /logout |
+| Method | POST |
 | Body | token (?) |
 
 * Notes
 
 - should we also add a status on the user data and therefore set the status to `inactive` or else on logout?
 
+### Decks
+
+| <!-- -->    | <!-- -->    |
+|-------------|-------------|
+| Title | Decks |
+| Description | The decks, the presentation entities |
+| URL | /decks |
+| Method | POST PUT DELETE |
+| Body | see sample |
+
+* Sample
+
+```
+export interface Meta {
+    meta_id?: string;
+    
+    description?: string;
+    author?: string;
+    
+    image_url?: string;
+    
+    created_at: Date;
+    updated_at: Date;
+
+}
+
+export interface Deck {
+    deck_id?: string;
+    deck_slides: string[];
+    
+    meta: Meta;
+    
+    created_at: Date;
+    updated_at: Date;
+}
+```
+
+Questions:
+
+- do we want to duplicate the author name (= user name) in the meta data? for performance reason maybe?