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

Author: adriendupuis

docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentAssignInput.json.example

@@ -0,0 +1,5 @@
+{
+    "UserSegmentAssignInput": {
+        "segments": ["corporate_account"]
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentAssignInput.xml.example

@@ -0,0 +1,3 @@
+<UserSegmentAssignInput>
+    <segments>corporate_account</segments>
+</UserSegmentAssignInput>

docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentList.json.example

@@ -0,0 +1,22 @@
+{
+    "UserSegmentList": {
+        "_media-type": "application\/vnd.ibexa.api.UserSegmentList+json",
+        "_href": "\/api\/ibexa\/v2\/user\/users\/14\/segments",
+        "UserSegment": [
+            {
+                "_media-type": "application\/vnd.ibexa.api.UserSegment+json",
+                "id": 1,
+                "identifier": "corporate_account",
+                "name": "Corporate Account",
+                "SegmentGroup": {
+                    "_media-type": "application\/vnd.ibexa.api.SegmentGroup+json",
+                    "_href": "\/api\/ibexa\/v2\/segment_groups\/corporate_accounts"
+                },
+                "User": {
+                    "_media-type": "application\/vnd.ibexa.api.User+json",
+                    "_href": "\/api\/ibexa\/v2\/user\/users\/14"
+                }
+            }
+        ]
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/user/users/user_id/segments/UserSegmentList.xml.example

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<UserSegmentList media-type="application/vnd.ibexa.api.UserSegmentList+xml" href="/api/ibexa/v2/user/users/14/segments">
+ <UserSegment media-type="application/vnd.ibexa.api.UserSegment+xml">
+  <id>1</id>
+  <identifier>corporate_account</identifier>
+  <name>Corporate Account</name>
+  <SegmentGroup media-type="application/vnd.ibexa.api.SegmentGroup+xml" href="/api/ibexa/v2/segment_groups/corporate_accounts"/>
+  <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+ </UserSegment>
+</UserSegmentList>

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

@@ -2306,6 +2306,7 @@ SegmentUpdateWrapper:
         SegmentCreate: SegmentUpdate
 
 UserSegmentList:
+    description: 'This class lists segment assignements.'
     type: object
     properties:
         UserSegment:
@@ -2318,6 +2319,7 @@ UserSegmentListWrapper:
         UserSegmentList: UserSegmentList
 
 UserSegment:
+    description: 'This class reprensents a segment assigned to a user'
     type: object
     properties:
         id: integer
@@ -2328,6 +2330,20 @@ UserSegment:
         User:
             type: Ref
 
+UserSegmentAssignInput:
+    description: 'This class represents a segment assignment input.'
+    type: object
+    properties:
+        segments:
+            type: array
+            items: string
+
+UserSegmentAssignInputWrapper:
+    description: 'JSON object with only a UserSegmentAssignInput property.'
+    type: object
+    properties:
+        UserSegmentAssignInput: UserSegmentAssignInput
+
 SortClause:
     description: 'This class is the base for SortClause classes, used to set sorting of content queries.'
     type: object

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

@@ -342,8 +342,10 @@ head:
                     body:
                         application/vnd.ibexa.api.UserSegmentList+xml:
                             type: UserSegmentList
+                            example: !include examples/user/users/user_id/segments/UserSegmentList.xml.example
                         application/vnd.ibexa.api.UserSegmentList+json:
                             type: UserSegmentListWrapper
+                            example: !include examples/user/users/user_id/segments/UserSegmentList.json.example
                 404:
                     description: Error - the user doesn't exist.
         post:
@@ -355,10 +357,31 @@ head:
                     example: |
                         application/vnd.ibexa.api.UserSegmentAssignInput+xml
                         application/vnd.ibexa.api.UserSegmentAssignInput+json
+            body:
+                application/vnd.ibexa.api.UserSegmentAssignInput+xml:
+                    type: UserSegmentAssignInput
+                    example: !include examples/user/users/user_id/segments/UserSegmentAssignInput.xml.example
+                application/vnd.ibexa.api.UserSegmentAssignInput+json:
+                    type: UserSegmentAssignInputWrapper
+                    example: !include examples/user/users/user_id/segments/UserSegmentAssignInput.json.example
+            responses:
+                204:
+                    description: No Content - segments assigned to user.
+                401:
+                    description: Error - the requesting user is not authorized to assign this segment to the given user.
+                404:
+                    description: Error - the user doesn't exist.
         /{segmentIdentifier}:
             delete:
                 displayName: Unassign Segment from User
                 description: The Segment designated by its identifier is unassigned from the User given by ID.
+                responses:
+                    204:
+                        description: No Content - segments unassigned from user.
+                    401:
+                        description: Error - the requesting user is not authorized to unassign this segment from the given user.
+                    404:
+                        description: Error - the segment or the user doesn't exist.
     /drafts:
         get:
             displayName: Load user drafts