updated api docs

This commit is contained in:
Andris Reinman 2019-09-13 15:33:04 +03:00
parent fcd344bfd1
commit 7c4fcaeab3
5 changed files with 5 additions and 4 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -1 +1 @@
define({ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs", "title": "WildDuck API", "url": "https://api.wildduck.email", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2019-07-31T12:58:20.000Z", "url": "http://apidocjs.com", "version": "0.17.7" } }); define({ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs", "title": "WildDuck API", "url": "https://api.wildduck.email", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2019-09-13T12:32:24.644Z", "url": "http://apidocjs.com", "version": "0.17.7" } });

View file

@ -1 +1 @@
{ "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs", "title": "WildDuck API", "url": "https://api.wildduck.email", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2019-07-31T12:58:20.000Z", "url": "http://apidocjs.com", "version": "0.17.7" } } { "name": "wildduck", "version": "1.0.0", "description": "WildDuck API docs", "title": "WildDuck API", "url": "https://api.wildduck.email", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", "time": "2019-09-13T12:32:24.644Z", "url": "http://apidocjs.com", "version": "0.17.7" } }

View file

@ -2005,6 +2005,7 @@ module.exports = (db, server, userHandler) => {
* @api {delete} /users/:id Delete a User * @api {delete} /users/:id Delete a User
* @apiName DeleteUser * @apiName DeleteUser
* @apiGroup Users * @apiGroup Users
* @apiDescription This method deletes user and address entries from DB and schedules a background task to delete messages. You can call this method several times even if the user has already been deleted, in case there are still some pending messages.
* @apiHeader {String} X-Access-Token Optional access token if authentication is enabled * @apiHeader {String} X-Access-Token Optional access token if authentication is enabled
* @apiHeaderExample {json} Header-Example: * @apiHeaderExample {json} Header-Example:
* { * {