sundowndev
/
express-api-example
mirror of https://github.com/sundowndev/express-api-example.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

API docs

develop
sundowndev 2018-11-16 18:18:27 +01:00
parent 1f9bca6641
commit af28952b3a
4 changed files with 84 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/api_data.js
View File

@ -30,7 +30,7 @@ define({ "api": [
"Success 200": [ "Success 200": [
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "access_token", "field": "access_token",
"description": "<p>Access token.</p>" "description": "<p>Access token.</p>"
@ -149,14 +149,14 @@ define({ "api": [
"Success 200": [ "Success 200": [
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "title", "field": "title",
"description": "<p>Title of the note.</p>" "description": "<p>Title of the note.</p>"
}, },
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "text", "field": "text",
"description": "<p>Text of the note.</p>" "description": "<p>Text of the note.</p>"
@ -233,14 +233,14 @@ define({ "api": [
"Success 200": [ "Success 200": [
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "title", "field": "title",
"description": "<p>Title of the note.</p>" "description": "<p>Title of the note.</p>"
}, },
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "text", "field": "text",
"description": "<p>Text of the note.</p>" "description": "<p>Text of the note.</p>"
@ -276,14 +276,14 @@ define({ "api": [
"Success 200": [ "Success 200": [
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "title", "field": "title",
"description": "<p>Title of the note.</p>" "description": "<p>Title of the note.</p>"
}, },
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "text", "field": "text",
"description": "<p>Text of the note.</p>" "description": "<p>Text of the note.</p>"
@ -301,6 +301,19 @@ define({ "api": [
"title": "Delete account", "title": "Delete account",
"name": "DeleteUser", "name": "DeleteUser",
"group": "User", "group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Password",
"description": "<p>Account password.</p>"
}
]
}
},
"version": "0.0.0", "version": "0.0.0",
"filename": "app/routes/user/index.js", "filename": "app/routes/user/index.js",
"groupTitle": "User" "groupTitle": "User"
@ -348,6 +361,7 @@ define({ "api": [
"title": "Update account information", "title": "Update account information",
"name": "UpdateUser", "name": "UpdateUser",
"group": "User", "group": "User",
"description": "<p>Send only password and new_password to change the password. Otherwise they will be ignored.</p>",
"parameter": { "parameter": {
"fields": { "fields": {
"Parameter": [ "Parameter": [
@ -355,22 +369,36 @@ define({ "api": [
"group": "Parameter", "group": "Parameter",
"type": "String", "type": "String",
"optional": false, "optional": false,
"field": "Firstname", "field": "firstname",
"description": "<p>new firstname.</p>" "description": "<p>New firstname. (optional)</p>"
}, },
{ {
"group": "Parameter", "group": "Parameter",
"type": "String", "type": "String",
"optional": false, "optional": false,
"field": "Lastname", "field": "lastname",
"description": "<p>new lastname.</p>" "description": "<p>New lastname. (optional)</p>"
}, },
{ {
"group": "Parameter", "group": "Parameter",
"type": "String", "type": "String",
"optional": false, "optional": false,
"field": "Email", "field": "email",
"description": "<p>new email address.</p>" "description": "<p>New email address. (optional)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>Actual password. (optional)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "new_password",
"description": "<p>New password (only if you passed password parameter).</p>"
} }
] ]
} }

54
docs/api_data.json
View File

@ -30,7 +30,7 @@
"Success 200": [ "Success 200": [
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "access_token", "field": "access_token",
"description": "<p>Access token.</p>" "description": "<p>Access token.</p>"
@ -149,14 +149,14 @@
"Success 200": [ "Success 200": [
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "title", "field": "title",
"description": "<p>Title of the note.</p>" "description": "<p>Title of the note.</p>"
}, },
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "text", "field": "text",
"description": "<p>Text of the note.</p>" "description": "<p>Text of the note.</p>"
@ -233,14 +233,14 @@
"Success 200": [ "Success 200": [
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "title", "field": "title",
"description": "<p>Title of the note.</p>" "description": "<p>Title of the note.</p>"
}, },
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "text", "field": "text",
"description": "<p>Text of the note.</p>" "description": "<p>Text of the note.</p>"
@ -276,14 +276,14 @@
"Success 200": [ "Success 200": [
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "title", "field": "title",
"description": "<p>Title of the note.</p>" "description": "<p>Title of the note.</p>"
}, },
{ {
"group": "Success 200", "group": "Success 200",
"type": "string", "type": "String",
"optional": false, "optional": false,
"field": "text", "field": "text",
"description": "<p>Text of the note.</p>" "description": "<p>Text of the note.</p>"
@ -301,6 +301,19 @@
"title": "Delete account", "title": "Delete account",
"name": "DeleteUser", "name": "DeleteUser",
"group": "User", "group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Password",
"description": "<p>Account password.</p>"
}
]
}
},
"version": "0.0.0", "version": "0.0.0",
"filename": "app/routes/user/index.js", "filename": "app/routes/user/index.js",
"groupTitle": "User" "groupTitle": "User"
@ -348,6 +361,7 @@
"title": "Update account information", "title": "Update account information",
"name": "UpdateUser", "name": "UpdateUser",
"group": "User", "group": "User",
"description": "<p>Send only password and new_password to change the password. Otherwise they will be ignored.</p>",
"parameter": { "parameter": {
"fields": { "fields": {
"Parameter": [ "Parameter": [
@ -355,22 +369,36 @@
"group": "Parameter", "group": "Parameter",
"type": "String", "type": "String",
"optional": false, "optional": false,
"field": "Firstname", "field": "firstname",
"description": "<p>new firstname.</p>" "description": "<p>New firstname. (optional)</p>"
}, },
{ {
"group": "Parameter", "group": "Parameter",
"type": "String", "type": "String",
"optional": false, "optional": false,
"field": "Lastname", "field": "lastname",
"description": "<p>new lastname.</p>" "description": "<p>New lastname. (optional)</p>"
}, },
{ {
"group": "Parameter", "group": "Parameter",
"type": "String", "type": "String",
"optional": false, "optional": false,
"field": "Email", "field": "email",
"description": "<p>new email address.</p>" "description": "<p>New email address. (optional)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>Actual password. (optional)</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "new_password",
"description": "<p>New password (only if you passed password parameter).</p>"
} }
] ]
} }

2
docs/api_project.js
View File

@ -8,7 +8,7 @@ define({
"apidoc": "0.3.0", "apidoc": "0.3.0",
"generator": { "generator": {
"name": "apidoc", "name": "apidoc",
"time": "2018-11-16T10:11:39.561Z", "time": "2018-11-16T14:21:42.357Z",
"url": "http://apidocjs.com", "url": "http://apidocjs.com",
"version": "0.17.7" "version": "0.17.7"
} }

2
docs/api_project.json
View File

@ -8,7 +8,7 @@
"apidoc": "0.3.0", "apidoc": "0.3.0",
"generator": { "generator": {
"name": "apidoc", "name": "apidoc",
"time": "2018-11-16T10:11:39.561Z", "time": "2018-11-16T14:21:42.357Z",
"url": "http://apidocjs.com", "url": "http://apidocjs.com",
"version": "0.17.7" "version": "0.17.7"
} }