Skip to content

Commit 8f2dc20

Browse files
juskorajuskora
committed
Updated endpoints
1 parent 0831b91 commit 8f2dc20

File tree

7 files changed

+1207
-217
lines changed

7 files changed

+1207
-217
lines changed

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/PATCH/ContentSessionUpdate.json.example‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"ContentSessionUpdate": {
3+
"hasPublicLink": true
4+
}
5+
}

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/PATCH/ContentSessionUpdate.xml.example‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ContentSessionUpdate>
3+
<hasPublicLink>true</hasPublicLink>
4+
</ContentSessionUpdate>

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/PATCH/SessionUpdate.json.example‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
{
2+
"CollaborationSession": {
3+
"_media-type": "application/vnd.ibexa.api.ContentSession+json",
4+
"id": 3,
5+
"token": "dc1b9c13-6e56-4aca-a1f1-b64bfa8ddca4",
6+
"createdAt": "2025-09-19T10:53:40+00:00",
7+
"updatedAt": "2025-09-19T11:25:02+00:00",
8+
"ParticipantList": {
9+
"_media-type": "application/vnd.ibexa.api.ParticipantList+json",
10+
"Participants": [
11+
{
12+
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
13+
"id": 4,
14+
"name": "Administrator User",
15+
"scope": "view",
16+
"User": {
17+
"_media-type": "application/vnd.ibexa.api.User+json",
18+
"_href": "/api/ibexa/v2/user/users/14"
19+
},
20+
"createdAt": "2025-09-19T10:53:40+00:00",
21+
"updatedAt": "2025-09-19T10:53:40+00:00"
22+
},
23+
{
24+
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
25+
"id": 5,
26+
"name": "[email protected]",
27+
"scope": "view",
28+
"email": "[email protected]",
29+
"createdAt": "2025-09-19T10:53:40+00:00",
30+
"updatedAt": "2025-09-19T10:53:40+00:00"
31+
}
32+
]
33+
},
34+
"Owner": {
35+
"_media-type": "application/vnd.ibexa.api.User+json",
36+
"_href": "/api/ibexa/v2/user/users/14"
37+
},
38+
"isActive": true,
39+
"hasPublicLink": true,
40+
"VersionInfo": {
41+
"id": 517,
42+
"versionNo": 1,
43+
"status": "PUBLISHED",
44+
"modificationDate": "2025-09-17T08:05:26+00:00",
45+
"Creator": {
46+
"_media-type": "application/vnd.ibexa.api.User+json",
47+
"_href": "/api/ibexa/v2/user/users/14"
48+
},
49+
"creationDate": "2025-09-17T08:05:26+00:00",
50+
"initialLanguageCode": "eng-GB",
51+
"languageCodes": "eng-GB",
52+
"VersionTranslationInfo": {
53+
"_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
54+
"Language": [
55+
{
56+
"languageCode": "eng-GB"
57+
}
58+
]
59+
},
60+
"names": {
61+
"value": [
62+
{
63+
"_languageCode": "eng-GB",
64+
"#text": "Tags"
65+
}
66+
]
67+
},
68+
"Content": {
69+
"_media-type": "application/vnd.ibexa.api.ContentInfo+json",
70+
"_href": "/api/ibexa/v2/content/objects/57"
71+
}
72+
},
73+
"Language": {
74+
"_media-type": "application/vnd.ibexa.api.Language+json",
75+
"_href": "/api/ibexa/v2/languages/eng-GB",
76+
"languageId": 2,
77+
"languageCode": "eng-GB",
78+
"name": "English (United Kingdom)"
79+
}
80+
}
81+
}

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/create/PATCH/SessionUpdate.xml.example‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<CollaborationSession media-type="application/vnd.ibexa.api.ContentSession+xml">
3+
<id>3</id>
4+
<token>dc1b9c13-6e56-4aca-a1f1-b64bfa8ddca4</token>
5+
<createdAt>2025-09-19T10:53:40+00:00</createdAt>
6+
<updatedAt>2025-09-19T11:26:39+00:00</updatedAt>
7+
<ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml">
8+
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
9+
<id>4</id>
10+
<name>Administrator User</name>
11+
<scope>view</scope>
12+
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
13+
<createdAt>2025-09-19T10:53:40+00:00</createdAt>
14+
<updatedAt>2025-09-19T10:53:40+00:00</updatedAt>
15+
</Participant>
16+
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
17+
<id>5</id>
18+
<name>[email protected]</name>
19+
<scope>view</scope>
20+
<email>[email protected]</email>
21+
<createdAt>2025-09-19T10:53:40+00:00</createdAt>
22+
<updatedAt>2025-09-19T10:53:40+00:00</updatedAt>
23+
</Participant>
24+
</ParticipantList>
25+
<Owner media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
26+
<isActive>true</isActive>
27+
<hasPublicLink>true</hasPublicLink>
28+
<VersionInfo>
29+
<id>517</id>
30+
<versionNo>1</versionNo>
31+
<status>PUBLISHED</status>
32+
<modificationDate>2025-09-17T08:05:26+00:00</modificationDate>
33+
<Creator media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
34+
<creationDate>2025-09-17T08:05:26+00:00</creationDate>
35+
<initialLanguageCode>eng-GB</initialLanguageCode>
36+
<languageCodes>eng-GB</languageCodes>
37+
<VersionTranslationInfo media-type="application/vnd.ibexa.api.VersionTranslationInfo+xml">
38+
<Language>
39+
<languageCode>eng-GB</languageCode>
40+
</Language>
41+
</VersionTranslationInfo>
42+
<names>
43+
<value languageCode="eng-GB">Tags</value>
44+
</names>
45+
<Content media-type="application/vnd.ibexa.api.ContentInfo+xml" href="/api/ibexa/v2/content/objects/57"/>
46+
</VersionInfo>
47+
<Language media-type="application/vnd.ibexa.api.Language+xml" href="/api/ibexa/v2/languages/eng-GB">
48+
<languageId>2</languageId>
49+
<languageCode>eng-GB</languageCode>
50+
<name>English (United Kingdom)</name>
51+
</Language>
52+
</CollaborationSession>

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

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,46 @@ post:
6767
example: !include examples/collaborative_editing/session/GET/CollaborationSession.json.example
6868
404:
6969
description: Error - the session does not exist.
70+
patch:
71+
displayName: Update session
72+
description: Updates session parameters.
73+
headers:
74+
Accept:
75+
description: If set, the updated session is returned in XML or JSON format.
76+
example: |
77+
application/vnd.ibexa.api.ContentSessionUpdate+json
78+
application/vnd.ibexa.api.CollaborationSession+xml
79+
Content-Type:
80+
description: The ParticipantUpdate schema encoded in XML or JSON format.
81+
example: |
82+
application/vnd.ibexa.api.CollaborationSession+json
83+
application/vnd.ibexa.api.CollaborationSession+xmlg
84+
body:
85+
application/vnd.ibexa.api.ParticipantUpdate+xml:
86+
type: ContentSessionUpdate
87+
example: !include examples/collaborative_editing/session/create/PATCH/ContentSessionUpdate.xml.example
88+
application/vnd.ibexa.api.ParticipantUpdate+json:
89+
type: ContentSessionUpdate
90+
example: !include examples/collaborative_editing/session/create/PATCH/ContentSessionUpdate.json.example
91+
92+
responses:
93+
200:
94+
description: OK - session updated.
95+
body:
96+
application/vnd.ibexa.api.SessionUpdate+xml:
97+
type: Session
98+
example: !include examples/collaborative_editing/session/create/PATCH/SessionUpdate.xml.example
99+
application/vnd.ibexa.api.SessionUpdate+json:
100+
type: Session
101+
example: !include examples/collaborative_editing/session/create/PATCH/SessionUpdate.json.example
102+
400:
103+
description: Error - the input does not match the input schema definition.
104+
401:
105+
description: Error - the user is not authorized to update the session.
106+
404:
107+
description: Error - the session does not exist.
108+
412:
109+
description: Error - the current ETag does not match with the provided one in the If-Match header.
70110
/{sessionId}/participants:
71111
get:
72112
displayName: Load participant list
@@ -130,6 +170,7 @@ post:
130170
description: Error - a participant with the same name already exists.
131171
404:
132172
description: Error - no participant with the given ID exists.
173+
133174

134175
/{sessionId}/participants/{participantId}:
135176
patch:

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6490,3 +6490,26 @@ DiscountCondition:
64906490
description: 'Condition parameters.'
64916491
items:
64926492
type: object
6493+
CollaborationSession:
6494+
type: object
6495+
6496+
CollaborationSessionCreate:
6497+
type: object
6498+
6499+
ContentSessionUpdate:
6500+
type: object
6501+
6502+
Participant:
6503+
type: object
6504+
6505+
ParticipantList:
6506+
type: object
6507+
6508+
ParticipantUpdate:
6509+
type: object
6510+
6511+
InvitationCreate:
6512+
type: object
6513+
6514+
Invitation:
6515+
type: object

0 commit comments

Comments
 (0)