Skip to content

Commit b72713f

Browse files
julitafalconduszamnoconjuskoraciastektk
authored
IBX-9006: Collaborative editing - REST API documentation (#2528)
* IBX-9006: Collaborative editing - REST API documentation * Updated doc * Apply suggestions from code review Co-authored-by: Tomasz Kryszan <[email protected]> * Added REST fixes * Fixes after review * Updated endpoints * IBX-9006: Collaborative editing - REST API documentation * Updated doc * Apply suggestions from code review Co-authored-by: Tomasz Kryszan <[email protected]> * Added REST fixes * Fixes after review * Updated endpoints * Fixes after review * Fixes * Added raml file * Apply suggestions from code review Co-authored-by: Tomasz Kryszan <[email protected]> * Changes * Delete docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/GET/Session.json.example * Delete docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/session/GET/Session.xml.example --------- Co-authored-by: Marek Nocoń <[email protected]> Co-authored-by: juskora <[email protected]> Co-authored-by: Justyna Koralewicz <[email protected]> Co-authored-by: Tomasz Kryszan <[email protected]>
1 parent 4930ad3 commit b72713f

30 files changed

+6262
-2
lines changed

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.json.example‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"Participant": {
3+
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
4+
"id": "46",
5+
"scope": "view",
6+
"name": "Editor",
7+
"User": {
8+
"_media-type": "application/vnd.ibexa.api.User+json",
9+
"_href": "/api/ibexa/v2/user/users/70"
10+
},
11+
"createdAt": "2024-11-14T14:09:47+00:00",
12+
"updatedAt": "2024-11-15T13:13:22+00:00"
13+
}
14+
}

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.xml.example‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?xml version="1.0"?>
2+
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
3+
<id>46</id>
4+
<name>Editor</name>
5+
<scope>view</scope>
6+
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/70"/>
7+
<createdAt>2024-11-14T14:09:47+00:00</createdAt>
8+
<updatedAt>2024-11-15T12:50:03+00:00</updatedAt>
9+
</Participant>

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/InternalParticipantUpdate.json.example‎

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

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/InternalParticipantUpdate.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+
<InternalParticipantUpdate>
3+
<scope>edit</scope>
4+
</InternalParticipantUpdate>

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/ParticipantListCreate.json.example‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"ParticipantListCreate": {
3+
"ParticipantCreate": [
4+
{
5+
"_media-type": "application\/vnd.ibexa.api.InternalParticipantCreate+json",
6+
"User": {
7+
"_media-type": "application/vnd.ibexa.api.User+json",
8+
"_href": "/api/ibexa/v2/user/users/14"
9+
},
10+
"scope": "view"
11+
},
12+
{
13+
"_media-type": "application\/vnd.ibexa.api.ExternalParticipantCreate+json",
14+
"email": "[email protected]",
15+
"scope": "view"
16+
}
17+
]
18+
}
19+
}

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/PATCH/ParticipantUpdate.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+
<InternalParticipantUpdate>
3+
<scope>view</scope>
4+
</InternalParticipantUpdate>

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/POST/ParticipantList.json.example‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
{
2+
"ParticipantList": {
3+
"_media-type": "application/vnd.ibexa.api.ParticipantList+json",
4+
"Participants": [
5+
{
6+
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
7+
"id": 11,
8+
"name": "Administrator User",
9+
"scope": "edit",
10+
"User": {
11+
"_media-type": "application/vnd.ibexa.api.User+json",
12+
"_href": "/api/ibexa/v2/user/users/14"
13+
},
14+
"createdAt": "2024-11-13T11:01:24+00:00",
15+
"updatedAt": "2024-11-13T11:01:24+00:00"
16+
},
17+
{
18+
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
19+
"id": 12,
20+
"name": "[email protected]",
21+
"scope": "view",
22+
"email": "[email protected]",
23+
"createdAt": "2024-11-13T11:01:24+00:00",
24+
"updatedAt": "2024-11-13T11:01:24+00:00"
25+
},
26+
{
27+
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
28+
"id": 13,
29+
"name": "Administrator User",
30+
"scope": "view",
31+
"User": {
32+
"_media-type": "application/vnd.ibexa.api.User+json",
33+
"_href": "/api/ibexa/v2/user/users/14"
34+
},
35+
"createdAt": "2024-11-13T11:02:22+00:00",
36+
"updatedAt": "2024-11-13T11:02:22+00:00"
37+
},
38+
{
39+
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
40+
"id": 14,
41+
"name": "[email protected]",
42+
"scope": "view",
43+
"email": "[email protected]",
44+
"createdAt": "2024-11-13T11:02:22+00:00",
45+
"updatedAt": "2024-11-13T11:02:22+00:00"
46+
},
47+
{
48+
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
49+
"id": 15,
50+
"name": "Administrator User",
51+
"scope": "view",
52+
"User": {
53+
"_media-type": "application/vnd.ibexa.api.User+json",
54+
"_href": "/api/ibexa/v2/user/users/14"
55+
},
56+
"createdAt": "2024-11-13T11:10:29+00:00",
57+
"updatedAt": "2024-11-13T11:10:29+00:00"
58+
},
59+
{
60+
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
61+
"id": 16,
62+
"name": "[email protected]",
63+
"scope": "view",
64+
"email": "[email protected]",
65+
"createdAt": "2024-11-13T11:10:29+00:00",
66+
"updatedAt": "2024-11-13T11:10:29+00:00"
67+
},
68+
{
69+
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
70+
"id": 17,
71+
"name": "Administrator User",
72+
"scope": "view",
73+
"User": {
74+
"_media-type": "application/vnd.ibexa.api.User+json",
75+
"_href": "/api/ibexa/v2/user/users/14"
76+
},
77+
"createdAt": "2024-11-13T11:43:20+00:00",
78+
"updatedAt": "2024-11-13T11:43:20+00:00"
79+
},
80+
{
81+
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
82+
"id": 18,
83+
"name": "[email protected]",
84+
"scope": "view",
85+
"email": "[email protected]",
86+
"createdAt": "2024-11-13T11:43:20+00:00",
87+
"updatedAt": "2024-11-13T11:43:20+00:00"
88+
},
89+
{
90+
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
91+
"id": 45,
92+
"name": "Administrator User",
93+
"scope": "view",
94+
"User": {
95+
"_media-type": "application/vnd.ibexa.api.User+json",
96+
"_href": "/api/ibexa/v2/user/users/14"
97+
},
98+
"createdAt": "2024-11-14T14:09:47+00:00",
99+
"updatedAt": "2024-11-14T14:09:47+00:00"
100+
},
101+
{
102+
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
103+
"id": 46,
104+
"name": "[email protected]",
105+
"scope": "view",
106+
"email": "[email protected]",
107+
"createdAt": "2024-11-14T14:09:47+00:00",
108+
"updatedAt": "2024-11-14T14:09:47+00:00"
109+
}
110+
]
111+
}
112+
}

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/POST/ParticipantList.xml.example‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ParticipantList media-type="application/vnd.ibexa.api.ParticipantList+xml">
3+
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
4+
<id>11</id>
5+
<name>Administrator User</name>
6+
<scope>edit</scope>
7+
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
8+
<createdAt>2024-11-13T11:01:24+00:00</createdAt>
9+
<updatedAt>2024-11-13T11:01:24+00:00</updatedAt>
10+
</Participant>
11+
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
12+
<id>13</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>2024-11-13T11:02:22+00:00</createdAt>
17+
<updatedAt>2024-11-13T11:02:22+00:00</updatedAt>
18+
</Participant>
19+
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
20+
<id>14</id>
21+
<name>[email protected]</name>
22+
<scope>view</scope>
23+
<email>[email protected]</email>
24+
<createdAt>2024-11-13T11:02:22+00:00</createdAt>
25+
<updatedAt>2024-11-13T11:02:22+00:00</updatedAt>
26+
</Participant>
27+
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
28+
<id>15</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>2024-11-13T11:10:29+00:00</createdAt>
33+
<updatedAt>2024-11-13T11:10:29+00:00</updatedAt>
34+
</Participant>
35+
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
36+
<id>16</id>
37+
<name>[email protected]</name>
38+
<scope>view</scope>
39+
<email>[email protected]</email>
40+
<createdAt>2024-11-13T11:10:29+00:00</createdAt>
41+
<updatedAt>2024-11-13T11:10:29+00:00</updatedAt>
42+
</Participant>
43+
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
44+
<id>17</id>
45+
<name>Administrator User</name>
46+
<scope>view</scope>
47+
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
48+
<createdAt>2024-11-13T11:43:20+00:00</createdAt>
49+
<updatedAt>2024-11-13T11:43:20+00:00</updatedAt>
50+
</Participant>
51+
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
52+
<id>18</id>
53+
<name>[email protected]</name>
54+
<scope>view</scope>
55+
<email>[email protected]</email>
56+
<createdAt>2024-11-13T11:43:20+00:00</createdAt>
57+
<updatedAt>2024-11-13T11:43:20+00:00</updatedAt>
58+
</Participant>
59+
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
60+
<id>45</id>
61+
<name>Administrator User</name>
62+
<scope>view</scope>
63+
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
64+
<createdAt>2024-11-14T14:09:47+00:00</createdAt>
65+
<updatedAt>2024-11-14T14:09:47+00:00</updatedAt>
66+
</Participant>
67+
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
68+
<id>46</id>
69+
<name>[email protected]</name>
70+
<scope>view</scope>
71+
<email>[email protected]</email>
72+
<createdAt>2024-11-14T14:09:47+00:00</createdAt>
73+
<updatedAt>2024-11-14T14:09:47+00:00</updatedAt>
74+
</Participant>
75+
<Participant media-type="application/vnd.ibexa.api.InternalParticipant+xml">
76+
<id>49</id>
77+
<name>Administrator User</name>
78+
<scope>view</scope>
79+
<User media-type="application/vnd.ibexa.api.User+xml" href="/api/ibexa/v2/user/users/14"/>
80+
<createdAt>2024-11-15T11:55:38+00:00</createdAt>
81+
<updatedAt>2024-11-15T11:55:38+00:00</updatedAt>
82+
</Participant>
83+
<Participant media-type="application/vnd.ibexa.api.ExternalParticipant+xml">
84+
<id>50</id>
85+
<name>[email protected]</name>
86+
<scope>view</scope>
87+
<email>[email protected]</email>
88+
<createdAt>2024-11-15T11:55:38+00:00</createdAt>
89+
<updatedAt>2024-11-15T11:55:38+00:00</updatedAt>
90+
</Participant>
91+
</ParticipantList>

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/POST/ParticipantListCreate.json.example‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"ParticipantListCreate": {
3+
"ParticipantCreate": [
4+
{
5+
"_media-type": "application\/vnd.ibexa.api.InternalParticipantCreate+json",
6+
"User": {
7+
"_media-type": "application/vnd.ibexa.api.User+json",
8+
"_href": "/api/ibexa/v2/user/users/14"
9+
},
10+
"scope": "view"
11+
},
12+
{
13+
"_media-type": "application\/vnd.ibexa.api.ExternalParticipantCreate+json",
14+
"email": "[email protected]",
15+
"scope": "view"
16+
}
17+
]
18+
}
19+
}

‎docs/api/rest_api/rest_api_reference/input/examples/collaborative_editing/participant/add/POST/ParticipantListCreate.xml.example‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ParticipantListCreate>
3+
<ParticipantCreate media-type="application/vnd.ibexa.api.InternalParticipantCreate+xml">
4+
<scope>view</scope>
5+
<User media-type="application/vnd.ibexa.api.User+xml"
6+
href="/api/ibexa/v2/user/users/14"
7+
>
8+
</User>
9+
</ParticipantCreate>
10+
<ParticipantCreate media-type="application/vnd.ibexa.api.ExternalParticipantCreate+xml">
11+
<email>[email protected]</email>
12+
<scope>view</scope>
13+
</ParticipantCreate>
14+
</ParticipantListCreate>

0 commit comments

Comments
 (0)