IBX-9006: Collaborative editing - REST API documentation

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.json.example

@@ -0,0 +1,14 @@
+{
+    "Participant": {
+        "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
+        "id": "46",
+        "scope": "view",
+        "name": "Editor",
+        "User": {
+            "_media-type": "application/vnd.ibexa.api.User+json",
+            "_href": "/api/ibexa/v2/user/users/70"
+        },
+        "createdAt": "2024-11-14T14:09:47+00:00",
+        "updatedAt": "2024-11-15T13:13:22+00:00"
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.xml.example

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
+    <id>46</id>
+    <name>Editor</name>
+    <scope>view</scope>
+    <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/70"/>
+    <createdAt>2024-11-14T14:09:47+00:00</createdAt>
+    <updatedAt>2024-11-15T12:50:03+00:00</updatedAt>
+</Participant>

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/InternalParticipantUpdate.json.example

@@ -0,0 +1,5 @@
+{
+    "InternalParticipantUpdate": {
+        "scope": "view"
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/InternalParticipantUpdate.xml.example

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<InternalParticipantUpdate>
+    <scope>edit</scope>
+</InternalParticipantUpdate>

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/ParticipantListCreate.json.example

@@ -0,0 +1,19 @@
+{
+    "ParticipantListCreate": {
+        "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"
+                },
+                "scope": "view"
+            },
+            {
+                "_media-type": "application\/vnd.ibexa.api.ExternalParticipantCreate+json",
+                "email": "[email protected]",
+                "scope": "view"
+            }
+        ]
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/ParticipantUpdate.xml.example

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<InternalParticipantUpdate>
+    <scope>view</scope>
+</InternalParticipantUpdate>

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/POST/ParticipantList.json.example

@@ -0,0 +1,112 @@
+{
+    "ParticipantList": {
+        "_media-type": "application/vnd.ibexa.api.ParticipantList+json",
+        "Participants": [
+            {
+                "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
+                "id": 11,
+                "name": "Administrator User",
+                "scope": "edit",
+                "User": {
+                    "_media-type": "application/vnd.ibexa.api.User+json",
+                    "_href": "/api/ibexa/v2/user/users/14"
+                },
+                "createdAt": "2024-11-13T11:01:24+00:00",
+                "updatedAt": "2024-11-13T11:01:24+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
+                "id": 12,
+                "name": "[email protected]",
+                "scope": "view",
+                "email": "[email protected]",
+                "createdAt": "2024-11-13T11:01:24+00:00",
+                "updatedAt": "2024-11-13T11:01:24+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
+                "id": 13,
+                "name": "Administrator User",
+                "scope": "view",
+                "User": {
+                    "_media-type": "application/vnd.ibexa.api.User+json",
+                    "_href": "/api/ibexa/v2/user/users/14"
+                },
+                "createdAt": "2024-11-13T11:02:22+00:00",
+                "updatedAt": "2024-11-13T11:02:22+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
+                "id": 14,
+                "name": "[email protected]",
+                "scope": "view",
+                "email": "[email protected]",
+                "createdAt": "2024-11-13T11:02:22+00:00",
+                "updatedAt": "2024-11-13T11:02:22+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
+                "id": 15,
+                "name": "Administrator User",
+                "scope": "view",
+                "User": {
+                    "_media-type": "application/vnd.ibexa.api.User+json",
+                    "_href": "/api/ibexa/v2/user/users/14"
+                },
+                "createdAt": "2024-11-13T11:10:29+00:00",
+                "updatedAt": "2024-11-13T11:10:29+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
+                "id": 16,
+                "name": "[email protected]",
+                "scope": "view",
+                "email": "[email protected]",
+                "createdAt": "2024-11-13T11:10:29+00:00",
+                "updatedAt": "2024-11-13T11:10:29+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
+                "id": 17,
+                "name": "Administrator User",
+                "scope": "view",
+                "User": {
+                    "_media-type": "application/vnd.ibexa.api.User+json",
+                    "_href": "/api/ibexa/v2/user/users/14"
+                },
+                "createdAt": "2024-11-13T11:43:20+00:00",
+                "updatedAt": "2024-11-13T11:43:20+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
+                "id": 18,
+                "name": "[email protected]",
+                "scope": "view",
+                "email": "[email protected]",
+                "createdAt": "2024-11-13T11:43:20+00:00",
+                "updatedAt": "2024-11-13T11:43:20+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
+                "id": 45,
+                "name": "Administrator User",
+                "scope": "view",
+                "User": {
+                    "_media-type": "application/vnd.ibexa.api.User+json",
+                    "_href": "/api/ibexa/v2/user/users/14"
+                },
+                "createdAt": "2024-11-14T14:09:47+00:00",
+                "updatedAt": "2024-11-14T14:09:47+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
+                "id": 46,
+                "name": "[email protected]",
+                "scope": "view",
+                "email": "[email protected]",
+                "createdAt": "2024-11-14T14:09:47+00:00",
+                "updatedAt": "2024-11-14T14:09:47+00:00"
+            }
+        ]
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/POST/ParticipantList.xml.example

@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml">
+    <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
+        <id>11</id>
+        <name>Administrator User</name>
+        <scope>edit</scope>
+        <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+        <createdAt>2024-11-13T11:01:24+00:00</createdAt>
+        <updatedAt>2024-11-13T11:01:24+00:00</updatedAt>
+    </Participant>
+    <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
+        <id>13</id>
+        <name>Administrator User</name>
+        <scope>view</scope>
+        <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+        <createdAt>2024-11-13T11:02:22+00:00</createdAt>
+        <updatedAt>2024-11-13T11:02:22+00:00</updatedAt>
+    </Participant>
+    <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
+        <id>14</id>
+        <name>[email protected]</name>
+        <scope>view</scope>
+        <email>[email protected]</email>
+        <createdAt>2024-11-13T11:02:22+00:00</createdAt>
+        <updatedAt>2024-11-13T11:02:22+00:00</updatedAt>
+    </Participant>
+    <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
+        <id>15</id>
+        <name>Administrator User</name>
+        <scope>view</scope>
+        <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+        <createdAt>2024-11-13T11:10:29+00:00</createdAt>
+        <updatedAt>2024-11-13T11:10:29+00:00</updatedAt>
+    </Participant>
+    <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
+        <id>16</id>
+        <name>[email protected]</name>
+        <scope>view</scope>
+        <email>[email protected]</email>
+        <createdAt>2024-11-13T11:10:29+00:00</createdAt>
+        <updatedAt>2024-11-13T11:10:29+00:00</updatedAt>
+    </Participant>
+    <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
+        <id>17</id>
+        <name>Administrator User</name>
+        <scope>view</scope>
+        <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+        <createdAt>2024-11-13T11:43:20+00:00</createdAt>
+        <updatedAt>2024-11-13T11:43:20+00:00</updatedAt>
+    </Participant>
+    <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
+        <id>18</id>
+        <name>[email protected]</name>
+        <scope>view</scope>
+        <email>[email protected]</email>
+        <createdAt>2024-11-13T11:43:20+00:00</createdAt>
+        <updatedAt>2024-11-13T11:43:20+00:00</updatedAt>
+    </Participant>
+    <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
+        <id>45</id>
+        <name>Administrator User</name>
+        <scope>view</scope>
+        <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+        <createdAt>2024-11-14T14:09:47+00:00</createdAt>
+        <updatedAt>2024-11-14T14:09:47+00:00</updatedAt>
+    </Participant>
+    <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
+        <id>46</id>
+        <name>[email protected]</name>
+        <scope>view</scope>
+        <email>[email protected]</email>
+        <createdAt>2024-11-14T14:09:47+00:00</createdAt>
+        <updatedAt>2024-11-14T14:09:47+00:00</updatedAt>
+    </Participant>
+    <Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
+        <id>49</id>
+        <name>Administrator User</name>
+        <scope>view</scope>
+        <User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
+        <createdAt>2024-11-15T11:55:38+00:00</createdAt>
+        <updatedAt>2024-11-15T11:55:38+00:00</updatedAt>
+    </Participant>
+    <Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
+        <id>50</id>
+        <name>[email protected]</name>
+        <scope>view</scope>
+        <email>[email protected]</email>
+        <createdAt>2024-11-15T11:55:38+00:00</createdAt>
+        <updatedAt>2024-11-15T11:55:38+00:00</updatedAt>
+    </Participant>
+</ParticipantList>

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/POST/ParticipantListCreate.json.example

@@ -0,0 +1,19 @@
+{
+    "ParticipantListCreate": {
+        "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"
+                },
+                "scope": "view"
+            },
+            {
+                "_media-type": "application\/vnd.ibexa.api.ExternalParticipantCreate+json",
+                "email": "[email protected]",
+                "scope": "view"
+            }
+        ]
+    }
+}

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/POST/ParticipantListCreate.xml.example

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ParticipantListCreate>
+    <ParticipantCreate media-type="application/vnd.ibexa.api.InternalParticipantCreate+xml">
+        <scope>view</scope>
+        <User media-type="application/vnd.ibexa.api.User+xml"
+              href="/api/ibexa/v2/user/users/14"
+        >
+        </User>
+    </ParticipantCreate>
+    <ParticipantCreate media-type="application/vnd.ibexa.api.ExternalParticipantCreate+xml">
+        <email>[email protected]</email>
+        <scope>view</scope>
+    </ParticipantCreate>
+</ParticipantListCreate>

docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/list/GET/ParticipantList.json.example

@@ -0,0 +1,61 @@
+{
+    "ParticipantList": {
+        "_media-type": "application/vnd.ibexa.api.ParticipantList+json",
+        "Participants": [
+            {
+                "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
+                "id": 37,
+                "name": "Editor0 User0",
+                "scope": "edit",
+                "User": {
+                    "_media-type": "application/vnd.ibexa.api.User+json",
+                    "_href": "/api/ibexa/v2/user/users/307"
+                },
+                "createdAt": "2025-04-02T08:17:16+00:00",
+                "updatedAt": "2025-04-02T08:17:16+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
+                "id": 38,
+                "name": "Administrator User",
+                "scope": "view",
+                "User": {
+                    "_media-type": "application/vnd.ibexa.api.User+json",
+                    "_href": "/api/ibexa/v2/user/users/14"
+                },
+                "createdAt": "2025-04-02T08:59:45+00:00",
+                "updatedAt": "2025-04-02T08:59:45+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
+                "id": 39,
+                "name": "[email protected]",
+                "scope": "view",
+                "email": "[email protected]",
+                "createdAt": "2025-04-02T08:59:45+00:00",
+                "updatedAt": "2025-04-02T08:59:45+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
+                "id": 41,
+                "name": "Administrator User",
+                "scope": "view",
+                "User": {
+                    "_media-type": "application/vnd.ibexa.api.User+json",
+                    "_href": "/api/ibexa/v2/user/users/14"
+                },
+                "createdAt": "2025-04-02T09:06:23+00:00",
+                "updatedAt": "2025-04-02T09:06:23+00:00"
+            },
+            {
+                "_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
+                "id": 42,
+                "name": "[email protected]",
+                "scope": "view",
+                "email": "[email protected]",
+                "createdAt": "2025-04-02T09:06:23+00:00",
+                "updatedAt": "2025-04-02T09:06:23+00:00"
+            }
+        ]
+    }
+}