document slurp returns (#73865)

* no path on return
2021-03-11 15:28:47 -05:00 · 2021-03-11 15:28:47 -05:00 · b486feaaf4
commit b486feaaf4
parent bd020dd14a
1 changed files with 17 additions and 1 deletions
--- a/lib/ansible/modules/slurp.py
+++ b/lib/ansible/modules/slurp.py
@ -58,7 +58,23 @@ EXAMPLES = r'''
 # 2179
 '''

-RETURN = r'''#'''
+RETURN = r'''
+content:
+    description: Encoded file content
+    returned: success
+    type: str
+    sample: "MjE3OQo="
+encoding:
+    description: Type of encoding used for file
+    returned: success
+    type: str
+    sample: "base64"
+source:
+    description: Actual path of file slurped
+    returned: success
+    type: str
+    sample: "/var/run/sshd.pid"
+'''

 import base64
 import os