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

docs(federation): Add a hint which capabilities should be used in fed… #11897

Merged
merged 1 commit into from
Mar 22, 2024
Merged

docs(federation): Add a hint which capabilities should be used in fed… #11897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions docs/conversation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,9 @@ Get all (for moderators and in case of "free selection") or the assigned breakou

## Get conversation capabilities

See [Capability handling in federated conversations](https://github.com/nextcloud/spreed/issues/10680) to learn which capabilities
should be considered from the local server or from the remote server.

* Required capability: `federation-v1`
* Method: `GET`
* Endpoint: `/room/{token}/capabilities`
Expand Down
3 changes: 3 additions & 0 deletions lib/Controller/RoomController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2239,6 +2239,9 @@ public function setMessageExpiration(int $seconds): DataResponse {
/**
* Get capabilities for a room
*
* See "Capability handling in federated conversations" in https://github.com/nextcloud/spreed/issues/10680
* to learn which capabilities should be considered from the local server or from the remote server.
*
* @return DataResponse<Http::STATUS_OK, TalkCapabilities|array<empty>, array{X-Nextcloud-Talk-Hash?: string, X-Nextcloud-Talk-Proxy-Hash?: string}>
*
* 200: Get capabilities successfully
Expand Down
1 change: 1 addition & 0 deletions openapi-full.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15300,6 +15300,7 @@
"get": {
"operationId": "room-get-capabilities",
"summary": "Get capabilities for a room",
"description": "See \"Capability handling in federated conversations\" in https://github.com/nextcloud/spreed/issues/10680 to learn which capabilities should be considered from the local server or from the remote server.",
"tags": [
"room"
],
Expand Down
1 change: 1 addition & 0 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15410,6 +15410,7 @@
"get": {
"operationId": "room-get-capabilities",
"summary": "Get capabilities for a room",
"description": "See \"Capability handling in federated conversations\" in https://github.com/nextcloud/spreed/issues/10680 to learn which capabilities should be considered from the local server or from the remote server.",
"tags": [
"room"
],
Expand Down
10 changes: 8 additions & 2 deletions src/types/openapi/openapi-full.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,10 @@ export type paths = {
post: operations["room-set-message-expiration"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/capabilities": {
/** Get capabilities for a room */
/**
* Get capabilities for a room
* @description See "Capability handling in federated conversations" in https://github.com/nextcloud/spreed/issues/10680 to learn which capabilities should be considered from the local server or from the remote server.
*/
get: operations["room-get-capabilities"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/settings/user": {
Expand Down Expand Up @@ -5243,7 +5246,10 @@ export type operations = {
};
};
};
/** Get capabilities for a room */
/**
* Get capabilities for a room
* @description See "Capability handling in federated conversations" in https://github.com/nextcloud/spreed/issues/10680 to learn which capabilities should be considered from the local server or from the remote server.
*/
"room-get-capabilities": {
parameters: {
header: {
Expand Down
10 changes: 8 additions & 2 deletions src/types/openapi/openapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,10 @@ export type paths = {
post: operations["room-set-message-expiration"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/capabilities": {
/** Get capabilities for a room */
/**
* Get capabilities for a room
* @description See "Capability handling in federated conversations" in https://github.com/nextcloud/spreed/issues/10680 to learn which capabilities should be considered from the local server or from the remote server.
*/
get: operations["room-get-capabilities"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/settings/user": {
Expand Down Expand Up @@ -5144,7 +5147,10 @@ export type operations = {
};
};
};
/** Get capabilities for a room */
/**
* Get capabilities for a room
* @description See "Capability handling in federated conversations" in https://github.com/nextcloud/spreed/issues/10680 to learn which capabilities should be considered from the local server or from the remote server.
*/
"room-get-capabilities": {
parameters: {
header: {
Expand Down
Loading