Merge pull request 'api/generators: remove term 'vars' interact purely with 'generators'' (#4242) from api-cleanup into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4242

pkgs/clan-cli/clan_lib/api/__init__.py

@@ -254,6 +254,7 @@ API.register(open_file)
                 "type": "object",
                 "required": ["arguments", "return"],
                 "additionalProperties": False,
+                "description": func.__doc__,
                 "properties": {
                     "return": return_type,
                     "arguments": {

pkgs/clan-cli/clan_lib/api/tasks.py

@@ -17,7 +17,7 @@ BAKEND_THREADS: dict[str, WebThread] | None = None
 
 
 @API.register_abstract
-def cancel_task(task_id: str) -> None:
+def delete_task(task_id: str) -> None:
     """Cancel a task by its op_key."""
     assert BAKEND_THREADS is not None, "Backend threads not initialized"
     future = BAKEND_THREADS.get(task_id)

pkgs/clan-cli/clan_lib/machines/hardware.py

@@ -67,7 +67,7 @@ class HardwareGenerateOptions:
 
 
 @API.register
-def generate_machine_hardware_info(
+def run_machine_hardware_info(
     opts: HardwareGenerateOptions, target_host: Remote
 ) -> HardwareConfig:
     """
@@ -157,7 +157,7 @@ class MachineHardwareBrief(TypedDict):
 
 
 @API.register
-def describe_machine_hardware(machine: Machine) -> MachineHardwareBrief:
+def get_machine_hardware_summary(machine: Machine) -> MachineHardwareBrief:
     """
     Return a high-level summary of hardware config and platform type.
     """

pkgs/clan-cli/clan_lib/tests/test_create.py

@@ -14,7 +14,7 @@ from clan_cli.machines.create import create_machine
 from clan_cli.secrets.key import generate_key
 from clan_cli.secrets.sops import maybe_get_admin_public_keys
 from clan_cli.secrets.users import add_user
-from clan_cli.vars.generate import create_machine_vars, get_machine_generators
+from clan_cli.vars.generate import run_generators, get_generators
 
 from clan_lib.api.disk import hw_main_disk_options, set_machine_disk_schema
 from clan_lib.api.modules import list_modules
@@ -222,7 +222,7 @@ def test_clan_create_api(
     # Invalidate cache because of new inventory
     clan_dir_flake.invalidate_cache()
 
-    generators = get_machine_generators(machine.name, machine.flake.path)
+    generators = get_generators(machine.name, machine.flake.path)
     all_prompt_values = {}
     for generator in generators:
         prompt_values = {}
@@ -235,7 +235,7 @@ def test_clan_create_api(
                 raise ClanError(msg)
         all_prompt_values[generator.name] = prompt_values
 
-    create_machine_vars(
+    run_generators(
         machine_name=machine.name,
         base_dir=machine.flake.path,
         generators=[gen.name for gen in generators],