Merge branch 'documentation/api-doc'

api-doc/notes/index.apib

@@ -9,18 +9,6 @@
 
 ## Notes [/notes]
 
-### Create a Note [POST]
-
-+ Request (application/json)
-    + Headers
-        Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
-        
-    + Attributes (object)
-        + title: Kotlin (string)
-        + tags: Dev, Server (array[string])
-      
-+ Response 200
-
 ### Get Notes [GET]
 
 + Request (application/json)
@@ -45,6 +33,19 @@
 + Parameters
    + noteTitle: `Kotlin` (string) - The title of the Note.
 
+### Create a Note [POST]
+
++ Request (application/json)
+    + Headers
+        Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+        
+    + Attributes (object)
+        + tags: Dev, Server (array[string])
+      
++ Response 201
+
++ Response 409
+
 ### Get Note [GET]
 
 + Request (application/json)
@@ -64,16 +65,8 @@
                 + content: ...
                 
 + Response 404
-                
-### Delete Note [DELETE]
 
-+ Request (application/json)
-   + Headers
-       Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
-        
-+ Response 204
 
-+ Response 404
 
 ### Update a Note [PATCH]
 
@@ -92,19 +85,68 @@
    + Attributes (object)
        + tags: new, tags (array[string])
     
-+ Request (application/json)
-   + Headers
-       Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
-
-    + Attributes (object)
-       + chapters (array)
-           + (Chapter)
-               + title: Introduction
-               + content: ...
-           + (Chapter)
-               + title: Objects
-               + content: ...
 
 + Response 200
 
-+ Response 404
++ Response 404
+
+### Delete Note [DELETE]
+
++ Request (application/json)
+   + Headers
+       Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+        
++ Response 200
+
++ Response 404
+
+
+## Chapters [/notes/{noteTitle}/chapters/{chapterNumber}]
+
++ Parameters
+   + noteTitle: `Kotlin` (string) - The title of the Note.
+   + chapterNumber: `Kotlin` (number) - The chapter number.
+
+### Post a chapter [POST]
+
++ Request (application/json)
+    + Headers
+        Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+    + Attributes (Chapter)
+        + title: Chapter 1 (string)
+        + content: ... (string)
+        
++ Response 201
+
++ Response 404
+
+### Patch a chapter [PATCH]
+
++ Request (application/json)
+    + Headers
+        Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+
+    + Attributes (object)
+        + title: new title (string)
+
++ Request (application/json)
+    + Headers
+        Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+
+    + Attributes (object)
+        + content: ... (string)
+        
++ Response 200
+
++ Response 404
+
+
+### Delete a chapter [DELETE]
+
++ Request (application/json)
+    + Headers
+        Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+
++ Response 200
+
++ Response 404

api-doc/users/index.apib

@@ -21,7 +21,7 @@
 + Request (application/json)
     + Attributes (object)
         + username: babar (string)
-        + email: michel@seed-it.eu (string)
+        + email: `michel@seed-it.eu` (string)
         + password: tortue (string)
       
 + Response 200 (application/json)