From 5c8d0feb451e82926cf80ad8e55ea0c4423d23c1 Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Thu, 7 May 2026 21:58:55 +0200 Subject: [PATCH] [PR #11997/240ff653 backport][stable-12] filetree lookup: document RETURN value `state` (#12010) filetree lookup: document RETURN value `state` (#11997) * Clarify 'state' parameter description in filetree.py Updated the description for the 'state' parameter to clarify entry types and their meanings. * Apply suggestion from felixfontein related to description --------- (cherry picked from commit 240ff653112cbf6be12cb3cc57c4fa032cbacd70) Co-authored-by: Santosh Mahale Co-authored-by: Felix Fontein --- plugins/lookup/filetree.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/plugins/lookup/filetree.py b/plugins/lookup/filetree.py index 3df799213e..53f43b39cb 100644 --- a/plugins/lookup/filetree.py +++ b/plugins/lookup/filetree.py @@ -88,8 +88,12 @@ _raw: description: The permissions the resulting file or directory. type: str state: - description: TODO. + description: + - Type of the resulting file or directory. + - V(directory) for a directory, V(file) for a regular file, V(link) for a symbolic link. + - Other file types are skipped and not returned. type: str + choices: [directory, file, link] owner: description: Name of the user that owns the file/directory. type: raw