-
Notifications
You must be signed in to change notification settings - Fork 82
IBX-9006: Collaborative editing - REST API documentation #2528
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.
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
5365eef
IBX-9006: Collaborative editing - REST API documentation
mnocon 3f1f5b2
Updated doc
juskora 6379546
Apply suggestions from code review
juskora b893de7
Added REST fixes
mnocon 0831b91
Fixes after review
juskora 8f2dc20
Updated endpoints
juskora e560af8
IBX-9006: Collaborative editing - REST API documentation
mnocon fdef4a7
Updated doc
juskora a985acd
Apply suggestions from code review
juskora 9e3c21e
Added REST fixes
mnocon 0047c84
Fixes after review
juskora 4b9d881
Updated endpoints
juskora 0830bd3
Fixes after review
juskora 24f8d63
Fixes
juskora ac73883
Fixes
juskora 4c60378
Added raml file
juskora 3a9b19c
Apply suggestions from code review
juskora a648d17
Changes
juskora 6b82ade
Delete docs/api/rest_api/rest_api_reference/input/examples/collaborat…
juskora 01d86f3
Delete docs/api/rest_api/rest_api_reference/input/examples/collaborat…
juskora File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
11 changes: 11 additions & 0 deletions
11
...put/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.json.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
9
...nput/examples/collaborative_editing/participant/add/PATCH/InternalParticipant.xml.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> | ||
juskora marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
5 changes: 5 additions & 0 deletions
5
...amples/collaborative_editing/participant/add/PATCH/InternalParticipantUpdate.json.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "InternalParticipantUpdate": { | ||
| "scope": "view" | ||
| } | ||
| } |
4 changes: 4 additions & 0 deletions
4
...xamples/collaborative_editing/participant/add/PATCH/InternalParticipantUpdate.xml.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
19
...t/examples/collaborative_editing/participant/add/PATCH/ParticipantListCreate.json.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
4
.../input/examples/collaborative_editing/participant/add/PATCH/ParticipantUpdate.xml.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
112
...ce/input/examples/collaborative_editing/participant/add/POST/ParticipantList.json.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
91
...nce/input/examples/collaborative_editing/participant/add/POST/ParticipantList.xml.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
19
...ut/examples/collaborative_editing/participant/add/POST/ParticipantListCreate.json.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
14
...put/examples/collaborative_editing/participant/add/POST/ParticipantListCreate.xml.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> |
61 changes: 61 additions & 0 deletions
61
...ce/input/examples/collaborative_editing/participant/list/GET/ParticipantList.json.example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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": "[email protected]", | ||
| "scope": "view", | ||
| "email": "[email protected]", | ||
| "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": "[email protected]", | ||
| "scope": "view", | ||
| "email": "[email protected]", | ||
| "createdAt": "2025-04-02T09:06:23+00:00", | ||
| "updatedAt": "2025-04-02T09:06:23+00:00" | ||
| } | ||
| ] | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.