Merge pull request #49015 from nextcloud/fix/openapi/array-syntax

Author: skjnldsv

apps/cloud_federation_api/lib/Capabilities.php

@@ -31,11 +31,11 @@ public function __construct(
 	 *         enabled: bool,
 	 *         apiVersion: string,
 	 *         endPoint: string,
-	 *         resourceTypes: array{
+	 *         resourceTypes: list<array{
 	 *             name: string,
-	 *             shareTypes: string[],
+	 *             shareTypes: list<string>,
 	 *             protocols: array<string, string>
-	 *           }[],
+	 *           }>,
 	 *       },
 	 * }
 	 * @throws OCMArgumentException

apps/cloud_federation_api/lib/Controller/RequestHandlerController.php

@@ -67,7 +67,7 @@ public function __construct(
 	 * @param string|null $ownerDisplayName Display name of the user who shared the item
 	 * @param string|null $sharedBy Provider specific UID of the user who shared the resource
 	 * @param string|null $sharedByDisplayName Display name of the user who shared the resource
-	 * @param array{name: string[], options: array<string, mixed>} $protocol e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]]
+	 * @param array{name: list<string>, options: array<string, mixed>} $protocol e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]]
 	 * @param string $shareType 'group' or 'user' share
 	 * @param string $resourceType 'file', 'calendar',...
 	 *

apps/cloud_federation_api/lib/ResponseDefinitions.php

@@ -20,10 +20,10 @@
  * }
  *
  * @psalm-type CloudFederationAPIValidationError = CloudFederationAPIError&array{
- *     validationErrors: array{
+ *     validationErrors: list<array{
  *          name: string,
  *          message: string|null,
- *     }[],
+ *     }>,
  * }
  */
 class ResponseDefinitions {

apps/dashboard/lib/Controller/DashboardApiController.php

@@ -74,8 +74,8 @@ static function (IWidget $widget) use ($widgetIds) {
 	 * @param array<string, string> $sinceIds Array indexed by widget Ids, contains date/id from which we want the new items
 	 * @param int $limit Limit number of result items per widget
 	 * @psalm-param int<1, 30> $limit
-	 * @param string[] $widgets Limit results to specific widgets
-	 * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItem[]>, array{}>
+	 * @param list<string> $widgets Limit results to specific widgets
+	 * @return DataResponse<Http::STATUS_OK, array<string, list<DashboardWidgetItem>>, array{}>
 	 *
 	 * 200: Widget items returned
 	 */
@@ -102,7 +102,7 @@ public function getWidgetItems(array $sinceIds = [], int $limit = 7, array $widg
 	 * @param array<string, string> $sinceIds Array indexed by widget Ids, contains date/id from which we want the new items
 	 * @param int $limit Limit number of result items per widget, not more than 30 are allowed
 	 * @psalm-param int<1, 30> $limit
-	 * @param string[] $widgets Limit results to specific widgets
+	 * @param list<string> $widgets Limit results to specific widgets
 	 * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItems>, array{}>
 	 *
 	 * 200: Widget items returned

apps/dashboard/lib/ResponseDefinitions.php

@@ -18,13 +18,13 @@
  *     icon_url: string,
  *     widget_url: ?string,
  *     item_icons_round: bool,
- *     item_api_versions: int[],
+ *     item_api_versions: list<int>,
  *     reload_interval: int,
- *     buttons?: array{
+ *     buttons?: list<array{
  *         type: string,
  *         text: string,
  *         link: string,
- *     }[],
+ *     }>,
  * }
  *
  * @psalm-type DashboardWidgetItem = array{
@@ -37,7 +37,7 @@
  * }
  *
  * @psalm-type DashboardWidgetItems = array{
- *     items: DashboardWidgetItem[],
+ *     items: list<DashboardWidgetItem>,
  *     emptyContentMessage: string,
  *     halfEmptyContentMessage: string,
  *  }

apps/dav/lib/Controller/UpcomingEventsController.php

@@ -35,7 +35,7 @@ public function __construct(
 	 * Get information about upcoming events
 	 *
 	 * @param string|null $location location/URL to filter by
-	 * @return DataResponse<Http::STATUS_OK, array{events: DAVUpcomingEvent[]}, array{}>|DataResponse<Http::STATUS_UNAUTHORIZED, null, array{}>
+	 * @return DataResponse<Http::STATUS_OK, array{events: list<DAVUpcomingEvent>}, array{}>|DataResponse<Http::STATUS_UNAUTHORIZED, null, array{}>
 	 *
 	 * 200: Upcoming events
 	 * 401: When not authenticated
@@ -47,10 +47,10 @@ public function getEvents(?string $location = null): DataResponse {
 		}
 
 		return new DataResponse([
-			'events' => array_map(fn (UpcomingEvent $e) => $e->jsonSerialize(), $this->service->getEvents(
+			'events' => array_values(array_map(fn (UpcomingEvent $e) => $e->jsonSerialize(), $this->service->getEvents(
 				$this->userId,
 				$location,
-			)),
+			))),
 		]);
 	}
 

apps/federatedfilesharing/lib/Controller/RequestHandlerController.php

@@ -72,7 +72,7 @@ public function __construct(
 	 * @param int|null $remoteId ID of the remote
 	 * @param string|null $sharedByFederatedId Federated ID of the sender
 	 * @param string|null $ownerFederatedId Federated ID of the receiver
-	 * @return Http\DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 * @return Http\DataResponse<Http::STATUS_OK, list<empty>, array{}>
 	 * @throws OCSException
 	 *
 	 * 200: Share created successfully
@@ -186,7 +186,7 @@ public function reShare(int $id, ?string $token = null, ?string $shareWith = nul
 	 *
 	 * @param int $id ID of the remote share
 	 * @param string|null $token Shared secret between servers
-	 * @return Http\DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 * @return Http\DataResponse<Http::STATUS_OK, list<empty>, array{}>
 	 * @throws OCSException
 	 * @throws ShareNotFound
 	 * @throws HintException
@@ -221,7 +221,7 @@ public function acceptShare(int $id, ?string $token = null) {
 	 *
 	 * @param int $id ID of the remote share
 	 * @param string|null $token Shared secret between servers
-	 * @return Http\DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 * @return Http\DataResponse<Http::STATUS_OK, list<empty>, array{}>
 	 * @throws OCSException
 	 *
 	 * 200: Share declined successfully
@@ -254,7 +254,7 @@ public function declineShare(int $id, ?string $token = null) {
 	 *
 	 * @param int $id ID of the share
 	 * @param string|null $token Shared secret between servers
-	 * @return Http\DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 * @return Http\DataResponse<Http::STATUS_OK, list<empty>, array{}>
 	 * @throws OCSException
 	 *
 	 * 200: Share unshared successfully
@@ -290,7 +290,7 @@ private function cleanupRemote($remote) {
 	 *
 	 * @param int $id ID of the share
 	 * @param string|null $token Shared secret between servers
-	 * @return Http\DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 * @return Http\DataResponse<Http::STATUS_OK, list<empty>, array{}>
 	 * @throws OCSBadRequestException Revoking the share is not possible
 	 *
 	 * 200: Share revoked successfully
@@ -332,7 +332,7 @@ private function isS2SEnabled($incoming = false) {
 	 * @param int $id ID of the share
 	 * @param string|null $token Shared secret between servers
 	 * @param int|null $permissions New permissions
-	 * @return Http\DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 * @return Http\DataResponse<Http::STATUS_OK, list<empty>, array{}>
 	 * @throws OCSBadRequestException Updating permissions is not possible
 	 *
 	 * 200: Permissions updated successfully

apps/federation/lib/Controller/OCSAuthAPIController.php

@@ -52,7 +52,7 @@ public function __construct(
 	 *
 	 * @param string $url URL of the server
 	 * @param string $token Token of the server
-	 * @return DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
 	 * @throws OCSForbiddenException Requesting shared secret is not allowed
 	 *
 	 * 200: Shared secret requested successfully
@@ -87,7 +87,7 @@ public function getSharedSecretLegacy(string $url, string $token): DataResponse
 	 *
 	 * @param string $url URL of the server
 	 * @param string $token Token of the server
-	 * @return DataResponse<Http::STATUS_OK, array<empty>, array{}>
+	 * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
 	 * @throws OCSForbiddenException Requesting shared secret is not allowed
 	 *
 	 * 200: Shared secret requested successfully

apps/files/lib/Capabilities.php

@@ -21,7 +21,7 @@ public function __construct(
 	/**
 	 * Return this classes capabilities
 	 *
-	 * @return array{files: array{'$comment': ?string, bigfilechunking: bool, blacklisted_files: array<mixed>, forbidden_filenames: list<string>, forbidden_filename_basenames: list<string>, forbidden_filename_characters: list<string>, forbidden_filename_extensions: list<string>, chunked_upload: array{max_size: int, max_parallel_count: int}}}
+	 * @return array{files: array{'$comment': ?string, bigfilechunking: bool, blacklisted_files: list<mixed>, forbidden_filenames: list<string>, forbidden_filename_basenames: list<string>, forbidden_filename_characters: list<string>, forbidden_filename_extensions: list<string>, chunked_upload: array{max_size: int, max_parallel_count: int}}}
 	 */
 	public function getCapabilities(): array {
 		return [

apps/files/lib/Controller/DirectEditingController.php

@@ -36,7 +36,7 @@ public function __construct(
 
 	/**
 	 * Get the direct editing capabilities
-	 * @return DataResponse<Http::STATUS_OK, array{editors: array<string, array{id: string, name: string, mimetypes: string[], optionalMimetypes: string[], secure: bool}>, creators: array<string, array{id: string, editor: string, name: string, extension: string, templates: bool, mimetypes: string[]}>}, array{}>
+	 * @return DataResponse<Http::STATUS_OK, array{editors: array<string, array{id: string, name: string, mimetypes: list<string>, optionalMimetypes: list<string>, secure: bool}>, creators: array<string, array{id: string, editor: string, name: string, extension: string, templates: bool, mimetypes: list<string>}>}, array{}>
 	 *
 	 * 200: Direct editing capabilities returned
 	 */