diff --git a/docs/api_data.js b/docs/api_data.js index 994318b..6f0166d 100644 --- a/docs/api_data.js +++ b/docs/api_data.js @@ -1,4 +1,137 @@ define({ "api": [ + { + "type": "post", + "url": "/auth/login", + "title": "Request JWT token", + "name": "Login", + "group": "Auth", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "username", + "description": "
username of the user.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "password", + "description": "password of the user.
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "jwt", + "description": "JWT token.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/auth/index.js", + "groupTitle": "Auth" + }, + { + "type": "post", + "url": "/auth/register", + "title": "Register", + "name": "Register", + "group": "Auth", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "firstname", + "description": "Firstname of the user.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "lastname", + "description": "Lastname of the user.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "username", + "description": "username of the user.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "password", + "description": "password of the user.
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Array", + "optional": false, + "field": "Array", + "description": "Array of Note objects.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/auth/index.js", + "groupTitle": "Auth" + }, + { + "type": "post", + "url": "/note", + "title": "Create note", + "name": "CreateNote", + "group": "Note", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "Object", + "description": "Created note.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/note/index.js", + "groupTitle": "Note" + }, + { + "type": "delete", + "url": "/note/:id", + "title": "Delete a note", + "name": "DeleteNote", + "group": "Note", + "version": "0.0.0", + "filename": "app/routes/note/index.js", + "groupTitle": "Note" + }, { "type": "get", "url": "/note", @@ -65,6 +198,43 @@ define({ "api": [ "filename": "app/routes/note/index.js", "groupTitle": "Note" }, + { + "type": "delete", + "url": "/user/me", + "title": "Delete current account", + "name": "DeleteUser", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "firstname", + "description": "Firstname of the User.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "lastname", + "description": "Lastname of the User.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "username", + "description": "Username of the User.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/user/index.js", + "groupTitle": "User" + }, { "type": "get", "url": "/user/:id", @@ -115,6 +285,43 @@ define({ "api": [ "filename": "app/routes/user/index.js", "groupTitle": "User" }, + { + "type": "get", + "url": "/user/me", + "title": "Request current account information", + "name": "GetUser", + "group": "User", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "firstname", + "description": "Firstname of the User.
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "lastname", + "description": "Lastname of the User.
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "username", + "description": "Username of the User.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/user/index.js", + "groupTitle": "User" + }, { "type": "get", "url": "/user", @@ -142,7 +349,7 @@ define({ "api": [ "type": "Array", "optional": false, "field": "Array", - "description": "Array of User objects.
" + "description": "User objects.
" } ] } @@ -150,5 +357,72 @@ define({ "api": [ "version": "0.0.0", "filename": "app/routes/user/index.js", "groupTitle": "User" + }, + { + "type": "put", + "url": "/user/me", + "title": "Update current account information", + "name": "UpdateUser", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "firstname", + "description": "Firstname of the User.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "lastname", + "description": "Lastname of the User.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "username", + "description": "Username of the User.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/user/index.js", + "groupTitle": "User" + }, + { + "type": "get", + "url": "/user/me/notes", + "title": "Get notes created by this account", + "name": "GetNotes", + "group": "User_Note", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "title", + "description": "Title of the note.
" + }, + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "text", + "description": "Text of the note.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/user/index.js", + "groupTitle": "User_Note" } ] }); diff --git a/docs/api_data.json b/docs/api_data.json index 8a28812..da25f47 100644 --- a/docs/api_data.json +++ b/docs/api_data.json @@ -1,4 +1,137 @@ [ + { + "type": "post", + "url": "/auth/login", + "title": "Request JWT token", + "name": "Login", + "group": "Auth", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "username", + "description": "username of the user.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "password", + "description": "password of the user.
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "jwt", + "description": "JWT token.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/auth/index.js", + "groupTitle": "Auth" + }, + { + "type": "post", + "url": "/auth/register", + "title": "Register", + "name": "Register", + "group": "Auth", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "firstname", + "description": "Firstname of the user.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "lastname", + "description": "Lastname of the user.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "username", + "description": "username of the user.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "password", + "description": "password of the user.
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Array", + "optional": false, + "field": "Array", + "description": "Array of Note objects.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/auth/index.js", + "groupTitle": "Auth" + }, + { + "type": "post", + "url": "/note", + "title": "Create note", + "name": "CreateNote", + "group": "Note", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "Object", + "description": "Created note.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/note/index.js", + "groupTitle": "Note" + }, + { + "type": "delete", + "url": "/note/:id", + "title": "Delete a note", + "name": "DeleteNote", + "group": "Note", + "version": "0.0.0", + "filename": "app/routes/note/index.js", + "groupTitle": "Note" + }, { "type": "get", "url": "/note", @@ -65,6 +198,43 @@ "filename": "app/routes/note/index.js", "groupTitle": "Note" }, + { + "type": "delete", + "url": "/user/me", + "title": "Delete current account", + "name": "DeleteUser", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "firstname", + "description": "Firstname of the User.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "lastname", + "description": "Lastname of the User.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "username", + "description": "Username of the User.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/user/index.js", + "groupTitle": "User" + }, { "type": "get", "url": "/user/:id", @@ -115,6 +285,43 @@ "filename": "app/routes/user/index.js", "groupTitle": "User" }, + { + "type": "get", + "url": "/user/me", + "title": "Request current account information", + "name": "GetUser", + "group": "User", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "firstname", + "description": "Firstname of the User.
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "lastname", + "description": "Lastname of the User.
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "username", + "description": "Username of the User.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/user/index.js", + "groupTitle": "User" + }, { "type": "get", "url": "/user", @@ -142,7 +349,7 @@ "type": "Array", "optional": false, "field": "Array", - "description": "Array of User objects.
" + "description": "User objects.
" } ] } @@ -150,5 +357,72 @@ "version": "0.0.0", "filename": "app/routes/user/index.js", "groupTitle": "User" + }, + { + "type": "put", + "url": "/user/me", + "title": "Update current account information", + "name": "UpdateUser", + "group": "User", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "firstname", + "description": "Firstname of the User.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "lastname", + "description": "Lastname of the User.
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "username", + "description": "Username of the User.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/user/index.js", + "groupTitle": "User" + }, + { + "type": "get", + "url": "/user/me/notes", + "title": "Get notes created by this account", + "name": "GetNotes", + "group": "User_Note", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "title", + "description": "Title of the note.
" + }, + { + "group": "Success 200", + "type": "string", + "optional": false, + "field": "text", + "description": "Text of the note.
" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/user/index.js", + "groupTitle": "User_Note" } ] diff --git a/docs/api_project.js b/docs/api_project.js index 823e5e8..a71dc02 100644 --- a/docs/api_project.js +++ b/docs/api_project.js @@ -8,7 +8,7 @@ define({ "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2018-11-12T15:27:44.007Z", + "time": "2018-11-12T17:15:53.319Z", "url": "http://apidocjs.com", "version": "0.17.7" } diff --git a/docs/api_project.json b/docs/api_project.json index 1fa8c5f..96d6d09 100644 --- a/docs/api_project.json +++ b/docs/api_project.json @@ -8,7 +8,7 @@ "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2018-11-12T15:27:44.007Z", + "time": "2018-11-12T17:15:53.319Z", "url": "http://apidocjs.com", "version": "0.17.7" }