Update docs

2020-04-19 20:12:26 +02:00
parent 6af55ce61d
commit 42993f9404
3 changed files with 81 additions and 32 deletions
@@ -92,19 +92,48 @@
   + 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
+
+## 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)
+
+### Delete a chapter [DELETE]
+
+ Request (application/json)
+    + Headers
+        Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+
+ Response 200
+
+ 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)