From 42993f9404ee29933324895107b285f08c139a38 Mon Sep 17 00:00:00 2001 From: Hubert Van De Walle Date: Sun, 19 Apr 2020 20:12:26 +0200 Subject: [PATCH 1/2] Update docs --- api-doc/notes/index.apib | 55 +++++++++++++++++++++++++++++---------- api-doc/users/index.apib | 2 +- docs/index.html | 56 +++++++++++++++++++++++++++------------- 3 files changed, 81 insertions(+), 32 deletions(-) diff --git a/api-doc/notes/index.apib b/api-doc/notes/index.apib index 4e39663..2eac700 100644 --- a/api-doc/notes/index.apib +++ b/api-doc/notes/index.apib @@ -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 \ No newline at end of file ++ 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) diff --git a/api-doc/users/index.apib b/api-doc/users/index.apib index 0a2237c..126ce93 100644 --- a/api-doc/users/index.apib +++ b/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) diff --git a/docs/index.html b/docs/index.html index a981db6..a0b1849 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,6 +1,6 @@ -Notes API Back to top

Notes API

Accounts

Create an account

Register a new user
POST/register

Example URI

POST http://localhost:5000/register
Request
HideShow
Headers
Content-Type: application/json
Body
{
+Notes API Back to top
Notes API
Accounts 
Create an account 
Register a new user
POST/register
Example URI
POST http://localhost:5000/register
Request
HideShow
Headers
Content-Type: application/json
Body
{
   "username": "babar",
-  "email": "michel@seed",
+  "email": "michel@seed-it.eu",
   "password": "tortue"
 }
Schema
{
   "$schema": "http://json-schema.org/draft-04/schema#",
@@ -10,8 +10,7 @@
       "type": "string"
     },
     "email": {
-      "type": "string",
-      "description": "it.eu (string)"
+      "type": "string"
     },
     "password": {
       "type": "string"
@@ -172,26 +171,47 @@
       "type": "array"
     }
   }
-}
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
{
-  "chapters": [
-    {
-      "title": "Introduction",
-      "content": "..."
-    },
-    {
-      "title": "Objects",
-      "content": "..."
-    }
-  ]
+}
Response  200
Response  404
Chapters 
Post a chapter
POST/notes/{noteTitle}/chapters/{chapterNumber}
Example URI
POST http://localhost:5000/notes/Kotlin/chapters/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin
The title of the Note.

+
chapterNumber
number (required) Example: Kotlin
The chapter number.

+
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
{
+  "title": "Chapter 1",
+  "content": "..."
 }
Schema
{
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "properties": {
-    "chapters": {
-      "type": "array"
+    "title": {
+      "type": "string"
+    },
+    "content": {
+      "type": "string"
     }
   }
-}
Response  200
Response  404
Tags 
Tags 
Get all tags
GET/tags
Example URI
GET http://localhost:5000/tags
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
+}
Delete a chapter
DELETE/notes/{noteTitle}/chapters/{chapterNumber}
Example URI
DELETE http://localhost:5000/notes/Kotlin/chapters/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin
The title of the Note.

+
chapterNumber
number (required) Example: Kotlin
The chapter number.

+
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
Response  404
Patch a chapter
PATCH/notes/{noteTitle}/chapters/{chapterNumber}
Example URI
PATCH http://localhost:5000/notes/Kotlin/chapters/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin
The title of the Note.

+
chapterNumber
number (required) Example: Kotlin
The chapter number.

+
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
{
+  "title": "new title"
+}
Schema
{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "title": {
+      "type": "string"
+    }
+  }
+}
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
{
+  "content": "..."
+}
Schema
{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "content": {
+      "type": "string"
+    }
+  }
+}
Tags 
Tags 
Get all tags
GET/tags
Example URI
GET http://localhost:5000/tags
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
   "tags": [
     "Dev",
     "Server"

From 16b9fe3f500c9c89a7966ca6097183d6cc0aa4a3 Mon Sep 17 00:00:00 2001
From: Hubert Van De Walle 
Date: Sun, 19 Apr 2020 20:24:49 +0200
Subject: [PATCH 2/2] Update docs

---
 api-doc/notes/index.apib | 69 ++++++++++++++++++++++++----------------
 docs/index.html          | 51 ++++++++++++++---------------
 2 files changed, 65 insertions(+), 55 deletions(-)

diff --git a/api-doc/notes/index.apib b/api-doc/notes/index.apib
index 2eac700..95a9892 100644
--- a/api-doc/notes/index.apib
+++ b/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]
 
@@ -97,6 +90,17 @@
 
 + 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
@@ -111,14 +115,8 @@
     + 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 201
 
 + Response 404
 
@@ -137,3 +135,18 @@
 
     + 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
diff --git a/docs/index.html b/docs/index.html
index a0b1849..77ea8f1 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,4 +1,4 @@
-Notes API Back to top
Notes API
Accounts 
Create an account 
Register a new user
POST/register
Example URI
POST http://localhost:5000/register
Request
HideShow
Headers
Content-Type: application/json
Body
{
+Notes API Back to top
Notes API
Accounts 
Create an account 
Register a new user
POST/register
Example URI
POST http://localhost:5000/register
Request
HideShow
Headers
Content-Type: application/json
Body
{
   "username": "babar",
   "email": "michel@seed-it.eu",
   "password": "tortue"
@@ -79,24 +79,7 @@
       "type": "number"
     }
   }
-}
Notes 
Notes 
Create a Note
POST/notes
Example URI
POST http://localhost:5000/notes
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
{
-  "title": "Kotlin",
-  "tags": [
-    "Dev",
-    "Server"
-  ]
-}
Schema
{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "properties": {
-    "title": {
-      "type": "string"
-    },
-    "tags": {
-      "type": "array"
-    }
-  }
-}
Response  200
Get Notes
GET/notes
Example URI
GET http://localhost:5000/notes
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
+}
Notes 
Notes 
Get Notes
GET/notes
Example URI
GET http://localhost:5000/notes
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
   {
     "title": "Kotlin",
     "tags": [
@@ -115,7 +98,21 @@
 ]
Schema
{
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "array"
-}
Note 
Get Note
GET/notes/{noteTitle}
Example URI
GET http://localhost:5000/notes/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin
The title of the Note.

+}
Note 
Create a Note
POST/notes/{noteTitle}
Example URI
POST http://localhost:5000/notes/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin
The title of the Note.

+
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
{
+  "tags": [
+    "Dev",
+    "Server"
+  ]
+}
Schema
{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "tags": {
+      "type": "array"
+    }
+  }
+}
Response  201
Response  409
Get Note
GET/notes/{noteTitle}
Example URI
GET http://localhost:5000/notes/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin
The title of the Note.

 
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
   "title": "Kotlin",
   "tags": [
@@ -146,8 +143,7 @@
       "type": "array"
     }
   }
-}
Response  404
Delete Note
DELETE/notes/{noteTitle}
Example URI
DELETE http://localhost:5000/notes/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin
The title of the Note.

-
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  204
Response  404
Update a Note
PATCH/notes/{noteTitle}
Example URI
PATCH http://localhost:5000/notes/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin
The title of the Note.

+}
Response  404
Update a Note
PATCH/notes/{noteTitle}
Example URI
PATCH http://localhost:5000/notes/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin
The title of the Note.

 
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
{
   "title": "NewTitle"
 }
Schema
{
@@ -171,7 +167,8 @@
       "type": "array"
     }
   }
-}
Response  200
Response  404
Chapters 
Post a chapter
POST/notes/{noteTitle}/chapters/{chapterNumber}
Example URI
POST http://localhost:5000/notes/Kotlin/chapters/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin
The title of the Note.

+}
Response  200
Response  404

Delete Note
DELETE/notes/{noteTitle}

Example URI

DELETE http://localhost:5000/notes/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin

The title of the Note.

+
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
Response  404

Chapters

Post a chapter
POST/notes/{noteTitle}/chapters/{chapterNumber}

Example URI

POST http://localhost:5000/notes/Kotlin/chapters/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin

The title of the Note.

chapterNumber
number (required) Example: Kotlin

The chapter number.

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
{
   "title": "Chapter 1",
@@ -187,9 +184,7 @@
       "type": "string"
     }
   }
-}

Delete a chapter
DELETE/notes/{noteTitle}/chapters/{chapterNumber}

Example URI

DELETE http://localhost:5000/notes/Kotlin/chapters/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin

The title of the Note.

-
chapterNumber
number (required) Example: Kotlin

The chapter number.

-
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
Response  404

Patch a chapter
PATCH/notes/{noteTitle}/chapters/{chapterNumber}

Example URI

PATCH http://localhost:5000/notes/Kotlin/chapters/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin

The title of the Note.

+}
Response  201
Response  404

Patch a chapter
PATCH/notes/{noteTitle}/chapters/{chapterNumber}

Example URI

PATCH http://localhost:5000/notes/Kotlin/chapters/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin

The title of the Note.

chapterNumber
number (required) Example: Kotlin

The chapter number.

Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Body
{
   "title": "new title"
@@ -211,7 +206,9 @@
       "type": "string"
     }
   }
-}

Tags

Tags

Get all tags
GET/tags

Example URI

GET http://localhost:5000/tags
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
+}
Response  200
Response  404

Delete a chapter
DELETE/notes/{noteTitle}/chapters/{chapterNumber}

Example URI

DELETE http://localhost:5000/notes/Kotlin/chapters/Kotlin
URI Parameters
HideShow
noteTitle
string (required) Example: Kotlin

The title of the Note.

+
chapterNumber
number (required) Example: Kotlin

The chapter number.

+
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
Response  404

Tags

Tags

Get all tags
GET/tags

Example URI

GET http://localhost:5000/tags
Request
HideShow
Headers
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
   "tags": [
     "Dev",
     "Server"