wildduck/docs/api_data.json

2 lines
328 KiB
JSON
Raw Normal View History

2018-05-11 19:39:23 +08:00
[ { "type": "delete", "url": "/addresses/forwarded/:address", "title": "Delete a forwarded Address", "name": "DeleteForwardedAddress", "group": "Addresses", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "X-Access-Token", "description": "<p>Optional access token if authentication is enabled</p>" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}", "type": "json" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "address", "description": "<p>ID of the Address</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Boolean", "optional": false, "field": "success", "description": "<p>Indicates successful response</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}", "type": "json" } ] }, "error": { "fields": { "Error 4xx": [ { "group": "Error 4xx", "optional": false, "field": "error", "description": "<p>Description of the error</p>" } ] }, "examples": [ { "title": "Error-Response:", "content": "HTTP/1.1 200 OK\n{\n \"error\": \"This address does not exist\"\n}", "type": "json" } ] }, "examples": [ { "title": "Example usage:", "content": "curl -i -XDELETE http://localhost:8080/addresses/forwarded/59ef21aef255ed1d9d790e81", "type": "curl" } ], "version": "0.0.0", "filename": "lib/api/addresses.js", "groupTitle": "Addresses" }, { "type": "delete", "url": "/users/:user/addresses/:address", "title": "Delete an Address", "name": "DeleteUserAddress", "group": "Addresses", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "X-Access-Token", "description": "<p>Optional access token if authentication is enabled</p>" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"X-Access-Token\": \"59fc66a03e54454869460e45\"\n}", "type": "json" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "user", "description": "<p>ID of the User</p>" }, { "group": "Parameter", "type": "String", "optional": false, "field": "address", "description": "<p>ID of the Address</p>" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Boolean", "optional": false, "field": "success", "description": "<p>Indicates successful response</p>" } ] }, "examples": [ { "title": "Success-Response:", "content": "HTTP/1.1 200 OK\n{\n \"success\": true\n}", "type": "json" } ] }, "error": { "fields": { "Error 4xx": [ { "group": "Error 4xx", "optional": false, "field": "error", "description": "<p>Descript