153 lines
4.3 KiB
Plaintext
153 lines
4.3 KiB
Plaintext
# Data Structures
|
|
|
|
## Chapter (object)
|
|
+ title: Chapter 1 (string)
|
|
+ content: ... (string)
|
|
|
|
|
|
# Group Notes
|
|
|
|
## Notes [/notes]
|
|
|
|
### Get Notes [GET]
|
|
|
|
+ Request (application/json)
|
|
+ Headers
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
|
|
|
|
|
|
+ Response 200 (application/json)
|
|
+ Attributes (array)
|
|
+ (object)
|
|
+ title: Kotlin (string)
|
|
+ tags: Dev, Server (array[string])
|
|
+ updatedAt: `2020-01-20T00:00:00` (string)
|
|
+ (object)
|
|
+ title: Java (string)
|
|
+ tags: Dev (array[string])
|
|
+ updatedAt: `2018-01-20T00:00:00` (string)
|
|
|
|
|
|
## Note [/notes/{noteTitle}]
|
|
|
|
+ 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)
|
|
+ Headers
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
|
|
|
|
+ Response 200 (application/json)
|
|
+ Attributes (object)
|
|
+ title: Kotlin (string)
|
|
+ tags: Dev, Server (array[string])
|
|
+ chapters (array)
|
|
+ (Chapter)
|
|
+ title: Introduction
|
|
+ content: ...
|
|
+ (Chapter)
|
|
+ title: Objects
|
|
+ content: ...
|
|
|
|
+ Response 404
|
|
|
|
|
|
|
|
### Update a Note [PATCH]
|
|
|
|
+ Request (application/json)
|
|
+ Headers
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
|
|
|
|
+ Attributes (object)
|
|
+ title: NewTitle (string)
|
|
|
|
|
|
+ Request (application/json)
|
|
+ Headers
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
|
|
|
|
+ Attributes (object)
|
|
+ tags: new, tags (array[string])
|
|
|
|
|
|
+ Response 200
|
|
|
|
+ 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
|