Update docs
This commit is contained in:
parent
6af55ce61d
commit
42993f9404
@ -92,19 +92,48 @@
|
|||||||
+ Attributes (object)
|
+ Attributes (object)
|
||||||
+ tags: new, tags (array[string])
|
+ 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 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)
|
||||||
|
|||||||
@ -21,7 +21,7 @@
|
|||||||
+ Request (application/json)
|
+ Request (application/json)
|
||||||
+ Attributes (object)
|
+ Attributes (object)
|
||||||
+ username: babar (string)
|
+ username: babar (string)
|
||||||
+ email: michel@seed-it.eu (string)
|
+ email: `michel@seed-it.eu` (string)
|
||||||
+ password: tortue (string)
|
+ password: tortue (string)
|
||||||
|
|
||||||
+ Response 200 (application/json)
|
+ Response 200 (application/json)
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
Loading…
x
Reference in New Issue
Block a user