Merge pull request #46 from topcoder-platform/issues-313

Issues-313:add endpoint to pull all members for a group

Author: jmgasper

controllers/api/GroupsApiController.php

@@ -202,6 +202,50 @@ public function post_members($id, array $body) {
         $this->groupModel->join($group->GroupID, $user->UserID, $watch, $follow);
     }
 
+    /**
+     * Get all members of a group.
+     *
+     * @param int $id The ID of the group.
+     * @throws NotFoundException if the group could not be found.
+     * @return array
+     */
+    public function get_members($id, array $query) {
+        $this->permission();
+        $in = $this->schema([
+            'page:i?' => [
+                'description' => 'Page number. See [Pagination](https://docs.vanillaforums.com/apiv2/#pagination).',
+                'default' => 1,
+                'minimum' => 1,
+            ],
+            'limit:i?' => [
+                'description' => 'Desired number of items per page.',
+                'default' => 30,
+                'minimum' => 1,
+                'maximum' => 100,
+            ]
+        ], 'in')->setDescription('The list of group members.');
+
+        $out = $this->schema([
+            ':a' => [
+                'userID:i', // The ID of the user.
+                'name:s', // The username of the user.
+            ],
+        ], 'out');
+
+        $group = $this->groupModel->getID($id, DATASET_TYPE_ARRAY);
+        if (!$group) {
+            throw new NotFoundException('Group');
+        }
+
+        $query = $in->validate($query);
+        list($offset, $limit) = offsetLimit("p{$query['page']}", $query['limit']);
+        $records =  $this->groupModel->getMembers($id, [], '',$limit, $offset );
+        $result = $out->validate($records);
+        $paging = ApiUtils::morePagerInfo($result, '/api/v2/groups/'.$id.'/members', $query, $in);
+
+        return new Data($result, ['paging' => $paging]);
+    }
+
     /**
      * Archive a group.
      *

controllers/class.groupcontroller.php

@@ -201,7 +201,7 @@ public function edit($groupID = false) {
 
         // Set Type dropbox
         if($Group->Type == GroupModel::TYPE_REGULAR || $groupID === false) { // Regular Groups can be created from UI only
-            $typesData = [GroupModel::TYPE_REGULAR => GroupModel::TYPE_REGULAR, GroupModel::TYPE_CHALLENGE => GroupModel::TYPE_CHALLENGE];
+            $typesData = [GroupModel::TYPE_REGULAR => GroupModel::TYPE_REGULAR];
         } else if ($Group->Type == GroupModel::TYPE_CHALLENGE){
             $typesData = [GroupModel::TYPE_CHALLENGE => GroupModel::TYPE_CHALLENGE];
         }

openapi/groups.yml

@@ -14,19 +14,29 @@ paths:
           type: string
         x-filter:
           field: ChallengeID
-      - description: |
-          Filter by group type.
+      - description: Filter by group type.
         in: query
         name: type
+        schema:
+          type: string
+          default: challenge
+          enum:
+            - challenge
+            - regular
+          x-filter:
+            field: Type
+      - description:  Filter by group privacy.
+        in: query
+        name: privacy
         schema:
           type: string
           default: public
           enum:
-          - public
-          - private
-          - secret
+            - public
+            - private
+            - secret
         x-filter:
-          field: Type
+          field: Privacy
       - $ref: '#/components/parameters/Page'
       - description: |
           Desired number of items per page.
@@ -128,6 +138,42 @@ paths:
         - Groups
       summary: Remove a user from a group.
   '/groups/{id}/members':
+    get:
+      parameters:
+        - description: The group ID.
+          in: path
+          name: id
+          required: true
+          schema:
+            type: integer
+        - description: |
+            Page number. See [Pagination](https://docs.vanillaforums.com/apiv2/#pagination).
+          in: query
+          name: page
+          schema:
+            type: integer
+            default: 1
+            minimum: 1
+        - description: Desired number of items per page.
+          in: query
+          name: limit
+          schema:
+            type: integer
+            default: 30
+            maximum: 100
+            minimum: 1
+      responses:
+        '200':
+          content:
+            'application/json':
+              schema:
+                items:
+                  $ref: '#/components/schemas/GroupMember'
+                type: array
+          description: Success
+      tags:
+        - Groups
+      summary: The list of group members.
     post:
       parameters:
         - description: The group ID.
@@ -280,3 +326,15 @@ components:
       required:
         - userID
       type: object
+    GroupMember:
+      properties:
+        userID:
+          description: The userID of an user.
+          type: integer
+        name:
+          description: The name of an user.
+          type: string
+      required:
+        - userID
+        - name
+      type: object