Skip to content

Commit 5ad51aa

Browse files
committed
docs(groups): Correct docs for member list
1 parent 05621d6 commit 5ad51aa

File tree

1 file changed

+44
-11
lines changed

1 file changed

+44
-11
lines changed

app/Modules/Groups/Http/Controllers/Api/MembersController.php

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ class MembersController extends Controller
4848
* }
4949
* @apiParameter {
5050
* "in": "query",
51-
* "name": "owneruserid",
52-
* "description": "Owner user ID",
51+
* "name": "groupid",
52+
* "description": "Group ID",
5353
* "required": false,
5454
* "schema": {
5555
* "type": "integer",
@@ -58,17 +58,49 @@ class MembersController extends Controller
5858
* }
5959
* @apiParameter {
6060
* "in": "query",
61-
* "name": "unixgroup",
62-
* "description": "Unix group name",
61+
* "name": "userid",
62+
* "description": "User ID",
6363
* "required": false,
6464
* "schema": {
65-
* "type": "string"
65+
* "type": "integer",
66+
* "default": 0
6667
* }
6768
* }
6869
* @apiParameter {
6970
* "in": "query",
70-
* "name": "unixid",
71-
* "description": "Unix ID",
71+
* "name": "membertype",
72+
* "description": "Member type",
73+
* "required": false,
74+
* "schema": {
75+
* "type": "integer",
76+
* "default": 0,
77+
* "enum": [
78+
* "1 (members)",
79+
* "2 (managers)",
80+
* "3 (viewers)",
81+
* "4 (pending)"
82+
* ]
83+
* }
84+
* }
85+
* @apiParameter {
86+
* "in": "query",
87+
* "name": "state",
88+
* "description": "State",
89+
* "required": false,
90+
* "schema": {
91+
* "type": "string",
92+
* "default": "active",
93+
* "enum": [
94+
* "active",
95+
* "trashed",
96+
* "all"
97+
* ]
98+
* }
99+
* }
100+
* @apiParameter {
101+
* "in": "query",
102+
* "name": "userrequestid",
103+
* "description": "User request ID",
72104
* "required": false,
73105
* "schema": {
74106
* "type": "integer",
@@ -94,10 +126,11 @@ class MembersController extends Controller
94126
* "default": "name",
95127
* "enum": [
96128
* "id",
97-
* "name",
98-
* "owneruserid",
99-
* "unixgroup",
100-
* "unixid"
129+
* "groupid",
130+
* "userid",
131+
* "membertype",
132+
* "datecreated",
133+
* "dateremoved"
101134
* ]
102135
* }
103136
* }

0 commit comments

Comments
 (0)