Document returned entity in foreman_compute_profile

theforeman · Jul 25, 2020 · 89c7147 · 89c7147
1 parent 2f3de71
commit 89c7147
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/plugins/modules/compute_profile.py b/plugins/modules/compute_profile.py
@@ -135,7 +135,27 @@
     state: absent
 '''
 
-RETURN = ''' # '''
+RETURN = '''
+entity:
+  description: Final state of the affected entities grouped by their type.
+  returned: success
+  type: dict
+  contains:
+    compute_profiles:
+      description: List of compute profiles.
+      type: list
+      elements: dict
+      contains:
+        id:
+          description: Database id of the compute profile.
+          type: int
+        name:
+          description: Name of the compute profile.
+          type: str
+        compute_attributes:
+          description: Attributes for this compute profile.
+          type: list
+'''
 
 from ansible_collections.theforeman.foreman.plugins.module_utils.foreman_helper import ForemanEntityAnsibleModule