feat(Api): add v2 OCS Api to get table/view rows

- also changes Api Route definition to attribute Signed-off-by: Arthur Schiwon <[email protected]>
nextcloud · Jan 28, 2025 · 7cf874a · 7cf874a
1 parent 2505f3d
commit 7cf874a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/appinfo/routes.php b/appinfo/routes.php
@@ -153,7 +153,5 @@
 		['name' => 'Context#destroy', 'url' => '/api/2/contexts/{contextId}', 'verb' => 'DELETE'],
 		['name' => 'Context#transfer', 'url' => '/api/2/contexts/{contextId}/transfer', 'verb' => 'PUT'],
 		['name' => 'Context#updateContentOrder', 'url' => '/api/2/contexts/{contextId}/pages/{pageId}', 'verb' => 'PUT'],
-
-		['name' => 'RowOCS#createRow',	'url' => '/api/2/{nodeCollection}/{nodeId}/rows', 'verb' => 'POST', 'requirements' => ['nodeCollection' => '(tables|views)', 'nodeId' => '(\d+)']],
 	]
 ];
diff --git a/lib/Controller/RowOCSController.php b/lib/Controller/RowOCSController.php
@@ -18,6 +18,7 @@
 use OCA\Tables\ResponseDefinitions;
 use OCA\Tables\Service\RowService;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\ApiRoute;
 use OCP\AppFramework\Http\Attribute\NoAdminRequired;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\IL10N;
@@ -42,10 +43,14 @@ public function __construct(
 	/**
 	 * [api v2] Create a new row in a table or a view
 	 *
-	 * @param 'tables'|'views' $nodeCollection Indicates whether to create a row on a table or view
+	 * @param 'tables'|'views' $nodeCollection Indicates whether to create a
+	 *     row on a table or view
 	 * @param int $nodeId The identifier of the targeted table or view
-	 * @param string|array<string, mixed> $data An array containing the column identifiers and their values
-	 * @return DataResponse<Http::STATUS_OK, TablesRow, array{}>|DataResponse<Http::STATUS_FORBIDDEN|Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+	 * @param string|array<string, mixed> $data An array containing the column
+	 *     identifiers and their values
+	 * @return DataResponse<Http::STATUS_OK, TablesRow,
+	 *     array{}>|DataResponse<Http::STATUS_FORBIDDEN|Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND|Http::STATUS_INTERNAL_SERVER_ERROR,
+	 *     array{message: string}, array{}>
 	 *
 	 * 200: Row returned
 	 * 400: Invalid request parameters
@@ -55,6 +60,7 @@ public function __construct(
 	 */
 	#[NoAdminRequired]
 	#[RequirePermission(permission: Application::PERMISSION_CREATE, typeParam: 'nodeCollection')]
+	#[ApiRoute(verb: 'POST', url: '/api/2/{nodeCollection}/{nodeId}/rows', requirements: ['nodeCollection' => '(tables|views)', 'nodeId' => '(\d+)'])]
 	public function createRow(string $nodeCollection, int $nodeId, mixed $data): DataResponse {
 		if (is_string($data)) {
 			$data = json_decode($data, true);
@@ -86,4 +92,11 @@ public function createRow(string $nodeCollection, int $nodeId, mixed $data): Dat
 			return $this->handleError($e);
 		}
 	}
+
+	#[NoAdminRequired]
+	#[RequirePermission(permission: Application::PERMISSION_READ, typeParam: 'nodeCollection')]
+	#[ApiRoute(verb: 'GET', url: '/api/2/{nodeCollection}/{nodeId}/rows', requirements: ['nodeCollection' => '(tables|views)', 'nodeId' => '(\d+)'])]
+	public function getRows(int $nodeId, ?int $limit, ?int $offset, ?array $filter, ?array $sort): DataResponse {
+		return new DataResponse([]);
+	}
 }