Merge pull request #10186 from nextcloud/feature/openapi

Add OpenAPI

.github/workflows/openapi.yml

@@ -0,0 +1,52 @@
+name: OpenAPI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - stable*
+
+permissions:
+  contents: read
+
+concurrency:
+  group: openapi-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  openapi:
+    runs-on: ubuntu-latest
+
+    if: ${{ github.repository_owner != 'nextcloud-gmbh' }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
+
+      - name: Set up php
+        uses: shivammathur/setup-php@c5fc0d8281aba02c7fda07d3a70cc5371548067d # v2
+        with:
+          php-version: '8.2'
+          extensions: xml
+          coverage: none
+          ini-file: development
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up dependencies
+        run: composer i
+
+      - name: Regenerate OpenAPI
+        run: composer run openapi
+
+      - name: Check openapi.json changes
+        run: |
+          bash -c "[[ ! \"`git status --porcelain `\" ]] || (echo 'Please run \"composer run openapi\" and commit the openapi.json, see the section \"Show changes on failure\" for details' && exit 1)"
+
+      - name: Show changes on failure
+        if: failure()
+        run: |
+          git status
+          git --no-pager diff
+          exit 1 # make it red to grab attention

appinfo/routes/routesAvatarController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '^[a-z0-9]{4,30}$',
 ];
 

appinfo/routes/routesBotController.php

@@ -24,18 +24,18 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 
 $requirementsWithMessageId = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 	'messageId' => '[0-9]+',
 ];
 
 $requirementsWithBotId = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 	'botId' => '[0-9]+',
 ];

appinfo/routes/routesBreakoutRoomController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 

appinfo/routes/routesCallController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v4',
+	'apiVersion' => '(v4)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 

appinfo/routes/routesCertificateController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 ];
 
 return [

appinfo/routes/routesChatController.php

@@ -24,12 +24,12 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 
 $requirementsWithMessageId = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 	'messageId' => '[0-9]+',
 ];

appinfo/routes/routesCommandController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 ];
 
 return [

appinfo/routes/routesFederationController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 ];
 
 return [

appinfo/routes/routesFilesIntegrationController.php

@@ -24,11 +24,11 @@
  */
 
 $requirementsFile = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'fileId' => '.+',
 ];
 $requirementsShare = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'shareToken' => '.+',
 ];
 

appinfo/routes/routesGuestController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 

appinfo/routes/routesHostedSignalingServerController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 ];
 
 return [

appinfo/routes/routesMatterbridgeController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 

appinfo/routes/routesMatterbridgeSettingsController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 ];
 
 return [

appinfo/routes/routesPollController.php

@@ -24,12 +24,12 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 
 $requirementsWithPollId = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 	'pollId' => '\d+',
 ];

appinfo/routes/routesPublicShareAuthController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 ];
 
 return [

appinfo/routes/routesReactionController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 	'messageId' => '[0-9]+',
 ];

appinfo/routes/routesRecordingController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 

appinfo/routes/routesRoomController.php

@@ -24,11 +24,11 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v4',
+	'apiVersion' => '(v4)',
 ];
 
 $requirementsWithToken = [
-	'apiVersion' => 'v4',
+	'apiVersion' => '(v4)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 

appinfo/routes/routesSettingsController.php

@@ -24,7 +24,7 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v1',
+	'apiVersion' => '(v1)',
 ];
 
 return [

appinfo/routes/routesSignalingController.php

@@ -24,12 +24,12 @@
  */
 
 $requirements = [
-	'apiVersion' => 'v3',
+	'apiVersion' => '(v3)',
 ];
 
 
 $requirementsWithToken = [
-	'apiVersion' => 'v3',
+	'apiVersion' => '(v3)',
 	'token' => '[a-z0-9]{4,30}',
 ];
 

composer.json

@@ -19,6 +19,7 @@
 		"cs:check": "php-cs-fixer fix --dry-run --diff",
 		"cs:fix": "php-cs-fixer fix",
 		"lint": "find . -name \\*.php -not -path './vendor/*' -not -path './vendor-bin/*' -not -path './lib/Vendor/*' -not -path './build/*' -not -path './tests/integration/vendor/*' -print0 | xargs -0 -n1 php -l",
+		"openapi": "generate-spec",
 		"psalm": "psalm --threads=1",
 		"psalm:dev": "psalm --no-cache --threads=$(nproc)",
 		"psalm:update-baseline": "psalm --threads=1 --update-baseline --set-baseline=tests/psalm-baseline.xml",

lib/Chat/ReactionManager.php

@@ -29,12 +29,17 @@
 use OCA\Talk\Exceptions\ReactionNotSupportedException;
 use OCA\Talk\Exceptions\ReactionOutOfContextException;
 use OCA\Talk\Participant;
+use OCA\Talk\ResponseDefinitions;
 use OCA\Talk\Room;
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\Comments\IComment;
 use OCP\Comments\NotFoundException;
 use OCP\IL10N;
+use OCP\PreConditionNotMetException;
 
+/**
+ * @psalm-import-type TalkReaction from ResponseDefinitions
+ */
 class ReactionManager {
 
 	public function __construct(
@@ -138,6 +143,10 @@ public function deleteReactionMessage(Room $chat, string $actorType, string $act
 		return $comment;
 	}
 
+	/**
+	 * @return array<string, TalkReaction[]>
+	 * @throws PreConditionNotMetException
+	 */
 	public function retrieveReactionMessages(Room $chat, Participant $participant, int $messageId, ?string $reaction = null): array {
 		if ($reaction) {
 			$comments = $this->commentsManager->retrieveAllReactionsWithSpecificReaction($messageId, $reaction);