Add helper fragment for modules that do not modify state.

ansible-collections · Dec 29, 2024 · 2321349 · 2321349
1 parent 8eb7c75
commit 2321349
Show file tree

Hide file tree

Showing 13 changed files with 19 additions and 20 deletions.
diff --git a/plugins/doc_fragments/attributes.py b/plugins/doc_fragments/attributes.py
@@ -24,6 +24,16 @@ class ModuleDocFragment(object):
       - This assumes that the system controlled/queried by the module has not changed in a relevant way.
 """
 
+    # Should be used together with the standard fragment
+    IDEMPOTENT_NOT_MODIFY_STATE = r"""
+options: {}
+attributes:
+  idempotent:
+    support: full
+    details:
+      - This action does not modify state.
+"""
+
     # Should be used together with the standard fragment
     INFO_MODULE = r'''
 options: {}

diff --git a/plugins/doc_fragments/module_record_info.py b/plugins/doc_fragments/module_record_info.py
@@ -18,8 +18,6 @@ class ModuleDocFragment(object):
 attributes:
   idempotent:
     support: full
-    details:
-      - This action does not modify state.
 options:
   what:
     description:

diff --git a/plugins/doc_fragments/module_record_set_info.py b/plugins/doc_fragments/module_record_set_info.py
@@ -18,8 +18,6 @@ class ModuleDocFragment(object):
 attributes:
   idempotent:
     support: full
-    details:
-      - This action does not modify state.
 options:
   what:
     description:

diff --git a/plugins/doc_fragments/module_zone_info.py b/plugins/doc_fragments/module_zone_info.py
@@ -15,8 +15,6 @@ class ModuleDocFragment(object):
 attributes:
   idempotent:
     support: full
-    details:
-      - This action does not modify state.
 options:
   zone_name:
     description:

diff --git a/plugins/modules/hetzner_dns_record_info.py b/plugins/modules/hetzner_dns_record_info.py
@@ -28,6 +28,7 @@
   - community.dns.attributes
   - community.dns.attributes.actiongroup_hetzner
   - community.dns.attributes.info_module
+  - community.dns.attributes.idempotent_not_modify_state
 
 attributes:
   action_group:

diff --git a/plugins/modules/hetzner_dns_record_set_info.py b/plugins/modules/hetzner_dns_record_set_info.py
@@ -28,6 +28,7 @@
   - community.dns.attributes
   - community.dns.attributes.actiongroup_hetzner
   - community.dns.attributes.info_module
+  - community.dns.attributes.idempotent_not_modify_state
 
 attributes:
   action_group:

diff --git a/plugins/modules/hetzner_dns_zone_info.py b/plugins/modules/hetzner_dns_zone_info.py
@@ -25,6 +25,7 @@
   - community.dns.attributes
   - community.dns.attributes.actiongroup_hetzner
   - community.dns.attributes.info_module
+  - community.dns.attributes.idempotent_not_modify_state
 
 attributes:
   action_group:

diff --git a/plugins/modules/hosttech_dns_record_info.py b/plugins/modules/hosttech_dns_record_info.py
@@ -28,6 +28,7 @@
   - community.dns.attributes
   - community.dns.attributes.actiongroup_hosttech
   - community.dns.attributes.info_module
+  - community.dns.attributes.idempotent_not_modify_state
 
 attributes:
   action_group:

diff --git a/plugins/modules/hosttech_dns_record_set_info.py b/plugins/modules/hosttech_dns_record_set_info.py
@@ -30,6 +30,7 @@
   - community.dns.attributes
   - community.dns.attributes.actiongroup_hosttech
   - community.dns.attributes.info_module
+  - community.dns.attributes.idempotent_not_modify_state
 
 attributes:
   action_group:

diff --git a/plugins/modules/hosttech_dns_zone_info.py b/plugins/modules/hosttech_dns_zone_info.py
@@ -25,6 +25,7 @@
   - community.dns.attributes
   - community.dns.attributes.actiongroup_hosttech
   - community.dns.attributes.info_module
+  - community.dns.attributes.idempotent_not_modify_state
 
 attributes:
   action_group:

diff --git a/plugins/modules/nameserver_info.py b/plugins/modules/nameserver_info.py
@@ -18,13 +18,9 @@
 extends_documentation_fragment:
   - community.dns.attributes
   - community.dns.attributes.info_module
+  - community.dns.attributes.idempotent_not_modify_state
 author:
   - Felix Fontein (@felixfontein)
-attributes:
-  idempotent:
-    support: full
-    details:
-      - This action does not modify state.
 options:
   name:
     description:

diff --git a/plugins/modules/nameserver_record_info.py b/plugins/modules/nameserver_record_info.py
@@ -19,13 +19,9 @@
 extends_documentation_fragment:
   - community.dns.attributes
   - community.dns.attributes.info_module
+  - community.dns.attributes.idempotent_not_modify_state
 author:
   - Felix Fontein (@felixfontein)
-attributes:
-  idempotent:
-    support: full
-    details:
-      - This action does not modify state.
 options:
   name:
     description:

diff --git a/plugins/modules/wait_for_txt.py b/plugins/modules/wait_for_txt.py
@@ -17,6 +17,7 @@
   - Wait for TXT entries with specific values to show up on B(all) authoritative nameservers for the DNS name.
 extends_documentation_fragment:
   - community.dns.attributes
+  - community.dns.attributes.idempotent_not_modify_state
 attributes:
   check_mode:
     support: full
@@ -27,10 +28,6 @@
     support: N/A
     details:
       - This action does not modify state.
-  idempotent:
-    support: full
-    details:
-      - This action does not modify state.
 author:
   - Felix Fontein (@felixfontein)
 options: