- API
- Description: get all folders
- Success status code:
200 OK
- Description: get the folder by id 'folderId'
- Success status code:
200 OK - Exceptions:
- Description: update the folder by id 'folderId'
- Rename folder
- Move to another parent folder
- Success status code:
200 OK - Exceptions:
Example payload:
{
"updateType": "RENAME_FOLDER",
"newName": "Python"
}{
"updateType": "MOVE_FOLDER",
"toParentId": 2
}- Description: delete the folder by id 'folderId'
- Success status code:
204 NO CONTENT - Exceptions:
- Description: get all sub-folders under the folder by id 'folderId'
- Success status code:
200 OK - Exceptions:
- Description: Create a new folder under the parent folder by id 'folderId'
- Success status code:
201 CREATED - Exceptions:
Example payload:
{
"name": "c++"
}- Description: get all notes under the folder by id 'folderId'
- Success status code:
200 OK - Exceptions:
- Description: Create a note under the folder by id 'folderId'
- Success status code:
201 CREATED - Exceptions:
Example payload:
{
"name": "spring"
}- Description: get all notes
- Success status code:
200 OK
- Description: get the note by id 'noteId'
- Success status code:
200 OK - Exceptions:
- Description: update the note by id 'noteId'
- Rename note
- Modify note content
- Move to another folder
- Add a tag
- Delete a tag
- Success status code:
200 OK - Exceptions:
Example payload:
{
"updateType": "RENAME_NOTE",
"newName": "lalaland"
}{
"updateType": "MODIFY_CONTENT",
"newContent": "Hello, World!"
}{
"updateType": "MOVE_NOTE",
"toFolderId": 2
}{
"updateType": "ADD_TAG",
"tagName": "pl"
}{
"updateType": "REMOVE_TAG",
"tagName": "pl"
}- Description: delete the note by id 'noteId'
- Success status code:
204 NO CONTENT - Exceptions:
- Description: get all tags attached to the note by id 'noteId'
- Success status code:
200 OK
- Description: get all tags
- Success status code:
200 OK
- Description: create a new tag
- Success status code:
201 CREATED - Exceptions:
Example payload:
{
"name": "pl"
}- Description: get the tag by id 'tagId'
- Success status code:
200 OK - Exceptions:
- Description: update the tag by id 'tagId'
- Rename tag
- Success status code:
200 OK - Exceptions:
Example payload:
{
"newName": "ProgrammingLanguage"
}- Description: delete the tag by id 'tagId'
- Success status code:
204 NO CONTENT - Exceptions:
- Description: get all notes by tag id 'tagId'
- Succcess status code:
200 OK