Add name attribute for template tab groups

UST-QuAntiL · Aug 2, 2024 · df414b6 · df414b6
1 parent a3c979e
commit df414b6
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 6 deletions.
diff --git a/qhana_plugin_registry/api/models/generators/template_groups.py b/qhana_plugin_registry/api/models/generators/template_groups.py
@@ -67,6 +67,11 @@ def generate_link(
         else:
             query_params[TEMPLATE_GROUP_QUERY_KEY] = resource.location
 
+        if resource.name:
+            name = resource.name
+        else:
+            name = f"Tab Group: {resource.location}"
+
         return ApiLink(
             href=url_for(
                 endpoint,
@@ -78,7 +83,7 @@ def generate_link(
             resource_type=meta.rel_type,
             resource_key=KeyGenerator.generate_key(resource, query_params=query_params),
             schema=f"{url_for(API_SPEC_RESOURCE, _external=True)}#/components/schemas/{TemplateGroupSchema.schema_name()}",
-            name=f"Tab Group: {resource.location}",
+            name=name,
         )
 
 

diff --git a/qhana_plugin_registry/api/models/generators/template_tabs.py b/qhana_plugin_registry/api/models/generators/template_tabs.py
@@ -131,7 +131,7 @@ def update_key(self, key: Dict[str, str], resource: TemplateTab) -> Dict[str, st
         assert isinstance(resource, TemplateTab)
         template = resource.template
         assert template is not None
-        parent_resource = TemplateGroupRaw(template, resource.location, [])
+        parent_resource = TemplateGroupRaw(template, resource.location, None, [])
         parent_key = KeyGenerator.generate_key(parent_resource)
         key.update(parent_key)
         key[TEMPLATE_TAB_ID_KEY] = str(resource.id)
@@ -173,7 +173,7 @@ def generate_link(
     ) -> Optional[ApiLink]:
         template = resource.template
         assert template is not None
-        parent_resource = TemplateGroupRaw(template, resource.location, [])
+        parent_resource = TemplateGroupRaw(template, resource.location, None, [])
         return LinkGenerator.get_link_of(
             parent_resource,
             extra_relations=(UP_REL,),

diff --git a/qhana_plugin_registry/api/models/generators/templates.py b/qhana_plugin_registry/api/models/generators/templates.py
@@ -227,14 +227,24 @@ def generate_api_object(
 
         assert self_link is not None
 
-        group_locations: Set[str] = {t.location for t in resource.tabs}
+        group_locations: Dict[str, Optional[str]] = {
+            t.location: None for t in resource.tabs
+        }
+
+        for t in resource.tabs:
+            if t.group_key:
+                group = f"{t.location}.{t.group_key}"
+                if group in group_locations:
+                    group_locations[group] = t.name
+
         groups = (
             TemplateGroupRaw(
                 template=resource,
                 location=loc,
+                name=name,
                 items=[],
             )
-            for loc in group_locations
+            for loc, name in group_locations.items()
         )
         group_links = [l for g in groups if (l := LinkGenerator.get_link_of(g))]
 

diff --git a/qhana_plugin_registry/api/models/templates_raw.py b/qhana_plugin_registry/api/models/templates_raw.py
@@ -13,12 +13,13 @@
 # limitations under the License.
 
 from dataclasses import dataclass
-from typing import Sequence
+from typing import Sequence, Optional
 from ...db.models.templates import UiTemplate, TemplateTab
 
 
 @dataclass
 class TemplateGroupRaw:
     template: UiTemplate
     location: str
+    name: Optional[str]
     items: Sequence[TemplateTab]
diff --git a/qhana_plugin_registry/api/template_tabs/root.py b/qhana_plugin_registry/api/template_tabs/root.py
@@ -89,9 +89,18 @@ def get(self, template_id: str, **kwargs):
         resource: Union[CollectionResource, TemplateGroupRaw]
 
         if group:
+            group_name = None
+            if "." in group:
+                *group_tab_group, group_key = group.split(".")
+                group_location = ".".join(group_tab_group)
+                for tab in found_template.tabs:
+                    if tab.location == group_location and tab.group_key == group_key:
+                        group_name = tab.name
+                        break
             resource = TemplateGroupRaw(
                 template=found_template,
                 location=group,
+                name=group_name,
                 items=tabs,
             )
         else: