Merge pull request #14010 from nextcloud/chore/deps/openapi-extractor

chore(deps): Update openapi-extractor to v1.3.0
nextcloud · Dec 20, 2024 · 9037aa7 · 9037aa7
2 parents 058e12c + eda7e49
commit 9037aa7
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 54 deletions.
diff --git a/appinfo/routes/routesBotController.php b/appinfo/routes/routesBotController.php
@@ -8,6 +8,10 @@
 
 $requirements = [
 	'apiVersion' => '(v1)',
+];
+
+$requirementsWithToken = [
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 
@@ -26,15 +30,15 @@
 return [
 	'ocs' => [
 		/** @see \OCA\Talk\Controller\BotController::sendMessage() */
-		['name' => 'Bot#sendMessage', 'url' => '/api/{apiVersion}/bot/{token}/message', 'verb' => 'POST', 'requirements' => $requirements],
+		['name' => 'Bot#sendMessage', 'url' => '/api/{apiVersion}/bot/{token}/message', 'verb' => 'POST', 'requirements' => $requirementsWithToken],
 		/** @see \OCA\Talk\Controller\BotController::react() */
 		['name' => 'Bot#react', 'url' => '/api/{apiVersion}/bot/{token}/reaction/{messageId}', 'verb' => 'POST', 'requirements' => $requirementsWithMessageId],
 		/** @see \OCA\Talk\Controller\BotController::deleteReaction() */
 		['name' => 'Bot#deleteReaction', 'url' => '/api/{apiVersion}/bot/{token}/reaction/{messageId}', 'verb' => 'DELETE', 'requirements' => $requirementsWithMessageId],
 		/** @see \OCA\Talk\Controller\BotController::adminListBots() */
 		['name' => 'Bot#adminListBots', 'url' => '/api/{apiVersion}/bot/admin', 'verb' => 'GET', 'requirements' => $requirements],
 		/** @see \OCA\Talk\Controller\BotController::listBots() */
-		['name' => 'Bot#listBots', 'url' => '/api/{apiVersion}/bot/{token}', 'verb' => 'GET', 'requirements' => $requirements],
+		['name' => 'Bot#listBots', 'url' => '/api/{apiVersion}/bot/{token}', 'verb' => 'GET', 'requirements' => $requirementsWithToken],
 		/** @see \OCA\Talk\Controller\BotController::enableBot() */
 		['name' => 'Bot#enableBot', 'url' => '/api/{apiVersion}/bot/{token}/{botId}', 'verb' => 'POST', 'requirements' => $requirementsWithBotId],
 		/** @see \OCA\Talk\Controller\BotController::disableBot() */

diff --git a/appinfo/routes/routesRecordingController.php b/appinfo/routes/routesRecordingController.php
@@ -8,6 +8,10 @@
 
 $requirements = [
 	'apiVersion' => '(v1)',
+];
+
+$requirementsWithToken = [
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 
@@ -20,14 +24,14 @@
 		/** @see \OCA\Talk\Controller\RecordingController::backend() */
 		['name' => 'Recording#backend', 'url' => '/api/{apiVersion}/recording/backend', 'verb' => 'POST', 'requirements' => $requirements],
 		/** @see \OCA\Talk\Controller\RecordingController::start() */
-		['name' => 'Recording#start', 'url' => '/api/{apiVersion}/recording/{token}', 'verb' => 'POST', 'requirements' => $requirements],
+		['name' => 'Recording#start', 'url' => '/api/{apiVersion}/recording/{token}', 'verb' => 'POST', 'requirements' => $requirementsWithToken],
 		/** @see \OCA\Talk\Controller\RecordingController::stop() */
-		['name' => 'Recording#stop', 'url' => '/api/{apiVersion}/recording/{token}', 'verb' => 'DELETE', 'requirements' => $requirements],
+		['name' => 'Recording#stop', 'url' => '/api/{apiVersion}/recording/{token}', 'verb' => 'DELETE', 'requirements' => $requirementsWithToken],
 		/** @see \OCA\Talk\Controller\RecordingController::store() */
-		['name' => 'Recording#store', 'url' => '/api/{apiVersion}/recording/{token}/store', 'verb' => 'POST', 'requirements' => $requirements],
+		['name' => 'Recording#store', 'url' => '/api/{apiVersion}/recording/{token}/store', 'verb' => 'POST', 'requirements' => $requirementsWithToken],
 		/** @see \OCA\Talk\Controller\RecordingController::notificationDismiss() */
-		['name' => 'Recording#notificationDismiss', 'url' => '/api/{apiVersion}/recording/{token}/notification', 'verb' => 'DELETE', 'requirements' => $requirements],
+		['name' => 'Recording#notificationDismiss', 'url' => '/api/{apiVersion}/recording/{token}/notification', 'verb' => 'DELETE', 'requirements' => $requirementsWithToken],
 		/** @see \OCA\Talk\Controller\RecordingController::shareToChat() */
-		['name' => 'Recording#shareToChat', 'url' => '/api/{apiVersion}/recording/{token}/share-chat', 'verb' => 'POST', 'requirements' => $requirements],
+		['name' => 'Recording#shareToChat', 'url' => '/api/{apiVersion}/recording/{token}/share-chat', 'verb' => 'POST', 'requirements' => $requirementsWithToken],
 	],
 ];
diff --git a/lib/Model/BotServer.php b/lib/Model/BotServer.php
@@ -8,7 +8,6 @@
 
 namespace OCA\Talk\Model;
 
-use OCA\Talk\ResponseDefinitions;
 use OCP\AppFramework\Db\Entity;
 use OCP\DB\Types;
 
@@ -33,8 +32,6 @@
  * @method int getState()
  * @method void setFeatures(int $features)
  * @method int getFeatures()
- *
- * @psalm-import-type TalkBotWithDetailsAndSecret from ResponseDefinitions
  */
 class BotServer extends Entity implements \JsonSerializable {
 	protected string $name = '';
@@ -62,7 +59,19 @@ public function __construct() {
 	}
 
 	/**
-	 * @return TalkBotWithDetailsAndSecret
+	 * @return array{
+	 *     id: int,
+	 *     name: string,
+	 *     url: string,
+	 *     url_hash: string,
+	 *     description: ?string,
+	 *     secret: string,
+	 *     error_count: int,
+	 *     last_error_date: int,
+	 *     last_error_message: string,
+	 *     state: int,
+	 *     features: int,
+	 * }
 	 */
 	public function jsonSerialize(): array {
 		return [

diff --git a/lib/ResponseDefinitions.php b/lib/ResponseDefinitions.php
@@ -40,10 +40,6 @@
  *     url_hash: string,
  * }
  *
- * @psalm-type TalkBotWithDetailsAndSecret = TalkBotWithDetails&array{
- *     secret: string,
- * }
- *
  * @psalm-type TalkCallPeer = array{
  *     actorId: string,
  *     actorType: string,

diff --git a/openapi-full.json b/openapi-full.json
@@ -189,24 +189,6 @@
                     }
                 ]
             },
-            "BotWithDetailsAndSecret": {
-                "allOf": [
-                    {
-                        "$ref": "#/components/schemas/BotWithDetails"
-                    },
-                    {
-                        "type": "object",
-                        "required": [
-                            "secret"
-                        ],
-                        "properties": {
-                            "secret": {
-                                "type": "string"
-                            }
-                        }
-                    }
-                ]
-            },
             "CallPeer": {
                 "type": "object",
                 "required": [

diff --git a/src/types/openapi/openapi-full.ts b/src/types/openapi/openapi-full.ts
@@ -1962,9 +1962,6 @@ export type components = {
             url: string;
             url_hash: string;
         };
-        BotWithDetailsAndSecret: components["schemas"]["BotWithDetails"] & {
-            secret: string;
-        };
         CallPeer: {
             actorId: string;
             actorType: string;

diff --git a/vendor-bin/openapi-extractor/composer.lock b/vendor-bin/openapi-extractor/composer.lock