👌 [#357] PR feedback

maykinmedia · Feb 13, 2025 · ec4d6bd · ec4d6bd
1 parent 1a3059e
commit ec4d6bd
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/frontend/src/lib/api/zaken.test.ts b/frontend/src/lib/api/zaken.test.ts
@@ -1,9 +1,9 @@
 import fetchMock from "jest-fetch-mock";
 
 import { zakenFactory } from "../../fixtures/zaak";
-import { listZaken } from "./zaken";
+import { searchZaken } from "./zaken";
 
-describe("listZaken", () => {
+describe("searchZaken", () => {
   beforeAll(() => {
     fetchMock.enableMocks();
   });
@@ -15,11 +15,11 @@ describe("listZaken", () => {
   it("should return a list of users on success", async () => {
     const zaken = zakenFactory();
     fetchMock.mockResponseOnce(JSON.stringify(zaken));
-    await expect(listZaken()).resolves.toEqual(zaken);
+    await expect(searchZaken()).resolves.toEqual(zaken);
   });
 
   it("should throw an error on failure", async () => {
     fetchMock.mockRejectOnce(new Error("Internal Server Error"));
-    await expect(listZaken()).rejects.toThrow("Internal Server Error");
+    await expect(searchZaken()).rejects.toThrow("Internal Server Error");
   });
 });
diff --git a/frontend/src/lib/api/zaken.ts b/frontend/src/lib/api/zaken.ts
@@ -5,10 +5,10 @@ import { request } from "./request";
 export type PaginatedZaken = PaginatedResults<Zaak>;
 
 /**
- * Retrieve zaken using the configured ZRC service. For information over the query parameters accepted and the schema of
- * the response, look at the '/zaken/api/v1/zaken' list endpoint of Open Zaak.
+ * Search zaken using the configured ZRC service. For information over the filters that can be passed in the
+ * request body, look at query params of the '/zaken/api/v1/zaken' list endpoint of Open Zaak.
  */
-export async function listZaken(params?: Record<string, string>) {
+export async function searchZaken(params?: Record<string, string>) {
   const response = await request(
     "POST",
     "/zaken/search/",

diff --git a/frontend/src/pages/destructionlist/create/DestructionListCreate.loader.ts b/frontend/src/pages/destructionlist/create/DestructionListCreate.loader.ts
@@ -2,7 +2,7 @@ import { LoaderFunctionArgs } from "@remix-run/router/utils";
 
 import { User } from "../../../lib/api/auth";
 import { listReviewers } from "../../../lib/api/reviewers";
-import { PaginatedZaken, listZaken } from "../../../lib/api/zaken";
+import { PaginatedZaken, searchZaken } from "../../../lib/api/zaken";
 import {
   canStartDestructionListRequired,
   loginRequired,
@@ -35,7 +35,7 @@ export const destructionListCreateLoader = loginRequired(
 
       // Fetch reviewers, zaken, and choices concurrently
       const [zaken, reviewers] = await Promise.all([
-        listZaken(searchParamsZakenEndpoint),
+        searchZaken(searchParamsZakenEndpoint),
         listReviewers(),
       ]);
 

diff --git a/frontend/src/pages/destructionlist/detail/DestructionListDetail.loader.ts b/frontend/src/pages/destructionlist/detail/DestructionListDetail.loader.ts
@@ -22,7 +22,7 @@ import {
   ReviewResponse,
   getLatestReviewResponse,
 } from "../../../lib/api/reviewResponse";
-import { PaginatedZaken, listZaken } from "../../../lib/api/zaken";
+import { PaginatedZaken, searchZaken } from "../../../lib/api/zaken";
 import {
   canViewDestructionListRequired,
   loginRequired,
@@ -95,7 +95,7 @@ export const destructionListDetailLoader = loginRequired(
         async (): Promise<PaginatedDestructionListItems> => {
           const params = searchParams;
           if (isEditing) {
-            params["item-order_match_zaken"] = "true"; // Must be in sync with `listZaken()` ordering.
+            params["item-order_match_zaken"] = "true"; // Must be in sync with `searchZaken()` ordering.
           }
           return reviewItemsWithZaak
             ? {
@@ -158,7 +158,7 @@ export const destructionListDetailLoader = loginRequired(
               previous: null,
               results: [],
             } as PaginatedZaken)
-          : listZaken({
+          : searchZaken({
               ...searchParams,
               not_in_destruction_list_except: uuid,
             });