REST API: Continue user/users/{userId}/segments

Author: adriendupuis

docs/api/rest_api/rest_api_reference/input/ibexa-types.raml

@@ -2305,6 +2305,29 @@ SegmentUpdateWrapper:
     properties:
         SegmentCreate: SegmentUpdate
 
+UserSegmentList:
+    type: object
+    properties:
+        UserSegment:
+            type: UserSegment[]
+
+UserSegmentListWrapper:
+    description: 'JSON object with only a UserSegmentList property'
+    type: object
+    properties:
+        UserSegmentList: UserSegmentList
+
+UserSegment:
+    type: object
+    properties:
+        id: integer
+        identifier: string
+        name: string
+        SegmentGroup:
+            type: Ref
+        User:
+            type: Ref
+
 SortClause:
     description: 'This class is the base for SortClause classes, used to set sorting of content queries.'
     type: object
@@ -6274,4 +6297,3 @@ ActionConfiguration:
         updatedAt:
             type: datetime
             description: 'Timestamp indicating when the action configuration was last updated.'
-

docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml

@@ -330,13 +330,21 @@ head:
     /segments:
         get:
             displayName: View user segments
-            description: TODO
+            description: Return user's segment list.
             headers:
                 Accept:
                     description: If set, the user's segment list is returned in XML or JSON format.
                     example: |
                         application/vnd.ibexa.api.UserSegmentList+xml
                         application/vnd.ibexa.api.UserSegmentList+json
+            responses:
+                200:
+                    body:
+                        application/vnd.ibexa.api.UserSegmentList+xml:
+                            type: UserSegmentList
+                        application/vnd.ibexa.api.UserSegmentList+json:
+                            type: UserSegmentListWrapper
+                #TODO: 404, 401, …?
         post:
             displayName: Assign Segments to User
             description: Assigns Segments from payload to User given by ID.