adjust text in apidocs for errors / clarity / consistency / standard terminology (no code changes) (#7298)

This commit is contained in:
Alys
2016-05-17 02:08:54 +10:00
committed by Matteo Pagliazzi
parent ad03cc8f9a
commit 4bba10fac2
7 changed files with 68 additions and 65 deletions

View File

@@ -26,8 +26,8 @@ const BASE_URL = nconf.get('BASE_URL');
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.
* @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.
* @apiVersion 3.0.0
* @apiName ExportUserHistory
* @apiGroup DataExport
@@ -94,7 +94,7 @@ async function _getUserDataForExport (user) {
}
/**
* @api {get} /export/userdata.json Export user data in JSON format.
* @api {get} /export/userdata.json Export user data in JSON format
* @apiVersion 3.0.0
* @apiName ExportUserDataJson
* @apiGroup DataExport