Apply suggestions from code review

juskora · ciastektk · juskora · commit a985acdeb776 · 2025-09-19T15:10:15.000+02:00
Co-authored-by: Tomasz Kryszan &lt;tomasz.kryszan@ibexa.co&gt;
diff --git a/docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSession.json.example b/docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSession.json.example
@@ -3,6 +3,8 @@
         "_media-type": "application/vnd.ibexa.api.ContentSession+json",
         "id": 34,
         "token": "3dbddb0e-e8ac-44bf-9042-57ca0c027f51",
+        "isActive": true,
+        "hasPublicLink": false,
         "createdAt": "2025-04-02T10:32:43+00:00",
         "updatedAt": "2025-04-02T10:32:43+00:00",
         "ParticipantList": {
@@ -11,11 +13,11 @@
                 {
                     "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
                     "id": 50,
-                    "name": "Administrator User",
-                    "scope": "view",
+                    "name": "Editor",
+                    "scope": "edit",
                     "User": {
                         "_media-type": "application/vnd.ibexa.api.User+json",
-                        "_href": "/api/ibexa/v2/user/users/14"
+                        "_href": "/api/ibexa/v2/user/users/70"
                     },
                     "createdAt": "2025-04-02T10:32:43+00:00",
                     "updatedAt": "2025-04-02T10:32:43+00:00"
@@ -35,7 +37,6 @@
             "_media-type": "application/vnd.ibexa.api.User+json",
             "_href": "/api/ibexa/v2/user/users/14"
         },
-        "hasPublicLink": false,
         "VersionInfo": {
             "id": 517,
             "versionNo": 1,
diff --git a/docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSession.xml.example b/docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSession.xml.example
@@ -2,14 +2,16 @@
 <CollaborationSession media-type="application/vnd.ibexa.api.ContentSession+xml">
     <id>38</id>
     <token>899fdbd7-4449-4f48-ae0e-eae56758c51f</token>
+    <isActive>true</isActive>
+    <hasPublicLink>false</hasPublicLink>
     <createdAt>2025-04-02T10:35:57+00:00</createdAt>
     <updatedAt>2025-04-02T10:35:57+00:00</updatedAt>
     <ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml">
         <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
-            <id>52</id>
+            <id>50</id>
             <name>Administrator User</name>
-            <scope>view</scope>
-            <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+            <scope>edit</scope>
+            <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/70"/>
             <createdAt>2025-04-02T10:35:57+00:00</createdAt>
             <updatedAt>2025-04-02T10:35:57+00:00</updatedAt>
         </Participant>
@@ -23,7 +25,6 @@
         </Participant>
     </ParticipantList>
     <Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
-    <hasPublicLink>false</hasPublicLink>
     <VersionInfo>
         <id>490</id>
         <versionNo>1</versionNo>
diff --git a/docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.json.example b/docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.json.example
@@ -1,31 +1,28 @@
 {
-    "CollaborationSessionCreate": {
+    "ContentSessionCreate": {
         "Owner": {
             "_media-type": "application/vnd.ibexa.api.User+json",
             "_href": "/api/ibexa/v2/user/users/14"
         },
-        "SessionTypeCreate": {
-            "_media-type": "application/vnd.ibexa.api.ContentSessionCreate+json",
-            "contentId": 57,
-            "versionNo": 1
-        },
         "ParticipantListCreate": {
             "_media-type": "application\/vnd.ibexa.api.ParticipantListCreate+json",
             "ParticipantCreate": [
                 {
                     "_media-type": "application\/vnd.ibexa.api.InternalParticipantCreate+json",
                     "User": {
                         "_media-type": "application/vnd.ibexa.api.User+json",
-                        "_href": "/api/ibexa/v2/user/users/14"
+                        "_href": "/api/ibexa/v2/user/users/70"
                     },
-                    "scope": "view"
+                    "scope": "edit"
                 },
                 {
                     "_media-type": "application\/vnd.ibexa.api.ExternalParticipantCreate+json",
                     "email": "user@link.invalid",
                     "scope": "view"
                 }
             ]
-        }
+        },
+        "contentId": 57,
+        "versionNo": 1
     }
 }
diff --git a/docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.xml.example b/docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.xml.example
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<CollaborationSessionCreate>
+<ContentSessionCreate>
     <Owner media-type="application/vnd.ibexa.api.User+xml"
            href="/api/ibexa/v2/user/users/14"
     >
     </Owner>
     <ParticipantListCreate media-type="application/vnd.ibexa.api.ParticipantListCreate+xml">
         <ParticipantCreate media-type="application/vnd.ibexa.api.InternalParticipantCreate+xml">
-            <scope>view</scope>
+            <scope>edit</scope>
             <User media-type="application/vnd.ibexa.api.User+xml"
-                  href="/api/ibexa/v2/user/users/14"
+                  href="/api/ibexa/v2/user/users/1470
             >
             </User>
         </ParticipantCreate>
@@ -17,8 +17,6 @@
             <scope>view</scope>
         </ParticipantCreate>
     </ParticipantListCreate>
-    <SessionTypeCreate media-type="application/vnd.ibexa.api.ContentSessionCreate+xml">
-        <contentId>51</contentId>
-        <versionNo>1</versionNo>
-    </SessionTypeCreate>
-</CollaborationSessionCreate>
+    <contentId>57</contentId>
+    <versionNo>1</versionNo>
+</ContentSessionCreate>
diff --git a/docs/api/rest_api/rest_api_reference/input/ibexa-collaborativeediting-session.raml b/docs/api/rest_api/rest_api_reference/input/ibexa-collaborativeediting-session.raml
@@ -38,7 +38,7 @@ post:
         404:
             description: Error - no session with the given ID exists.
 
-/{sessionId}:
+/{sessionToken}:
     delete:
         displayName: Delete session (collaboration)
         description: The collaboration session is deleted.

Original file line number	Diff line number	Diff line change
`@@ -1,31 +1,28 @@`
`1`	`1`	`{`
`2`		`- "CollaborationSessionCreate": {`
	`2`	`+ "ContentSessionCreate": {`
`3`	`3`	`"Owner": {`
`4`	`4`	`"_media-type": "application/vnd.ibexa.api.User+json",`
`5`	`5`	`"_href": "/api/ibexa/v2/user/users/14"`
`6`	`6`	`},`
`7`		`- "SessionTypeCreate": {`
`8`		`- "_media-type": "application/vnd.ibexa.api.ContentSessionCreate+json",`
`9`		`- "contentId": 57,`
`10`		`- "versionNo": 1`
`11`		`- },`
`12`	`7`	`"ParticipantListCreate": {`
`13`	`8`	`"_media-type": "application\/vnd.ibexa.api.ParticipantListCreate+json",`
`14`	`9`	`"ParticipantCreate": [`
`15`	`10`	`{`
`16`	`11`	`"_media-type": "application\/vnd.ibexa.api.InternalParticipantCreate+json",`
`17`	`12`	`"User": {`
`18`	`13`	`"_media-type": "application/vnd.ibexa.api.User+json",`
`19`		`- "_href": "/api/ibexa/v2/user/users/14"`
	`14`	`+ "_href": "/api/ibexa/v2/user/users/70"`
`20`	`15`	`},`
`21`		`- "scope": "view"`
	`16`	`+ "scope": "edit"`
`22`	`17`	`},`
`23`	`18`	`{`
`24`	`19`	`"_media-type": "application\/vnd.ibexa.api.ExternalParticipantCreate+json",`
`25`	`20`	`"email": "[email protected]",`
`26`	`21`	`"scope": "view"`
`27`	`22`	`}`
`28`	`23`	`]`
`29`		`- }`
	`24`	`+ },`
	`25`	`+ "contentId": 57,`
	`26`	`+ "versionNo": 1`
`30`	`27`	`}`
`31`	`28`	`}`