Optional node aliase filter on controlled list endpoint #57

archesproject · Jan 15, 2025 · bb0c1f3 · bb0c1f3
1 parent 6a7bc00
commit bb0c1f3
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 6 deletions.
diff --git a/arches_references/src/arches_references/api.ts b/arches_references/src/arches_references/api.ts
@@ -22,8 +22,12 @@ function getToken() {
     return token;
 }
 
-export const fetchLists = async () => {
-    const response = await fetch(arches.urls.controlled_lists);
+export const fetchLists = async (
+    nodeAliases: string[] | undefined = undefined,
+) => {
+    const params = new URLSearchParams();
+    nodeAliases?.forEach((alias) => params.append("node_alias", alias));
+    const response = await fetch(`${arches.urls.controlled_lists}?${params}`);
     try {
         const parsed = await response.json();
         if (response.ok) {

diff --git a/arches_references/views.py b/arches_references/views.py
@@ -63,9 +63,14 @@ def _prefetch_terms(request):
 class ListsView(APIBase):
     def get(self, request):
         """Returns either a flat representation (?flat=true) or a tree (default)."""
-        lists = (
+        flat = str_to_bool(request.GET.get("flat", "false"))
+        permitted = get_nodegroups_by_perm(request.user, "read_nodegroup")
+        NOT_PROVIDED = object()
+        node_aliases = request.GET.getlist("node_alias", NOT_PROVIDED)
+        lists_query = (
             List.objects.annotate_node_fields(
                 node_ids="pk",
+                node_alias="alias",
                 node_names="name",
                 nodegroup_ids="nodegroup_id",
                 graph_ids="graph_id",
@@ -74,11 +79,12 @@ def get(self, request):
             .order_by("name")
             .prefetch_related(*_prefetch_terms(request))
         )
+        if node_aliases is not NOT_PROVIDED:
+            lists_query = lists_query.filter(node_alias__overlap=node_aliases)
 
-        flat = str_to_bool(request.GET.get("flat", "false"))
-        permitted = get_nodegroups_by_perm(request.user, "read_nodegroup")
         serialized = [
-            obj.serialize(flat=flat, permitted_nodegroups=permitted) for obj in lists
+            obj.serialize(flat=flat, permitted_nodegroups=permitted)
+            for obj in lists_query
         ]
 
         return JSONResponse({"controlled_lists": serialized})