Skip to content

Commit 3d2b645

Browse files
committed
update docs
1 parent 127bdec commit 3d2b645

4 files changed

Lines changed: 130 additions & 2 deletions

File tree

docs/api/api_data.js

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,70 @@ define({
447447
"url": "https://api.mchacks.ca/api/account/:id"
448448
}]
449449
},
450+
{
451+
"type": "post",
452+
"url": "/auth/password/change",
453+
"title": "change password for logged in user",
454+
"name": "changePassword",
455+
"group": "Authentication",
456+
"version": "0.0.8",
457+
"parameter": {
458+
"fields": {
459+
"Parameter": [{
460+
"group": "Parameter",
461+
"type": "String",
462+
"optional": false,
463+
"field": "oldPassword",
464+
"description": "<p>The current password of the user</p>"
465+
},
466+
{
467+
"group": "Parameter",
468+
"type": "String",
469+
"optional": false,
470+
"field": "newPassword",
471+
"description": "<p>The new password of the user</p>"
472+
}
473+
]
474+
},
475+
"examples": [{
476+
"title": "Request-Example:",
477+
"content": "{ \n \"oldPassword\": \"password12345\",\n \"newPassword\": \"password123456\"\n}",
478+
"type": "json"
479+
}]
480+
},
481+
"success": {
482+
"fields": {
483+
"Success 200": [{
484+
"group": "Success 200",
485+
"type": "string",
486+
"optional": false,
487+
"field": "message",
488+
"description": "<p>Success message</p>"
489+
},
490+
{
491+
"group": "Success 200",
492+
"type": "object",
493+
"optional": false,
494+
"field": "data",
495+
"description": "<p>empty</p>"
496+
}
497+
]
498+
},
499+
"examples": [{
500+
"title": "Success-Response: ",
501+
"content": "{\"message\": \"Successfully reset password\", \"data\": {}}",
502+
"type": "json"
503+
}]
504+
},
505+
"permission": [{
506+
"name": ": Must be logged in"
507+
}],
508+
"filename": "routes/api/auth.js",
509+
"groupTitle": "Authentication",
510+
"sampleRequest": [{
511+
"url": "https://api.mchacks.ca/api/auth/password/change"
512+
}]
513+
},
450514
{
451515
"type": "post",
452516
"url": "/auth/confirm/:token",

docs/api/api_data.json

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,70 @@
446446
"url": "https://api.mchacks.ca/api/account/:id"
447447
}]
448448
},
449+
{
450+
"type": "post",
451+
"url": "/auth/password/change",
452+
"title": "change password for logged in user",
453+
"name": "changePassword",
454+
"group": "Authentication",
455+
"version": "0.0.8",
456+
"parameter": {
457+
"fields": {
458+
"Parameter": [{
459+
"group": "Parameter",
460+
"type": "String",
461+
"optional": false,
462+
"field": "oldPassword",
463+
"description": "<p>The current password of the user</p>"
464+
},
465+
{
466+
"group": "Parameter",
467+
"type": "String",
468+
"optional": false,
469+
"field": "newPassword",
470+
"description": "<p>The new password of the user</p>"
471+
}
472+
]
473+
},
474+
"examples": [{
475+
"title": "Request-Example:",
476+
"content": "{ \n \"oldPassword\": \"password12345\",\n \"newPassword\": \"password123456\"\n}",
477+
"type": "json"
478+
}]
479+
},
480+
"success": {
481+
"fields": {
482+
"Success 200": [{
483+
"group": "Success 200",
484+
"type": "string",
485+
"optional": false,
486+
"field": "message",
487+
"description": "<p>Success message</p>"
488+
},
489+
{
490+
"group": "Success 200",
491+
"type": "object",
492+
"optional": false,
493+
"field": "data",
494+
"description": "<p>empty</p>"
495+
}
496+
]
497+
},
498+
"examples": [{
499+
"title": "Success-Response: ",
500+
"content": "{\"message\": \"Successfully reset password\", \"data\": {}}",
501+
"type": "json"
502+
}]
503+
},
504+
"permission": [{
505+
"name": ": Must be logged in"
506+
}],
507+
"filename": "routes/api/auth.js",
508+
"groupTitle": "Authentication",
509+
"sampleRequest": [{
510+
"url": "https://api.mchacks.ca/api/auth/password/change"
511+
}]
512+
},
449513
{
450514
"type": "post",
451515
"url": "/auth/confirm/:token",

docs/api/api_project.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ define({
99
"apidoc": "0.3.0",
1010
"generator": {
1111
"name": "apidoc",
12-
"time": "2018-12-01T22:43:17.010Z",
12+
"time": "2018-12-03T02:15:26.200Z",
1313
"url": "http://apidocjs.com",
1414
"version": "0.17.6"
1515
}

docs/api/api_project.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"apidoc": "0.3.0",
1010
"generator": {
1111
"name": "apidoc",
12-
"time": "2018-12-01T22:43:17.010Z",
12+
"time": "2018-12-03T02:15:26.200Z",
1313
"url": "http://apidocjs.com",
1414
"version": "0.17.6"
1515
}

0 commit comments

Comments
 (0)