Skip to content

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

New issue

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

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

Already on GitHub? # to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
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": "user@link.invalid",
"scope": "view",
"email": "user@link.invalid",
"createdAt": "2024-11-14T14:09:47+00:00",
"updatedAt": "2024-11-15T13:13:22+00:00"
}
}
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>user@link.invalid</name>
<scope>edit</scope>
<email>user@link.invalid</email>
<createdAt>2024-11-14T14:09:47+00:00</createdAt>
<updatedAt>2024-11-15T12:50:03+00:00</updatedAt>
</Participant>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"InternalParticipantUpdate": {
"scope": "view"
}
}
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>
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": "user@link.invalid",
"scope": "view"
}
]
}
}
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>
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": "user@link.invalid",
"scope": "view",
"email": "user@link.invalid",
"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": "user@link.invalid",
"scope": "view",
"email": "user@link.invalid",
"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": "user@link.invalid",
"scope": "view",
"email": "user@link.invalid",
"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": "user@link.invalid",
"scope": "view",
"email": "user@link.invalid",
"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": "user@link.invalid",
"scope": "view",
"email": "user@link.invalid",
"createdAt": "2024-11-14T14:09:47+00:00",
"updatedAt": "2024-11-14T14:09:47+00:00"
}
]
}
}
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>user@link.invalid</name>
<scope>view</scope>
<email>user@link.invalid</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>user@link.invalid</name>
<scope>view</scope>
<email>user@link.invalid</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>user@link.invalid</name>
<scope>view</scope>
<email>user@link.invalid</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>user@link.invalid</name>
<scope>view</scope>
<email>user@link.invalid</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>user@link.invalid</name>
<scope>view</scope>
<email>user@link.invalid</email>
<createdAt>2024-11-15T11:55:38+00:00</createdAt>
<updatedAt>2024-11-15T11:55:38+00:00</updatedAt>
</Participant>
</ParticipantList>
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": "user@link.invalid",
"scope": "view"
}
]
}
}
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>user@link.invalid</email>
<scope>view</scope>
</ParticipantCreate>
</ParticipantListCreate>
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{
"ParticipantList": {
"_media-type": "application/vnd.ibexa.api.ParticipantList+json",
"Participants": [
{
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
"id": 37,
"name": "Editor0 User0",
"scope": "edit",
"User": {
"_media-type": "application/vnd.ibexa.api.User+json",
"_href": "/api/ibexa/v2/user/users/307"
},
"createdAt": "2025-04-02T08:17:16+00:00",
"updatedAt": "2025-04-02T08:17:16+00:00"
},
{
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
"id": 38,
"name": "Administrator User",
"scope": "view",
"User": {
"_media-type": "application/vnd.ibexa.api.User+json",
"_href": "/api/ibexa/v2/user/users/14"
},
"createdAt": "2025-04-02T08:59:45+00:00",
"updatedAt": "2025-04-02T08:59:45+00:00"
},
{
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
"id": 39,
"name": "user@link.invalid",
"scope": "view",
"email": "user@link.invalid",
"createdAt": "2025-04-02T08:59:45+00:00",
"updatedAt": "2025-04-02T08:59:45+00:00"
},
{
"_media-type": "application/vnd.ibexa.api.InternalParticipant+json",
"id": 41,
"name": "Administrator User",
"scope": "view",
"User": {
"_media-type": "application/vnd.ibexa.api.User+json",
"_href": "/api/ibexa/v2/user/users/14"
},
"createdAt": "2025-04-02T09:06:23+00:00",
"updatedAt": "2025-04-02T09:06:23+00:00"
},
{
"_media-type": "application/vnd.ibexa.api.ExternalParticipant+json",
"id": 42,
"name": "testuser@link.invalid",
"scope": "view",
"email": "testuser@link.invalid",
"createdAt": "2025-04-02T09:06:23+00:00",
"updatedAt": "2025-04-02T09:06:23+00:00"
}
]
}
}
Loading