IBX-9006: Collaborative editing - REST API documentation #2528

julitafalcondusza · 2024-10-29T09:47:52Z

Question	Answer
JIRA Ticket	(https://issues.ibexa.co/browse/IBX-9006)
Versions	4.6+

Before merging, please test as a doc review.

Collaborative editing - REST API documentation:
Doc preview: https://ez-systems-developer-documentation--2528.com.readthedocs.build/en/2528/api/rest_api/rest_api_reference/rest_api_reference.html#collaborative-editing

[REST] Endpoint for initiating collaboration session (https://issues.ibexa.co/browse/IBX-8739)
[REST] Endpoint for deleting collaboration session (https://issues.ibexa.co/browse/IBX-8744)
[REST] Add input validation for create collaboration session endpoint (https://issues.ibexa.co/browse/IBX-9048)
[REST] Endpoint for retrieving collaboration session details (https://issues.ibexa.co/browse/IBX-8745)
[REST] Endpoint for updating participant scope (https://issues.ibexa.co/browse/IBX-8741)
[REST] Endpoint for removing participant (https://issues.ibexa.co/browse/IBX-8742)
[REST] Endpoint for listing participants (https://issues.ibexa.co/browse/IBX-8743)
[REST] Endpoint for add participant (https://issues.ibexa.co/browse/IBX-9001)
[REST] Endpoint for creating collaboration invitation (https://issues.ibexa.co/browse/IBX-8740)
[REST] Endpoint to list users with their permissions to content item (https://issues.ibexa.co/browse/IBX-9002)

Checklist

Text renders correctly
Text has been checked with vale
Description metadata is up to date
Redirects cover removed/moved pages
Code samples are working
PHP code samples have been fixed with PHP CS fixer
Added link to this PR in relevant JIRA ticket or code PR

github-actions · 2025-04-02T11:23:10Z

Preview of modified Markdown: no Markdown change to preview.

github-actions · 2025-09-01T10:00:14Z

Preview of modified files: no change to preview.

...t/examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.json.example

...ut/examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.xml.example

...e/input/examples/collaborative_editing/session/create/POST/CollaborationSession.json.example

...ce/input/examples/collaborative_editing/session/create/POST/CollaborationSession.xml.example

...reference/input/examples/collaborative_editing/session/GET/CollaborationSession.json.example

..._reference/input/examples/collaborative_editing/session/GET/CollaborationSession.xml.example

...e/input/examples/collaborative_editing/session/create/POST/CollaborationSession.json.example

...ce/input/examples/collaborative_editing/session/create/POST/CollaborationSession.xml.example

ciastektk

Incorrect responses for internal participant update

.../input/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.json.example

...e/input/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.xml.example

ciastektk · 2025-09-17T10:26:01Z

Missing section about session updates:

Method: PATCH

{
    "ContentSessionUpdate": {
        "hasPublicLink": true
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<ContentSessionUpdate>
    <hasPublicLink>true</hasPublicLink>
</ContentSessionUpdate>

docs/api/rest_api/rest_api_reference/input/ibexa-collaborativeediting-session.raml

Co-authored-by: Tomasz Kryszan <[email protected]>

ciastektk · 2025-09-23T08:46:01Z

docs/api/rest_api/rest_api_reference/input/ibexa-collaborativeediting-session.raml

+<<<<<<< HEAD
+/{sessionToken}/participants:
+=======
+/{sessionId}/participants:
+>>>>>>> 4b9d881fa945112fde19d619e21bd8be8c3884ba


Seems that diffs from conflict resolving is added here and below.

ciastektk · 2025-09-23T08:47:02Z

docs/api/rest_api/rest_api_reference/input/ibexa-collaborativeediting-session.raml

+                description: Error - no session with the given ID exists.
+=======
+                description: Error - no session with the given ID exists.
+/{sessionId}/link:


As I mentioned, this is internal endpoint and it should not be presented.

...t/examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.json.example

...ut/examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.xml.example

...ce/input/examples/collaborative_editing/session/create/POST/CollaborationSession.xml.example

...e/input/examples/collaborative_editing/session/create/POST/CollaborationSession.json.example

docs/api/rest_api/rest_api_reference/input/ibexa-collaborativeediting-session.raml

Co-authored-by: Tomasz Kryszan <[email protected]>

…ive_editing/session/GET/Session.json.example

…ive_editing/session/GET/Session.xml.example

julitafalcondusza · 2025-10-01T11:45:48Z

Checked and approved from my side (cannot approve as I'm the author of the PR) ✅

juskora force-pushed the IBX-9006 branch 2 times, most recently from 9869bdb to b51e407 Compare November 18, 2024 08:42

juskora added the Needs DEV review label Nov 18, 2024

juskora requested a review from ciastektk November 18, 2024 08:42

juskora marked this pull request as ready for review November 19, 2024 11:30

mnocon changed the base branch from master to 5.0 May 19, 2025 07:33

juskora changed the base branch from 5.0 to 4.6 August 29, 2025 07:22

juskora changed the base branch from 4.6 to 5.0 August 29, 2025 07:23

juskora changed the base branch from 5.0 to 4.6 September 1, 2025 07:58

mnocon changed the base branch from 4.6 to 5.0 September 1, 2025 09:37

mnocon changed the base branch from 5.0 to 4.6 September 1, 2025 09:48

mnocon force-pushed the IBX-9006 branch from 74179cf to 884eeb6 Compare September 1, 2025 09:49

IBX-9006: Collaborative editing - REST API documentation

5365eef

mnocon force-pushed the IBX-9006 branch from 884eeb6 to 5365eef Compare September 1, 2025 09:52

Updated doc

3f1f5b2

juskora force-pushed the IBX-9006 branch from 193a36b to 3f1f5b2 Compare September 2, 2025 07:31

ciastektk requested changes Sep 17, 2025

View reviewed changes

.../input/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.json.example Show resolved Hide resolved

...e/input/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.xml.example Outdated Show resolved Hide resolved

ciastektk requested changes Sep 17, 2025

View reviewed changes

docs/api/rest_api/rest_api_reference/input/ibexa-collaborativeediting-session.raml Outdated Show resolved Hide resolved

juskora and others added 8 commits September 18, 2025 14:08

Apply suggestions from code review

6379546

Co-authored-by: Tomasz Kryszan <[email protected]>

Added REST fixes

b893de7

Fixes after review

0831b91

Updated endpoints

8f2dc20

IBX-9006: Collaborative editing - REST API documentation

e560af8

Updated doc

fdef4a7

Apply suggestions from code review

a985acd

Co-authored-by: Tomasz Kryszan <[email protected]>

Added REST fixes

9e3c21e

juskora added 2 commits September 19, 2025 15:10

Fixes after review

0047c84

Updated endpoints

4b9d881

juskora force-pushed the IBX-9006 branch from 8f2dc20 to 4b9d881 Compare September 19, 2025 13:10

juskora added 2 commits September 19, 2025 15:52

Fixes after review

0830bd3

Fixes

24f8d63

juskora requested a review from ciastektk September 23, 2025 06:53

ciastektk requested changes Sep 23, 2025

View reviewed changes

juskora added 2 commits September 23, 2025 10:54

Fixes

ac73883

Added raml file

4c60378

ciastektk reviewed Sep 23, 2025

View reviewed changes

docs/api/rest_api/rest_api_reference/input/ibexa-collaborativeediting-session.raml Outdated Show resolved Hide resolved

juskora and others added 2 commits September 23, 2025 14:06

Apply suggestions from code review

3a9b19c

Co-authored-by: Tomasz Kryszan <[email protected]>

Changes

a648d17

juskora added Needs DOC review and removed Needs DEV review labels Sep 23, 2025

ciastektk approved these changes Sep 23, 2025

View reviewed changes

juskora added 2 commits September 23, 2025 14:46

Delete docs/api/rest_api/rest_api_reference/input/examples/collaborat…

6b82ade

…ive_editing/session/GET/Session.json.example

Delete docs/api/rest_api/rest_api_reference/input/examples/collaborat…

01d86f3

…ive_editing/session/GET/Session.xml.example

julitafalcondusza added Ready for MERGE and removed Needs DOC review labels Oct 1, 2025

julitafalcondusza merged commit b72713f into 4.6 Oct 2, 2025
6 of 7 checks passed

julitafalcondusza deleted the IBX-9006 branch October 2, 2025 08:08

IBX-9006: Collaborative editing - REST API documentation #2528

IBX-9006: Collaborative editing - REST API documentation #2528

Uh oh!

Conversation

julitafalcondusza commented Oct 29, 2024 • edited by juskora Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

github-actions bot commented Apr 2, 2025

Uh oh!

github-actions bot commented Sep 1, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ciastektk left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ciastektk commented Sep 17, 2025

Uh oh!

Uh oh!

ciastektk Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

ciastektk Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

julitafalcondusza commented Oct 1, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

julitafalcondusza commented Oct 29, 2024 •

edited by juskora

Loading

ciastektk left a comment •

edited

Loading