diff options
| author | Ran Guin <[email protected]> | 2021-07-19 12:17:44 -0700 |
|---|---|---|
| committer | Ran Guin <[email protected]> | 2021-07-19 12:17:44 -0700 |
| commit | 559338814b797f692b7e3f1ec323492a0a4aa072 (patch) | |
| tree | a3ad99ad8a1ad1d65d5830f1d05641db8ef6d910 | |
| parent | 4071ba232a96af7ecada44b04c1466f8a98cfe7f (diff) | |
| download | coinos-server-559338814b797f692b7e3f1ec323492a0a4aa072.tar.gz coinos-server-559338814b797f692b7e3f1ec323492a0a4aa072.zip | |
tweak api-doc
| -rw-r--r-- | routes/referrals.js | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/routes/referrals.js b/routes/referrals.js index 91b14cb3..7d144ac1 100644 --- a/routes/referrals.js +++ b/routes/referrals.js @@ -29,7 +29,9 @@ router.get('/', function(req, res, next) { * @apiParam {sponsor_id} user_id of member generating referral code. * @apiParam {expiry} optional expiry date for token. * - * @apiSuccess {token: referral_code, expiry: expiry} Token and expiry if applicable. + * @apiSuccess {String} token referral token + * @apiSuccess {Date} expiry optional expiry + * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK * { @@ -69,7 +71,9 @@ router.post( * @apiParam {sponsor_id} user_id of member generating referral code. * @apiParam {expiry} optional expiry date for token. * - * @apiSuccess {token: referral_code, status: status, expiry: expiry} Token and expiry if applicable. + * @apiSuccess {String} token referral token + * @apiSuccess {Status} status referral status + * @apiSuccess {Date} expiry optional expiry * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK * { @@ -221,8 +225,8 @@ router.get( * @apiName joinQueue * @apiGroup Referrals * - * @apiParam {email} - * @apiParam {phone} + * @apiParam {email} email address + * @apiParam {phone} phone number * * @apiSuccess verified = true * @apiSuccessExample {json} Success-Response: @@ -274,7 +278,7 @@ router.get( * @apiName isReferred * @apiGroup Referrals * - * @apiParam {user_id} + * @apiParam {user_id} user id * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK |