Skip to content

Commit 697951b

Browse files
juskorajuskora
committed
Fixes
1 parent 3d56dd5 commit 697951b

File tree

11 files changed

+730
-443
lines changed

11 files changed

+730
-443
lines changed

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

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,57 @@
44
"Participants": [
55
{
66
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
7-
"id": 39,
8-
"name": "Administrator User",
7+
"id": 37,
8+
"name": "Editor0 User0",
99
"scope": "edit",
10+
"User": {
11+
"_media-type": "application/vnd.ibexa.api.User+json",
12+
"_href": "/api/ibexa/v2/user/users/307"
13+
},
14+
"createdAt": "2025-04-02T08:17:16+00:00",
15+
"updatedAt": "2025-04-02T08:17:16+00:00"
16+
},
17+
{
18+
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
19+
"id": 38,
20+
"name": "Administrator User",
21+
"scope": "view",
1022
"User": {
1123
"_media-type": "application/vnd.ibexa.api.User+json",
1224
"_href": "/api/ibexa/v2/user/users/14"
1325
},
14-
"createdAt": "2024-11-14T11:34:41+00:00",
15-
"updatedAt": "2024-11-14T11:34:41+00:00"
26+
"createdAt": "2025-04-02T08:59:45+00:00",
27+
"updatedAt": "2025-04-02T08:59:45+00:00"
1628
},
1729
{
1830
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
19-
"id": 40,
31+
"id": 39,
2032
"name": "[email protected]",
2133
"scope": "view",
2234
"email": "[email protected]",
23-
"createdAt": "2024-11-14T11:34:41+00:00",
24-
"updatedAt": "2024-11-14T11:34:41+00:00"
35+
"createdAt": "2025-04-02T08:59:45+00:00",
36+
"updatedAt": "2025-04-02T08:59:45+00:00"
37+
},
38+
{
39+
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
40+
"id": 41,
41+
"name": "Administrator User",
42+
"scope": "view",
43+
"User": {
44+
"_media-type": "application/vnd.ibexa.api.User+json",
45+
"_href": "/api/ibexa/v2/user/users/14"
46+
},
47+
"createdAt": "2025-04-02T09:06:23+00:00",
48+
"updatedAt": "2025-04-02T09:06:23+00:00"
49+
},
50+
{
51+
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
52+
"id": 42,
53+
"name": "[email protected]",
54+
"scope": "view",
55+
"email": "[email protected]",
56+
"createdAt": "2025-04-02T09:06:23+00:00",
57+
"updatedAt": "2025-04-02T09:06:23+00:00"
2558
}
2659
]
2760
}

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

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,43 @@
1-
<?xml version="1.0"?>
1+
<?xml version="1.0" encoding="UTF-8"?>
22
<ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml">
33
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
4-
<id>__FIXED_ID__</id>
5-
<name>Anonymous User</name>
4+
<id>37</id>
5+
<name>Editor0 User0</name>
66
<scope>edit</scope>
7-
<User href="/api/ibexa/v2/user/users/__FIXED_ID__" media-type="application/vnd.ibexa.api.User+xml"/>
8-
<createdAt>__CREATED_AT__</createdAt>
9-
<updatedAt>__UPDATED_AT__</updatedAt>
7+
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/307"/>
8+
<createdAt>2025-04-02T08:17:16+00:00</createdAt>
9+
<updatedAt>2025-04-02T08:17:16+00:00</updatedAt>
10+
</Participant>
11+
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
12+
<id>38</id>
13+
<name>Administrator User</name>
14+
<scope>view</scope>
15+
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
16+
<createdAt>2025-04-02T08:59:45+00:00</createdAt>
17+
<updatedAt>2025-04-02T08:59:45+00:00</updatedAt>
18+
</Participant>
19+
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
20+
<id>39</id>
21+
<name>[email protected]</name>
22+
<scope>view</scope>
23+
<email>[email protected]</email>
24+
<createdAt>2025-04-02T08:59:45+00:00</createdAt>
25+
<updatedAt>2025-04-02T08:59:45+00:00</updatedAt>
26+
</Participant>
27+
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
28+
<id>41</id>
29+
<name>Administrator User</name>
30+
<scope>view</scope>
31+
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
32+
<createdAt>2025-04-02T09:06:23+00:00</createdAt>
33+
<updatedAt>2025-04-02T09:06:23+00:00</updatedAt>
1034
</Participant>
1135
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
12-
<id>__FIXED_ID__</id>
13-
<name>[email protected]</name>
36+
<id>42</id>
37+
<name>[email protected]</name>
1438
<scope>view</scope>
15-
<email>[email protected]</email>
16-
<createdAt>__CREATED_AT__</createdAt>
17-
<updatedAt>__UPDATED_AT__</updatedAt>
39+
<email>[email protected]</email>
40+
<createdAt>2025-04-02T09:06:23+00:00</createdAt>
41+
<updatedAt>2025-04-02T09:06:23+00:00</updatedAt>
1842
</Participant>
1943
</ParticipantList>

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/GET/Session.json.example‎

Whitespace-only changes.

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/GET/Session.xml.example‎

Whitespace-only changes.

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSession.json.example‎

Lines changed: 53 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,80 @@
11
{
22
"CollaborationSession": {
3-
"_media-type": "application/vnd.ibexa.api.CollaborationSession+json",
4-
"id": 17,
5-
"token": "f637f415-688a-4655-a3c5-e209e2bd6771",
6-
"createdAt": "2024-11-14T11:34:40+00:00",
7-
"updatedAt": "2024-11-14T11:34:40+00:00",
3+
"_media-type": "application/vnd.ibexa.api.ContentSession+json",
4+
"id": 34,
5+
"token": "3dbddb0e-e8ac-44bf-9042-57ca0c027f51",
6+
"createdAt": "2025-04-02T10:32:43+00:00",
7+
"updatedAt": "2025-04-02T10:32:43+00:00",
88
"ParticipantList": {
99
"_media-type": "application/vnd.ibexa.api.ParticipantList+json",
1010
"Participants": [
1111
{
1212
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
13-
"id": 39,
13+
"id": 50,
1414
"name": "Administrator User",
15-
"scope": "edit",
15+
"scope": "view",
1616
"User": {
1717
"_media-type": "application/vnd.ibexa.api.User+json",
1818
"_href": "/api/ibexa/v2/user/users/14"
1919
},
20-
"createdAt": "2024-11-14T11:34:41+00:00",
21-
"updatedAt": "2024-11-14T11:34:41+00:00"
20+
"createdAt": "2025-04-02T10:32:43+00:00",
21+
"updatedAt": "2025-04-02T10:32:43+00:00"
2222
},
2323
{
2424
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
25-
"id": 40,
25+
"id": 51,
2626
"name": "[email protected]",
2727
"scope": "view",
2828
"email": "[email protected]",
29-
"createdAt": "2024-11-14T11:34:41+00:00",
30-
"updatedAt": "2024-11-14T11:34:41+00:00"
29+
"createdAt": "2025-04-02T10:32:43+00:00",
30+
"updatedAt": "2025-04-02T10:32:43+00:00"
3131
}
3232
]
3333
},
3434
"Owner": {
3535
"_media-type": "application/vnd.ibexa.api.User+json",
3636
"_href": "/api/ibexa/v2/user/users/14"
37+
},
38+
"hasPublicLink": false,
39+
"VersionInfo": {
40+
"id": 517,
41+
"versionNo": 1,
42+
"status": "PUBLISHED",
43+
"modificationDate": "2025-03-03T14:09:56+00:00",
44+
"Creator": {
45+
"_media-type": "application/vnd.ibexa.api.User+json",
46+
"_href": "/api/ibexa/v2/user/users/14"
47+
},
48+
"creationDate": "2025-03-03T14:09:56+00:00",
49+
"initialLanguageCode": "eng-GB",
50+
"languageCodes": "eng-GB",
51+
"VersionTranslationInfo": {
52+
"_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
53+
"Language": [
54+
{
55+
"languageCode": "eng-GB"
56+
}
57+
]
58+
},
59+
"names": {
60+
"value": [
61+
{
62+
"_languageCode": "eng-GB",
63+
"#text": "Tags"
64+
}
65+
]
66+
},
67+
"Content": {
68+
"_media-type": "application/vnd.ibexa.api.ContentInfo+json",
69+
"_href": "/api/ibexa/v2/content/objects/57"
70+
}
71+
},
72+
"Language": {
73+
"_media-type": "application/vnd.ibexa.api.Language+json",
74+
"_href": "/api/ibexa/v2/languages/eng-GB",
75+
"languageId": 2,
76+
"languageCode": "eng-GB",
77+
"name": "English (United Kingdom)"
3778
}
3879
}
3980
}

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSession.xml.example‎

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,51 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<CollaborationSession media-type="application/vnd.ibexa.api.CollaborationSession+xml">
3-
<id>20</id>
4-
<token>076e749e-20ed-4df7-a8a0-e9c8ba8edbf5</token>
5-
<createdAt>2024-11-15T10:06:04+00:00</createdAt>
6-
<updatedAt>2024-11-15T10:06:04+00:00</updatedAt>
2+
<CollaborationSession media-type="application/vnd.ibexa.api.ContentSession+xml">
3+
<id>38</id>
4+
<token>899fdbd7-4449-4f48-ae0e-eae56758c51f</token>
5+
<createdAt>2025-04-02T10:35:57+00:00</createdAt>
6+
<updatedAt>2025-04-02T10:35:57+00:00</updatedAt>
77
<ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml">
88
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
9-
<id>47</id>
9+
<id>52</id>
1010
<name>Administrator User</name>
1111
<scope>view</scope>
1212
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
13-
<createdAt>2024-11-15T10:06:04+00:00</createdAt>
14-
<updatedAt>2024-11-15T10:06:04+00:00</updatedAt>
13+
<createdAt>2025-04-02T10:35:57+00:00</createdAt>
14+
<updatedAt>2025-04-02T10:35:57+00:00</updatedAt>
1515
</Participant>
1616
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
17-
<id>48</id>
17+
<id>53</id>
1818
<name>[email protected]</name>
1919
<scope>view</scope>
2020
<email>[email protected]</email>
21-
<createdAt>2024-11-15T10:06:04+00:00</createdAt>
22-
<updatedAt>2024-11-15T10:06:04+00:00</updatedAt>
21+
<createdAt>2025-04-02T10:35:57+00:00</createdAt>
22+
<updatedAt>2025-04-02T10:35:57+00:00</updatedAt>
2323
</Participant>
2424
</ParticipantList>
2525
<Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
26+
<hasPublicLink>false</hasPublicLink>
27+
<VersionInfo>
28+
<id>490</id>
29+
<versionNo>1</versionNo>
30+
<status>PUBLISHED</status>
31+
<modificationDate>2004-03-25T13:10:33+00:00</modificationDate>
32+
<Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
33+
<creationDate>2004-03-25T13:10:25+00:00</creationDate>
34+
<initialLanguageCode>eng-GB</initialLanguageCode>
35+
<languageCodes>eng-GB</languageCodes>
36+
<VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml">
37+
<Language>
38+
<languageCode>eng-GB</languageCode>
39+
</Language>
40+
</VersionTranslationInfo>
41+
<names>
42+
<value languageCode="eng-GB">Multimedia</value>
43+
</names>
44+
<Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/51"/>
45+
</VersionInfo>
46+
<Language media-type="application/vnd.ibexa.api.Language+xml" href="/api/ibexa/v2/languages/eng-GB">
47+
<languageId>2</languageId>
48+
<languageCode>eng-GB</languageCode>
49+
<name>English (United Kingdom)</name>
50+
</Language>
2651
</CollaborationSession>

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.json.example‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
"_href": "/api/ibexa/v2/user/users/14"
66
},
77
"SessionTypeCreate": {
8-
"_media-type": "application/vnd.ibexa.api.ExampleSessionCreate+json",
9-
"subject": "example"
8+
"_media-type": "application/vnd.ibexa.api.ContentSessionCreate+json",
9+
"contentId": 57,
10+
"versionNo": 1
1011
},
1112
"ParticipantListCreate": {
1213
"_media-type": "application\/vnd.ibexa.api.ParticipantListCreate+json",
@@ -17,7 +18,7 @@
1718
"_media-type": "application/vnd.ibexa.api.User+json",
1819
"_href": "/api/ibexa/v2/user/users/14"
1920
},
20-
"scope": "edit"
21+
"scope": "view"
2122
},
2223
{
2324
"_media-type": "application\/vnd.ibexa.api.ExternalParticipantCreate+json",

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.xml.example‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
<scope>view</scope>
1818
</ParticipantCreate>
1919
</ParticipantListCreate>
20-
<SessionTypeCreate media-type="application/vnd.ibexa.api.ExampleSessionCreate+xml">
21-
<subject>example</subject>
20+
<SessionTypeCreate media-type="application/vnd.ibexa.api.ContentSessionCreate+xml">
21+
<contentId>51</contentId>
22+
<versionNo>1</versionNo>
2223
</SessionTypeCreate>
2324
</CollaborationSessionCreate>

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

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,6 @@ post:
4141
delete:
4242
displayName: Delete session (collaboration)
4343
description: The collaboration session is deleted.
44-
headers:
45-
Cookie:
46-
description: "{sessionName}={sessionID}"
47-
X-CSRF-Token:
48-
description: The {csrfToken} needed on all unsafe HTTP methods with session.
4944
responses:
5045
204:
5146
description: OK - session deleted.
@@ -55,10 +50,6 @@ post:
5550
displayName: Retrieve session details
5651
description: Get the collaboration session's information.
5752
headers:
58-
Cookie:
59-
description: "{sessionName}={sessionID}"
60-
X-CSRF-Token:
61-
description: The {csrfToken} needed on all unsafe HTTP methods with session.
6253
Accept:
6354
example: |
6455
application/vnd.ibexa.api.CollaborationSession+xml
@@ -98,8 +89,6 @@ post:
9889
example: !include examples/collaborative_editing/participant/list/GET/ParticipantList.json.example
9990
404:
10091
description: If there are no visibile participants matching the filter.
101-
102-
/{sessionId}/participants:
10392
post:
10493
displayName: Add participant
10594
description: Adds new participant.
@@ -233,4 +222,24 @@ post:
233222
403:
234223
description: Error - an invitation with the same ID already exists.
235224
404:
236-
description: Error - no session with the given ID exists.
225+
description: Error - no session with the given ID exists.
226+
/{sessionId}/link:
227+
get:
228+
displayName: Retrieve collaboration session link.
229+
description: Get the collaboration session link.
230+
headers:
231+
Accept:
232+
example: |
233+
application/vnd.ibexa.api.CollaborationSession+xml
234+
application/vnd.ibexa.api.CollaborationSession+json
235+
responses:
236+
200:
237+
body:
238+
application/vnd.ibexa.api.Session+xml:
239+
type: Session
240+
example: !include examples/collaborative_editing/session/GET/Session.xml.example
241+
application/vnd.ibexa.api.Session+json:
242+
type: Session
243+
example: !include examples/collaborative_editing/session/GET/Session.json.example
244+
404:
245+
description: Error - the session does not exist.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5958,4 +5958,4 @@ ParticipantUpdate:
59585958
InvitationCreate:
59595959
type: object
59605960
Invitation:
5961-
type: object
5961+
type: object

0 commit comments

Comments
 (0)