Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e8fab78
Collaboration - REST API
julitafalcondusza Oct 29, 2024
883432f
Collaboration - REST API
julitafalcondusza Oct 29, 2024
b51e407
Added REST fixes
juskora Nov 15, 2024
fe70401
Added REST fixes
juskora Nov 15, 2024
747cc45
Link fixes
juskora Nov 18, 2024
6fb9e96
RAML fix
juskora Nov 18, 2024
3d56dd5
Fixes routes
juskora Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions ...put/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.json.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"Participant": {
"_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-15T13:13:22+00:00"
}
}
9 changes: 9 additions & 0 deletions ...nput/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.xml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
<id>46</id>
<name>[email protected]</name>
<scope>edit</scope>
<email>[email protected]</email>
<createdAt>2024-11-14T14:09:47+00:00</createdAt>
<updatedAt>2024-11-15T12:50:03+00:00</updatedAt>
</Participant>
5 changes: 5 additions & 0 deletions ...amples/collaborative_editing/participant/add/PATCH/InternalParticipantUpdate.json.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"InternalParticipantUpdate": {
"scope": "view"
}
}
4 changes: 4 additions & 0 deletions ...xamples/collaborative_editing/participant/add/PATCH/InternalParticipantUpdate.xml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<InternalParticipantUpdate>
<scope>edit</scope>
</InternalParticipantUpdate>
19 changes: 19 additions & 0 deletions ...t/examples/collaborative_editing/participant/add/PATCH/ParticipantListCreate.json.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
}
]
}
}
4 changes: 4 additions & 0 deletions .../input/examples/collaborative_editing/participant/add/PATCH/ParticipantUpdate.xml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<InternalParticipantUpdate>
<scope>view</scope>
</InternalParticipantUpdate>
112 changes: 112 additions & 0 deletions ...ce/input/examples/collaborative_editing/participant/add/POST/ParticipantList.json.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
}
]
}
}
91 changes: 91 additions & 0 deletions ...nce/input/examples/collaborative_editing/participant/add/POST/ParticipantList.xml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
19 changes: 19 additions & 0 deletions ...ut/examples/collaborative_editing/participant/add/POST/ParticipantListCreate.json.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
}
]
}
}
14 changes: 14 additions & 0 deletions ...put/examples/collaborative_editing/participant/add/POST/ParticipantListCreate.xml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
28 changes: 28 additions & 0 deletions ...ce/input/examples/collaborative_editing/participant/list/GET/ParticipantList.json.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"ParticipantList": {
"_media-type": "application/vnd.ibexa.api.ParticipantList+json",
"Participants": [
{
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
"id": 39,
"name": "Administrator User",
"scope": "edit",
"User": {
"_media-type": "application/vnd.ibexa.api.User+json",
"_href": "/api/ibexa/v2/user/users/14"
},
"createdAt": "2024-11-14T11:34:41+00:00",
"updatedAt": "2024-11-14T11:34:41+00:00"
},
{
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
"id": 40,
"name": "[email protected]",
"scope": "view",
"email": "[email protected]",
"createdAt": "2024-11-14T11:34:41+00:00",
"updatedAt": "2024-11-14T11:34:41+00:00"
}
]
}
}
19 changes: 19 additions & 0 deletions ...nce/input/examples/collaborative_editing/participant/list/GET/ParticipantList.xml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0"?>
<ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml">
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
<id>__FIXED_ID__</id>
<name>Anonymous User</name>
<scope>edit</scope>
<User href="/api/ibexa/v2/user/users/__FIXED_ID__" media-type="application/vnd.ibexa.api.User+xml"/>
<createdAt>__CREATED_AT__</createdAt>
<updatedAt>__UPDATED_AT__</updatedAt>
</Participant>
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
<id>__FIXED_ID__</id>
<name>[email protected]</name>
<scope>view</scope>
<email>[email protected]</email>
<createdAt>__CREATED_AT__</createdAt>
<updatedAt>__UPDATED_AT__</updatedAt>
</Participant>
</ParticipantList>
39 changes: 39 additions & 0 deletions ...erence/input/examples/collaborative_editing/session/GET/CollaborationSession.json.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"CollaborationSession": {
"_media-type": "application/vnd.ibexa.api.CollaborationSession+json",
"id": 17,
"token": "f637f415-688a-4655-a3c5-e209e2bd6771",
"createdAt": "2024-11-14T11:34:40+00:00",
"updatedAt": "2024-11-14T11:34:40+00:00",
"ParticipantList": {
"_media-type": "application/vnd.ibexa.api.ParticipantList+json",
"Participants": [
{
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
"id": 39,
"name": "Administrator User",
"scope": "edit",
"User": {
"_media-type": "application/vnd.ibexa.api.User+json",
"_href": "/api/ibexa/v2/user/users/14"
},
"createdAt": "2024-11-14T11:34:41+00:00",
"updatedAt": "2024-11-14T11:34:41+00:00"
},
{
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
"id": 40,
"name": "[email protected]",
"scope": "view",
"email": "[email protected]",
"createdAt": "2024-11-14T11:34:41+00:00",
"updatedAt": "2024-11-14T11:34:41+00:00"
}
]
},
"Owner": {
"_media-type": "application/vnd.ibexa.api.User+json",
"_href": "/api/ibexa/v2/user/users/14"
}
}
}
Loading
Loading