hubert/SimpleNotes
1
0
Fork 0
Code Projects Releases Activity

Update docs

Browse Source
This commit is contained in:
Hubert Van De Walle 2020-04-19 20:24:49 +02:00
parent 42993f9404
commit 16b9fe3f50
2 changed files with 65 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
api-doc/notes/index.apib
View File

@ -9,18 +9,6 @@
## Notes [/notes] ## 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] ### Get Notes [GET]
+ Request (application/json) + Request (application/json)
@ -45,6 +33,19 @@
+ Parameters + Parameters
+ noteTitle: `Kotlin` (string) - The title of the Note. + 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] ### Get Note [GET]
+ Request (application/json) + Request (application/json)
@ -64,16 +65,8 @@
+ content: ... + content: ...
+ Response 404 + Response 404
### Delete Note [DELETE]
+ Request (application/json)
+ Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+ Response 204
+ Response 404
### Update a Note [PATCH] ### Update a Note [PATCH]
@ -97,6 +90,17 @@
+ 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}] ## Chapters [/notes/{noteTitle}/chapters/{chapterNumber}]
+ Parameters + Parameters
@ -111,14 +115,8 @@
+ Attributes (Chapter) + Attributes (Chapter)
+ title: Chapter 1 (string) + title: Chapter 1 (string)
+ content: ... (string) + content: ... (string)
### Delete a chapter [DELETE] + Response 201
+ Request (application/json)
+ Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+ Response 200
+ Response 404 + Response 404
@ -137,3 +135,18 @@
+ Attributes (object) + Attributes (object)
+ content: ... (string) + content: ... (string)
+ Response 200
+ Response 404
### Delete a chapter [DELETE]
+ Request (application/json)
+ Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+ Response 200
+ Response 404

51
docs/index.html
View File

File diff suppressed because one or more lines are too long