Merge pull request #11897 from nextcloud/docs/10680/capabilities-in-f…

…ederation-cases docs(federation): Add a hint which capabilities should be used in fed…
nextcloud · Mar 22, 2024 · 5a28d95 · 5a28d95
2 parents 722e177 + 99fb9ee
commit 5a28d95
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 4 deletions.
diff --git a/docs/conversation.md b/docs/conversation.md
@@ -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`

diff --git a/lib/Controller/RoomController.php b/lib/Controller/RoomController.php
@@ -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

diff --git a/openapi-full.json b/openapi-full.json
@@ -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"
                 ],

diff --git a/openapi.json b/openapi.json
@@ -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"
                 ],

diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts
@@ -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": {
@@ -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: {

diff --git a/src/types/openapi/openapi.ts b/src/types/openapi/openapi.ts
@@ -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": {
@@ -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: {