krikkert/habitica
1
0
Fork 0
mirror of https://github.com/HabitRPG/habitica.git synced 2025-12-17 22:57:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

7837-Update API Docs (#7839)

Browse Source 
* Updated API Docs for api-v3

* Updated API Docs for top-level

* Updates relating to @crookedneighbor comments

* Updated type and field of 'to' param.
This commit is contained in:
Ryan Castner
2016-07-27 19:48:03 -04:00
committed by Blade Barringer
parent 795ea8ba80
commit 7c579bf850
17 changed files with 190 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
website/server/controllers/top-level/dataexport.js
View File

@@ -25,12 +25,12 @@ let api = {};
/**
* @api {get} /export/history.csv Export user tasks history in CSV format
* @apiDescription History is only available for habits and dailys so todos and rewards won't be included. NOTE: Part of the private API that may change at any time.
* @apiDescription History is only available for habits and dailies so todos and rewards won't be included. NOTE: Part of the private API that may change at any time.
* @apiVersion 3.0.0
* @apiName ExportUserHistory
* @apiGroup DataExport
*
* @apiSuccess {string} A cvs file
* @apiSuccess {String} A csv file
*/
api.exportUserHistory = {
method: 'GET',
@@ -98,7 +98,7 @@ async function _getUserDataForExport (user) {
* @apiGroup DataExport
* @apiDescription NOTE: Part of the private API that may change at any time.
*
* @apiSuccess {string} A json file
* @apiSuccess {String} A json file
*/
api.exportUserDataJson = {
method: 'GET',
@@ -124,7 +124,7 @@ api.exportUserDataJson = {
* @apiGroup DataExport
* @apiDescription NOTE: Part of the private API that may change at any time.
*
* @apiSuccess {string} A xml file
* @apiSuccess {String} A xml file
*/
api.exportUserDataXml = {
method: 'GET',
@@ -148,7 +148,7 @@ api.exportUserDataXml = {
* @apiGroup DataExport
* @apiDescription NOTE: Part of the private API that may change at any time.
*
* @apiSuccess {string} An html page
* @apiSuccess {String} An html page
*/
api.exportUserAvatarHtml = {
method: 'GET',
@@ -181,7 +181,7 @@ api.exportUserAvatarHtml = {
* @apiGroup DataExport
* @apiDescription NOTE: Part of the private API that may change at any time.
*
* @apiSuccess {string} A png file
* @apiSuccess {String} A png file
*/
api.exportUserAvatarPng = {
method: 'GET',