Merge branch 'api-v3' of github.com:HabitRPG/habitrpg into api-v3

This commit is contained in:
Matteo Pagliazzi
2016-05-16 12:55:14 +02:00
13 changed files with 629 additions and 18 deletions

View File

@@ -177,7 +177,7 @@ api.updateUser = {
};
/**
* @api {delete} /api/v3/user DELETE an authenticated user's account
* @api {delete} /api/v3/user Delete an authenticated user's account
* @apiVersion 3.0.0
* @apiName UserDelete
* @apiGroup User
@@ -240,7 +240,7 @@ function _cleanChecklist (task) {
}
/**
* @api {get} /api/v3/user/anonymized
* @api {get} /api/v3/user/anonymized Get anonymized user data
* @apiVersion 3.0.0
* @apiName UserGetAnonymized
* @apiGroup User
@@ -886,12 +886,12 @@ api.userOpenMysteryItem = {
};
/*
* @api {post} /api/v3/user/webhook
* @api {post} /api/v3/user/webhook Create a new webhook
* @apiVersion 3.0.0
* @apiName UserAddWebhook
* @apiGroup User
*
* @apiParam {string} url Body parameter - The webhook's urò
* @apiParam {string} url Body parameter - The webhook's URL
* @apiParam {boolean} enabled Body parameter - If the webhook should be enabled
*
* @apiSuccess {Object} data The created webhook
@@ -909,13 +909,13 @@ api.addWebhook = {
};
/*
* @api {put} /api/v3/user/webhook/:id
* @api {put} /api/v3/user/webhook/:id Edit a webhook
* @apiVersion 3.0.0
* @apiName UserUpdateWebhook
* @apiGroup User
*
* @apiParam {UUID} id The id of the webhook to update
* @apiParam {string} url Body parameter - The webhook's urò
* @apiParam {string} url Body parameter - The webhook's URL
* @apiParam {boolean} enabled Body parameter - If the webhook should be enabled
*
* @apiSuccess {Object} data The updated webhook
@@ -933,7 +933,7 @@ api.updateWebhook = {
};
/*
* @api {delete} /api/v3/user/webhook/:id
* @api {delete} /api/v3/user/webhook/:id Delete a webhook
* @apiVersion 3.0.0
* @apiName UserDeleteWebhook
* @apiGroup User