Skip to content

Commit 3f1f5b2

Browse files
committed
Updated doc
1 parent 5365eef commit 3f1f5b2

File tree

5 files changed

+237
-203
lines changed

5 files changed

+237
-203
lines changed

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/ibexa-collaborativeediting-session.raml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ post:
2121
example: !include examples/collaborative_editing/session/create/POST/CollaborationSessionCreate.json.example
2222
responses:
2323
201:
24+
description: Created.
2425
body:
2526
application/vnd.ibexa.api.CollaborationSession+xml:
2627
type: Session
@@ -56,6 +57,7 @@ post:
5657
application/vnd.ibexa.api.CollaborationSession+json
5758
responses:
5859
200:
60+
description: Details loaded.
5961
body:
6062
application/vnd.ibexa.api.CollaborationSession+xml:
6163
type: CollaborationSession
@@ -71,10 +73,11 @@ post:
7173
description: Loads participant list.
7274
queryParameters:
7375
sessionId:
74-
description: Retrieves the participant list for a given collaboration session ID (e.g. GET /collaboration/session/1234).
76+
description: Retrieves the participant list for a given collaboration session ID.
7577
headers:
7678
Accept:
7779
description: ParticipantList - If set, the participant list is returned in XML or JSON format.
80+
example: |
7881
application/vnd.ibexa.api.ParticipantList+xml
7982
application/vnd.ibexa.api.ParticipantList+json
8083
responses:

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

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

0 commit comments

Comments
 (0)