feat(Contexts): API endpoint to delete a context

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
nextcloud · Mar 13, 2024 · 5c6489c · 5c6489c
1 parent b9e9e42
commit 5c6489c
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/appinfo/routes.php b/appinfo/routes.php
@@ -132,6 +132,7 @@
 		['name' => 'Context#show', 'url' => '/api/2/contexts/{contextId}', 'verb' => 'GET'],
 		['name' => 'Context#create', 'url' => '/api/2/contexts', 'verb' => 'POST'],
 		['name' => 'Context#update', 'url' => '/api/2/contexts/{contextId}', 'verb' => 'PUT'],
+		['name' => 'Context#destroy', 'url' => '/api/2/contexts/{contextId}', 'verb' => 'DELETE'],
 		['name' => 'Context#transfer', 'url' => '/api/2/contexts/{contextId}/transfer', 'verb' => 'PUT'],
 		['name' => 'Context#addNode', 'url' => '/api/2/contexts/{contextId}/nodes', 'verb' => 'POST'],
 		['name' => 'Context#removeNode', 'url' => '/api/2/contexts/{contextId}/nodes/{nodeRelId}', 'verb' => 'DELETE'],

diff --git a/lib/Controller/ContextController.php b/lib/Controller/ContextController.php
@@ -137,6 +137,29 @@ public function update(int $contextId, ?string $name, ?string $iconName, ?string
 		}
 	}
 
+	/**
+	 * [api v2] Delete an existing context and return it
+	 *
+	 * @param int $contextId ID of the context
+	 * @return DataResponse<Http::STATUS_OK, TablesContext, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR|Http::STATUS_NOT_FOUND, array{message: string}, array{}>
+	 *
+	 * 200: returning the full context information
+	 * 403: No permissions
+	 * 404: Not found
+	 *
+	 * @NoAdminRequired
+	 * @CanManageContext
+	 */
+	public function destroy(int $contextId): DataResponse {
+		try {
+			return new DataResponse($this->contextService->delete($contextId, $this->userId)->jsonSerialize());
+		} catch (Exception $e) {
+			return $this->handleError($e);
+		} catch (NotFoundError $e) {
+			return $this->handleNotFoundError($e);
+		}
+	}
+
 	/**
 	 * [api v2] Transfer the ownership of a context and return it
 	 *

diff --git a/lib/Service/ContextService.php b/lib/Service/ContextService.php
@@ -206,6 +206,15 @@ public function update(int $contextId, string $userId, ?string $name, ?string $i
 		return $context;
 	}
 
+	/**
+	 * @throws NotFoundError
+	 * @throws Exception
+	 */
+	public function delete(int $contextId, string $userId): Context {
+		$context = $this->contextMapper->findById($contextId, $userId);
+		return $this->contextMapper->delete($context);
+	}
+
 	/**
 	 * @throws MultipleObjectsReturnedException
 	 * @throws DoesNotExistException