Consolidate estimation and exportability warnings into a single endpoint

Avoids having to query multiple endpoints on the client for closely related information Signed-off-by: Christopher Ng <chrng8@gmail.com>
nextcloud · Jun 3, 2022 · e427f61 · e427f61
1 parent bb1a078
commit e427f61
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 20 deletions.
diff --git a/appinfo/routes.php b/appinfo/routes.php
@@ -33,7 +33,6 @@
 		['name' => 'Api#migrators', 'url' => '/api/v{apiVersion}/migrators', 'verb' => 'GET', 'requirements' => $requirements],
 		['name' => 'Api#status', 'url' => '/api/v{apiVersion}/status', 'verb' => 'GET', 'requirements' => $requirements],
 		['name' => 'Api#cancel', 'url' => '/api/v{apiVersion}/cancel', 'verb' => 'PUT', 'requirements' => $requirements],
-		['name' => 'Api#estimate', 'url' => '/api/v{apiVersion}/export/estimate', 'verb' => 'GET', 'requirements' => $requirements],
 		['name' => 'Api#exportable', 'url' => '/api/v{apiVersion}/export', 'verb' => 'GET', 'requirements' => $requirements],
 		['name' => 'Api#export', 'url' => '/api/v{apiVersion}/export', 'verb' => 'POST', 'requirements' => $requirements],
 		['name' => 'Api#import', 'url' => '/api/v{apiVersion}/import', 'verb' => 'POST', 'requirements' => $requirements],

diff --git a/lib/Controller/ApiController.php b/lib/Controller/ApiController.php
@@ -217,7 +217,7 @@ private function checkJobAndGetUser(): IUser {
 	 *
 	 * @throws OCSException
 	 */
-	public function estimate(?array $migrators): DataResponse {
+	public function exportable(?array $migrators): DataResponse {
 		$user = $this->checkJobAndGetUser();
 
 		if (!is_null($migrators)) {
@@ -230,29 +230,16 @@ public function estimate(?array $migrators): DataResponse {
 			throw new OCSException($e->getMessage());
 		}
 
-		return new DataResponse(['size' => $size], Http::STATUS_OK);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @NoSubAdminRequired
-	 *
-	 * @throws OCSException
-	 */
-	public function exportable(?array $migrators): DataResponse {
-		$user = $this->checkJobAndGetUser();
-
-		if (!is_null($migrators)) {
-			$this->checkMigrators($migrators);
-		}
-
 		try {
 			$this->migrationService->checkExportability($user, $migrators);
 		} catch (NotExportableException $e) {
-			throw new OCSException($e->getMessage());
+			$warning = $e->getMessage();
 		}
 
-		return new DataResponse([], Http::STATUS_OK);
+		return new DataResponse([
+			'size' => $size,
+			'warning' => $warning ?? null,
+		], Http::STATUS_OK);
 	}
 
 	/**