diff --git a/docs/api_data.js b/docs/api_data.js index 6f0166d..6b70267 100644 --- a/docs/api_data.js +++ b/docs/api_data.js @@ -2,7 +2,7 @@ define({ "api": [ { "type": "post", "url": "/auth/login", - "title": "Request JWT token", + "title": "Get access token", "name": "Login", "group": "Auth", "parameter": { @@ -32,7 +32,7 @@ define({ "api": [ "group": "Success 200", "type": "string", "optional": false, - "field": "jwt", + "field": "jwt_token", "description": "

JWT token.

" } ] @@ -125,28 +125,18 @@ define({ "api": [ { "type": "delete", "url": "/note/:id", - "title": "Delete a note", + "title": "Delete note", "name": "DeleteNote", "group": "Note", - "version": "0.0.0", - "filename": "app/routes/note/index.js", - "groupTitle": "Note" - }, - { - "type": "get", - "url": "/note", - "title": "Request all notes", - "name": "GetNotes", - "group": "Note", - "success": { + "parameter": { "fields": { - "Success 200": [ + "Parameter": [ { - "group": "Success 200", - "type": "Array", + "group": "Parameter", + "type": "String", "optional": false, - "field": "Array", - "description": "

Array of Note objects.

" + "field": "id", + "description": "

Note unique ID.

" } ] } @@ -158,7 +148,7 @@ define({ "api": [ { "type": "get", "url": "/note/:id", - "title": "Request Note information", + "title": "Get note", "name": "GetNotes", "group": "Note", "parameter": { @@ -166,10 +156,10 @@ define({ "api": [ "Parameter": [ { "group": "Parameter", - "type": "Number", + "type": "String", "optional": false, "field": "id", - "description": "

Notes unique ID.

" + "description": "

Note unique ID.

" } ] } @@ -198,89 +188,48 @@ define({ "api": [ "filename": "app/routes/note/index.js", "groupTitle": "Note" }, + { + "type": "put", + "url": "/note/:id", + "title": "Update note", + "name": "UpdateNote", + "group": "Note", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "id", + "description": "

Note unique ID.

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "Object", + "description": "

Updated note.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/note/index.js", + "groupTitle": "Note" + }, { "type": "delete", "url": "/user/me", - "title": "Delete current account", + "title": "Delete 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", - "title": "Request User information", - "name": "GetUser", - "group": "User", - "parameter": { - "fields": { - "Parameter": [ - { - "group": "Parameter", - "type": "Number", - "optional": false, - "field": "id", - "description": "

Users unique ID.

" - } - ] - } - }, - "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" @@ -288,7 +237,7 @@ define({ "api": [ { "type": "get", "url": "/user/me", - "title": "Request current account information", + "title": "Get user information", "name": "GetUser", "group": "User", "success": { @@ -322,71 +271,21 @@ define({ "api": [ "filename": "app/routes/user/index.js", "groupTitle": "User" }, - { - "type": "get", - "url": "/user", - "title": "Request all Users information", - "name": "GetUsers", - "group": "User", - "parameter": { - "fields": { - "Parameter": [ - { - "group": "Parameter", - "type": "Number", - "optional": false, - "field": "id", - "description": "

Users unique ID.

" - } - ] - } - }, - "success": { - "fields": { - "Success 200": [ - { - "group": "Success 200", - "type": "Array", - "optional": false, - "field": "Array", - "description": "

User objects.

" - } - ] - } - }, - "version": "0.0.0", - "filename": "app/routes/user/index.js", - "groupTitle": "User" - }, { "type": "put", "url": "/user/me", - "title": "Update current account information", + "title": "Update account information", "name": "UpdateUser", "group": "User", - "parameter": { + "success": { "fields": { - "Parameter": [ + "Success 200": [ { - "group": "Parameter", - "type": "String", + "group": "Success 200", + "type": "Object", "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.

" + "field": "user", + "description": "

User object.

" } ] } @@ -398,31 +297,24 @@ define({ "api": [ { "type": "get", "url": "/user/me/notes", - "title": "Get notes created by this account", - "name": "GetNotes", - "group": "User_Note", + "title": "Get all notes", + "name": "GetNotesByUserId", + "group": "User_notes", "success": { "fields": { "Success 200": [ { "group": "Success 200", - "type": "string", + "type": "Array", "optional": false, - "field": "title", - "description": "

Title of the note.

" - }, - { - "group": "Success 200", - "type": "string", - "optional": false, - "field": "text", - "description": "

Text of the note.

" + "field": "Array", + "description": "

Notes of the user.

" } ] } }, "version": "0.0.0", "filename": "app/routes/user/index.js", - "groupTitle": "User_Note" + "groupTitle": "User_notes" } ] }); diff --git a/docs/api_data.json b/docs/api_data.json index da25f47..0c657a3 100644 --- a/docs/api_data.json +++ b/docs/api_data.json @@ -2,7 +2,7 @@ { "type": "post", "url": "/auth/login", - "title": "Request JWT token", + "title": "Get access token", "name": "Login", "group": "Auth", "parameter": { @@ -32,7 +32,7 @@ "group": "Success 200", "type": "string", "optional": false, - "field": "jwt", + "field": "jwt_token", "description": "

JWT token.

" } ] @@ -125,28 +125,18 @@ { "type": "delete", "url": "/note/:id", - "title": "Delete a note", + "title": "Delete note", "name": "DeleteNote", "group": "Note", - "version": "0.0.0", - "filename": "app/routes/note/index.js", - "groupTitle": "Note" - }, - { - "type": "get", - "url": "/note", - "title": "Request all notes", - "name": "GetNotes", - "group": "Note", - "success": { + "parameter": { "fields": { - "Success 200": [ + "Parameter": [ { - "group": "Success 200", - "type": "Array", + "group": "Parameter", + "type": "String", "optional": false, - "field": "Array", - "description": "

Array of Note objects.

" + "field": "id", + "description": "

Note unique ID.

" } ] } @@ -158,7 +148,7 @@ { "type": "get", "url": "/note/:id", - "title": "Request Note information", + "title": "Get note", "name": "GetNotes", "group": "Note", "parameter": { @@ -166,10 +156,10 @@ "Parameter": [ { "group": "Parameter", - "type": "Number", + "type": "String", "optional": false, "field": "id", - "description": "

Notes unique ID.

" + "description": "

Note unique ID.

" } ] } @@ -198,89 +188,48 @@ "filename": "app/routes/note/index.js", "groupTitle": "Note" }, + { + "type": "put", + "url": "/note/:id", + "title": "Update note", + "name": "UpdateNote", + "group": "Note", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "id", + "description": "

Note unique ID.

" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "Object", + "description": "

Updated note.

" + } + ] + } + }, + "version": "0.0.0", + "filename": "app/routes/note/index.js", + "groupTitle": "Note" + }, { "type": "delete", "url": "/user/me", - "title": "Delete current account", + "title": "Delete 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", - "title": "Request User information", - "name": "GetUser", - "group": "User", - "parameter": { - "fields": { - "Parameter": [ - { - "group": "Parameter", - "type": "Number", - "optional": false, - "field": "id", - "description": "

Users unique ID.

" - } - ] - } - }, - "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" @@ -288,7 +237,7 @@ { "type": "get", "url": "/user/me", - "title": "Request current account information", + "title": "Get user information", "name": "GetUser", "group": "User", "success": { @@ -322,71 +271,21 @@ "filename": "app/routes/user/index.js", "groupTitle": "User" }, - { - "type": "get", - "url": "/user", - "title": "Request all Users information", - "name": "GetUsers", - "group": "User", - "parameter": { - "fields": { - "Parameter": [ - { - "group": "Parameter", - "type": "Number", - "optional": false, - "field": "id", - "description": "

Users unique ID.

" - } - ] - } - }, - "success": { - "fields": { - "Success 200": [ - { - "group": "Success 200", - "type": "Array", - "optional": false, - "field": "Array", - "description": "

User objects.

" - } - ] - } - }, - "version": "0.0.0", - "filename": "app/routes/user/index.js", - "groupTitle": "User" - }, { "type": "put", "url": "/user/me", - "title": "Update current account information", + "title": "Update account information", "name": "UpdateUser", "group": "User", - "parameter": { + "success": { "fields": { - "Parameter": [ + "Success 200": [ { - "group": "Parameter", - "type": "String", + "group": "Success 200", + "type": "Object", "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.

" + "field": "user", + "description": "

User object.

" } ] } @@ -398,31 +297,24 @@ { "type": "get", "url": "/user/me/notes", - "title": "Get notes created by this account", - "name": "GetNotes", - "group": "User_Note", + "title": "Get all notes", + "name": "GetNotesByUserId", + "group": "User_notes", "success": { "fields": { "Success 200": [ { "group": "Success 200", - "type": "string", + "type": "Array", "optional": false, - "field": "title", - "description": "

Title of the note.

" - }, - { - "group": "Success 200", - "type": "string", - "optional": false, - "field": "text", - "description": "

Text of the note.

" + "field": "Array", + "description": "

Notes of the user.

" } ] } }, "version": "0.0.0", "filename": "app/routes/user/index.js", - "groupTitle": "User_Note" + "groupTitle": "User_notes" } ] diff --git a/docs/api_project.js b/docs/api_project.js index a71dc02..9efd796 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-12T17:15:53.319Z", + "time": "2018-11-14T16:18:06.827Z", "url": "http://apidocjs.com", "version": "0.17.7" } diff --git a/docs/api_project.json b/docs/api_project.json index 96d6d09..2d6ea5e 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-12T17:15:53.319Z", + "time": "2018-11-14T16:18:06.827Z", "url": "http://apidocjs.com", "version": "0.17.7" }