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

docs(members): update members api docs to include info about includeAllPublicFields query parameter

Browse Source
This commit is contained in:
Matteo Pagliazzi
2020-07-27 11:01:29 +02:00
parent 4b5500b13d
commit 35a6f4cb19
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
website/server/controllers/api-v3/members.js
View File

@@ -416,11 +416,10 @@ function _getMembersForItem (type) {
* get the next batch of results. * get the next batch of results.
* @apiParam (Query) {Number} limit=30 BETA Query parameter * @apiParam (Query) {Number} limit=30 BETA Query parameter
* to specify the number of results to return. Max is 60. * to specify the number of results to return. Max is 60.
* @apiParam (Query) {Boolean} includeAllPublicFields Query parameter available * @apiParam (Query) {Boolean} includeAllPublicFields If set to `true`
* only when fetching a party. If === `true`
* then all public fields for members * then all public fields for members
* will be returned (like when making a request * will be returned (similar to when making
* for a single member). * a request for a single member).
* *
* @apiSuccess {Array} data An array of members, sorted by _id * @apiSuccess {Array} data An array of members, sorted by _id
* *
@@ -462,6 +461,10 @@ api.getMembersForGroup = {
* get the next batch of results. * get the next batch of results.
* @apiParam (Query) {Number} limit=30 BETA Query parameter * @apiParam (Query) {Number} limit=30 BETA Query parameter
* to specify the number of results to return. Max is 60. * to specify the number of results to return. Max is 60.
* @apiParam (Query) {Boolean} includeAllPublicFields If set to `true`
* then all public fields for members
* will be returned (similar to when making
* a request for a single member).
* *
* @apiSuccess {array} data An array of invites, sorted by _id * @apiSuccess {array} data An array of invites, sorted by _id
* *
@@ -508,6 +511,10 @@ api.getInvitesForGroup = {
* get the next batch of results. * get the next batch of results.
* @apiParam (Query) {Number} limit=30 BETA Query parameter to * @apiParam (Query) {Number} limit=30 BETA Query parameter to
* specify the number of results to return. Max is 60. * specify the number of results to return. Max is 60.
* @apiParam (Query) {Boolean} includeAllPublicFields If set to `true`
* then all public fields for members
* will be returned (similar to when making
* a request for a single member).
* @apiParam (Query) {String} includeAllMembers BETA Query parameter - If 'true' all * @apiParam (Query) {String} includeAllMembers BETA Query parameter - If 'true' all
* challenge members are returned. * challenge members are returned.