Skip to content

Commit c75bb5e

Browse files
adriendupuisadriendupuis
committed
REST API ref: Merge /user/groups/{id}/ into /user/groups/{path}/ (#1843)
1 parent 2dff014 commit c75bb5e

2 files changed

Lines changed: 2645 additions & 2608 deletions

File tree

‎docs/api/rest_api_reference/input/ez-user-groups.raml‎

Lines changed: 60 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,36 @@ get:
127127
404:
128128
description: Error - the User Group does not exist.
129129
/users:
130+
get:
131+
displayName: Load Users of Group
132+
description: Loads the Users of the Group with the given ID.
133+
queryParameters:
134+
limit:
135+
description: Only 'limit' items will be returned started by offset.
136+
offset:
137+
description: Offset of the result set.
138+
headers:
139+
Accept:
140+
description: UserList - If set, the User list returned in XML or JSON format. UserRefList - If set, the link list of Users returned in XML or JSON format.
141+
example: |
142+
application/vnd.ez.api.UserList+xml
143+
application/vnd.ez.api.UserList+json
144+
application/vnd.ez.api.UserRefList+xml
145+
application/vnd.ez.api.UserRefList+json
146+
responses:
147+
200:
148+
description: OK - the Users of the Group with the given ID.
149+
body:
150+
application/vnd.ez.api.UserRefList+xml:
151+
type: UserRefList
152+
example: !include examples/user/groups/id/users/GET/UserRefList.xml.example
153+
application/vnd.ez.api.UserRefList+json:
154+
type: UserRefList
155+
example: !include examples/user/groups/id/users/GET/UserRefList.json.example
156+
401:
157+
description: Error - the user has no permission to read User Groups.
158+
404:
159+
description: Error - the User Group does not exist.
130160
post:
131161
displayName: Create User
132162
description: Creates a new User in the given Group.
@@ -166,6 +196,36 @@ get:
166196
404:
167197
description: Error - the Group with the given ID does not exist.
168198
/subgroups:
199+
get:
200+
displayName: Load subgroups
201+
description: Returns a list of the subgroups.
202+
queryParameters:
203+
limit:
204+
description: The number of Locations returned.
205+
offset:
206+
description: The offset of the result set.
207+
headers:
208+
Accept:
209+
description: UserGroupList - If set, the User Group list is returned in XML or JSON format. UserGroupRefList - If set, the link list of User Groups is returned in XML or JSON format.
210+
example: |
211+
application/vnd.ez.api.UserGroupList+xml
212+
application/vnd.ez.api.UserGroupList+json
213+
application/vnd.ez.api.UserGroupRefList+xml
214+
application/vnd.ez.api.UserGroupRefList+json
215+
responses:
216+
200:
217+
description: OK - list of the subgroups.
218+
body:
219+
application/vnd.ez.api.UserGroupRefList+xml:
220+
type: UserGroupRefList
221+
example: !include examples/user/groups/id/subgroups/GET/UserGroupRefList.xml.example
222+
application/vnd.ez.api.UserGroupRefList+json:
223+
type: UserGroupRefList
224+
example: !include examples/user/groups/id/subgroups/GET/UserGroupRefList.json.example
225+
401:
226+
description: Error - the user has no permission to read User Groups.
227+
404:
228+
description: Error - the User Group does not exist.
169229
post:
170230
displayName: Create User Group
171231
description: Creates a new User Group under the given parent. To create a top level group use '/user/groups/subgroups'.
@@ -298,65 +358,3 @@ get:
298358
example: !include examples/user/groups/path/roles/role_id/DELETE/RoleAssignmentList.json.example
299359
401:
300360
description: Error - the user is not authorized to delete this Role assignment.
301-
/{id}/users:
302-
get:
303-
displayName: Load Users of Group
304-
description: Loads the Users of the Group with the given ID.
305-
queryParameters:
306-
limit:
307-
description: Only 'limit' items will be returned started by offset.
308-
offset:
309-
description: Offset of the result set.
310-
headers:
311-
Accept:
312-
description: UserList - If set, the User list returned in XML or JSON format. UserRefList - If set, the link list of Users returned in XML or JSON format.
313-
example: |
314-
application/vnd.ez.api.UserList+xml
315-
application/vnd.ez.api.UserList+json
316-
application/vnd.ez.api.UserRefList+xml
317-
application/vnd.ez.api.UserRefList+json
318-
responses:
319-
200:
320-
description: OK - the Users of the Group with the given ID.
321-
body:
322-
application/vnd.ez.api.UserRefList+xml:
323-
type: UserRefList
324-
example: !include examples/user/groups/id/users/GET/UserRefList.xml.example
325-
application/vnd.ez.api.UserRefList+json:
326-
type: UserRefList
327-
example: !include examples/user/groups/id/users/GET/UserRefList.json.example
328-
401:
329-
description: Error - the user has no permission to read User Groups.
330-
404:
331-
description: Error - the User Group does not exist.
332-
/{id}/subgroups:
333-
get:
334-
displayName: Load subgroups
335-
description: Returns a list of the subgroups.
336-
queryParameters:
337-
limit:
338-
description: The number of Locations returned.
339-
offset:
340-
description: The offset of the result set.
341-
headers:
342-
Accept:
343-
description: UserGroupList - If set, the User Group list is returned in XML or JSON format. UserGroupRefList - If set, the link list of User Groups is returned in XML or JSON format.
344-
example: |
345-
application/vnd.ez.api.UserGroupList+xml
346-
application/vnd.ez.api.UserGroupList+json
347-
application/vnd.ez.api.UserGroupRefList+xml
348-
application/vnd.ez.api.UserGroupRefList+json
349-
responses:
350-
200:
351-
description: OK - list of the subgroups.
352-
body:
353-
application/vnd.ez.api.UserGroupRefList+xml:
354-
type: UserGroupRefList
355-
example: !include examples/user/groups/id/subgroups/GET/UserGroupRefList.xml.example
356-
application/vnd.ez.api.UserGroupRefList+json:
357-
type: UserGroupRefList
358-
example: !include examples/user/groups/id/subgroups/GET/UserGroupRefList.json.example
359-
401:
360-
description: Error - the user has no permission to read User Groups.
361-
404:
362-
description: Error - the User Group does not exist.

0 commit comments

Comments
 (0)