From 03fe06285be425c161a0f1820bde59306b90e14e Mon Sep 17 00:00:00 2001
From: DavHau <d.hauer.it@gmail.com>
Date: Tue, 24 Jun 2025 15:13:27 +0700
Subject: [PATCH] inventory interface: add description for module.name

---
 lib/inventory/build-inventory/interface.nix | 6 ++++++
 pkgs/clan-cli/clan_lib/nix_models/clan.py   | 4 ++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/lib/inventory/build-inventory/interface.nix b/lib/inventory/build-inventory/interface.nix
index b3978f861..ed3b4f488 100644
--- a/lib/inventory/build-inventory/interface.nix
+++ b/lib/inventory/build-inventory/interface.nix
@@ -393,6 +393,12 @@ in
                       options.name = lib.mkOption {
                         type = types.str;
                         default = name;
+                        defaultText = "<Name of the Instance>";
+                        description = ''
+                          Attribute of the clan service module imported from the chosen input.
+
+                          Defaults to the name of the instance.
+                        '';
                       };
                     };
                     default = { };
diff --git a/pkgs/clan-cli/clan_lib/nix_models/clan.py b/pkgs/clan-cli/clan_lib/nix_models/clan.py
index 8fdbef8a4..ab0cde71f 100644
--- a/pkgs/clan-cli/clan_lib/nix_models/clan.py
+++ b/pkgs/clan-cli/clan_lib/nix_models/clan.py
@@ -15,12 +15,12 @@ class Unknown:
     pass
 
 
-InventoryInstanceModuleInputType = str
 InventoryInstanceModuleNameType = str
+InventoryInstanceModuleInputType = str
 
 class InventoryInstanceModule(TypedDict):
+    name: str
     input: NotRequired[InventoryInstanceModuleInputType]
-    name: NotRequired[InventoryInstanceModuleNameType]