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

chore(docs): Add global definitions for param types

Browse Source
This commit is contained in:
Blade Barringer
2016-10-11 21:35:16 -05:00
parent aeee29f5fa
commit afb5b473a3
3 changed files with 43 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
website/server/controllers/api-v3/groups.js
View File

@@ -672,12 +672,12 @@ async function _inviteByEmail (invite, group, inviter, req, res) {
* @apiGroup Group
* @apiDescription You can provide both `emails` and `uuids`, or just one. You must provide at least one.
*
* @apiParam {String} groupId The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)
* @apiParam (Path) {String} groupId The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)
*
* @apiParam {Object[]} [emails] Body parameter - An array of objects, each representing one email address to invite
* @apiParam {String} emails.email The email address of the user being invited.
* @apiParam {String} [emails.name] The name of the user being invited.
* @apiParam {Array} [uuids] Body parameter - An array of uuids to invite
* @apiParam (Body) {Object[]} [emails] An array of objects, each representing one email address to invite
* @apiParam (Body) {String} emails.email The email address of the user being invited.
* @apiParam (Body) {String} [emails.name] The name of the user being invited.
* @apiParam (Body) {Array} [uuids] An array of uuids to invite
*
* @apiParamExample {json} Emails
* {
@@ -706,24 +706,24 @@ async function _inviteByEmail (invite, group, inviter, req, res) {
* @apiSuccessExample {json} Successful Response with Emails
* {
* "data": [
* "user-1@example.com",
* "user-2@exmaple.com"
* "user-1@example.com",
* "user-2@exmaple.com"
* ]
* }
*
* @apiSuccessExample {json} Successful Response with User Id
* {
* "data": [
* { id: 'the-id-of-the-invited-user', name: 'The group name', inviter: 'your-user-id' }
* ]
* "data": [
* { id: 'the-id-of-the-invited-user', name: 'The group name', inviter: 'your-user-id' }
* ]
* }
* @apiSuccessExample {json} Successful Response with User Ids and Emails
* {
* "data": [
* "user-1@example.com",
* { id: 'the-id-of-the-invited-user', name: 'The group name', inviter: 'your-user-id' },
* "user-2@exmaple.com"
* ]
* "data": [
* "user-1@example.com",
* { id: 'the-id-of-the-invited-user', name: 'The group name', inviter: 'your-user-id' },
* "user-2@exmaple.com"
* ]
* }
*
* @apiUse GroupBodyInvalid