From 3ff2cf172fdfc31d0fbbb467cf561ced51504fcf Mon Sep 17 00:00:00 2001 From: Radmacher <66096031+rdmchr@users.noreply.github.com> Date: Wed, 10 Nov 2021 17:13:51 +0100 Subject: [PATCH] Updated get team members doc --- app/controllers/api/teams.php | 6 +++--- docs/references/teams/get-team-members.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/app/controllers/api/teams.php b/app/controllers/api/teams.php index 0565131665..cc5ffe52ea 100644 --- a/app/controllers/api/teams.php +++ b/app/controllers/api/teams.php @@ -535,10 +535,10 @@ App::get('/v1/teams/:teamId/memberships') ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MEMBERSHIP_LIST) ->param('teamId', '', new UID(), 'The unique team ID.') - ->param('search', '', new Text(256), 'Search term to filter your list results. Max length: 256 chars.', true) - ->param('limit', 25, new Range(0, 100), 'Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request.', true) + ->param('search', '', new Text(256), 'Search term to filter your results. Max length: 256 chars.', true) + ->param('limit', 25, new Range(0, 100), 'Limit how many results will be returned. By default will return a maximum of 25 results. Maximum of 100 results allowed per request.', true) ->param('offset', 0, new Range(0, 2000), 'Results offset. The default value is 0. Use this param to manage pagination.', true) - ->param('orderType', 'ASC', new WhiteList(['ASC', 'DESC'], true), 'Order result by ASC or DESC order.', true) + ->param('orderType', 'ASC', new WhiteList(['ASC', 'DESC'], true), 'Order results by ASC or DESC order.', true) ->inject('response') ->inject('projectDB') ->action(function ($teamId, $search, $limit, $offset, $orderType, $response, $projectDB) { diff --git a/docs/references/teams/get-team-members.md b/docs/references/teams/get-team-members.md index ee939b9978..f8a5c7839f 100644 --- a/docs/references/teams/get-team-members.md +++ b/docs/references/teams/get-team-members.md @@ -1 +1 @@ -Get a team members by the team unique ID. All team members have read access for this list of resources. \ No newline at end of file +Lists a teams members using the team's unique ID. All team members have read access to this endpoint. \ No newline at end of file