From 89d1637c32ea750cf00a76557c89beefb749650d Mon Sep 17 00:00:00 2001
From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com>
Date: Mon, 29 May 2023 11:02:20 +0200
Subject: [PATCH] Doc Attributes (#555) (#557)

* Added Attributes section

* Added Attributes section

(cherry picked from commit b79fd94d51eb986f413e4e6778d45ab9944ff653)

Co-authored-by: Pavel Rabel <128324708+elpavel@users.noreply.github.com>
---
 plugins/doc_fragments/mysql.py       | 3 +++
 plugins/modules/mysql_db.py          | 5 +++--
 plugins/modules/mysql_info.py        | 5 ++++-
 plugins/modules/mysql_query.py       | 3 +++
 plugins/modules/mysql_replication.py | 5 ++++-
 plugins/modules/mysql_role.py        | 5 ++++-
 plugins/modules/mysql_user.py        | 6 ++++--
 plugins/modules/mysql_variables.py   | 5 +++--
 8 files changed, 28 insertions(+), 9 deletions(-)

diff --git a/plugins/doc_fragments/mysql.py b/plugins/doc_fragments/mysql.py
index 939126c..27ec650 100644
--- a/plugins/doc_fragments/mysql.py
+++ b/plugins/doc_fragments/mysql.py
@@ -110,4 +110,7 @@ notes:
    - Alternatively, to avoid using I(login_unix_socket) argument on each invocation you can specify the socket path
      using the `socket` option in your MySQL config file (usually C(~/.my.cnf)) on the destination host, for
      example C(socket=/var/lib/mysql/mysql.sock).
+attributes:
+  check_mode:
+    description: Can run in check_mode and return changed status prediction without modifying target.
 '''
diff --git a/plugins/modules/mysql_db.py b/plugins/modules/mysql_db.py
index c17bd46..b760837 100644
--- a/plugins/modules/mysql_db.py
+++ b/plugins/modules/mysql_db.py
@@ -173,13 +173,14 @@ requirements:
    - mysql (command line binary)
    - mysqldump (command line binary)
 notes:
-   - Supports C(check_mode).
    - Requires the mysql and mysqldump binaries on the remote host.
    - This module is B(not idempotent) when I(state) is C(import),
      and will import the dump file each time if run more than once.
+attributes:
+  check_mode:
+    support: full
 extends_documentation_fragment:
 - community.mysql.mysql
-
 '''
 
 EXAMPLES = r'''
diff --git a/plugins/modules/mysql_info.py b/plugins/modules/mysql_info.py
index f29d887..fb67f84 100644
--- a/plugins/modules/mysql_info.py
+++ b/plugins/modules/mysql_info.py
@@ -47,7 +47,10 @@ options:
 notes:
 - Calculating the size of a database might be slow, depending on the number and size of tables in it.
   To avoid this, use I(exclude_fields=db_size).
-- Supports C(check_mode).
+
+attributes:
+  check_mode:
+    support: full
 
 seealso:
 - module: community.mysql.mysql_variables
diff --git a/plugins/modules/mysql_query.py b/plugins/modules/mysql_query.py
index 17fa62e..823dbd4 100644
--- a/plugins/modules/mysql_query.py
+++ b/plugins/modules/mysql_query.py
@@ -50,6 +50,9 @@ options:
     - Where passed queries run in a single transaction (C(yes)) or commit them one-by-one (C(no)).
     type: bool
     default: false
+attributes:
+  check_mode:
+    support: none
 seealso:
 - module: community.mysql.mysql_db
 author:
diff --git a/plugins/modules/mysql_replication.py b/plugins/modules/mysql_replication.py
index 2a7828c..421f287 100644
--- a/plugins/modules/mysql_replication.py
+++ b/plugins/modules/mysql_replication.py
@@ -194,10 +194,13 @@ options:
 notes:
 - If an empty value for the parameter of string type is needed, use an empty string.
 
+attributes:
+  check_mode:
+    support: none
+
 extends_documentation_fragment:
 - community.mysql.mysql
 
-
 seealso:
 - module: community.mysql.mysql_info
 - name: MySQL replication reference
diff --git a/plugins/modules/mysql_role.py b/plugins/modules/mysql_role.py
index 4027f8b..08904a6 100644
--- a/plugins/modules/mysql_role.py
+++ b/plugins/modules/mysql_role.py
@@ -109,7 +109,10 @@ notes:
   - Pay attention that the module runs C(SET DEFAULT ROLE ALL TO)
     all the I(members) passed by default when the state has changed.
     If you want to avoid this behavior, set I(set_default_role_all) to C(no).
-  - Supports C(check_mode).
+
+attributes:
+  check_mode:
+    support: full
 
 seealso:
   - module: community.mysql.mysql_user
diff --git a/plugins/modules/mysql_user.py b/plugins/modules/mysql_user.py
index e093ad6..846d306 100644
--- a/plugins/modules/mysql_user.py
+++ b/plugins/modules/mysql_user.py
@@ -131,7 +131,10 @@ notes:
      2) drop a C(~/.my.cnf) file containing the new root credentials.
      Subsequent runs of the playbook will then succeed by reading the new credentials from the file."
    - Currently, there is only support for the C(mysql_native_password) encrypted password hash module.
-   - Supports (check_mode).
+
+attributes:
+  check_mode:
+    support: full
 
 seealso:
 - module: community.mysql.mysql_info
@@ -148,7 +151,6 @@ author:
 - Lukasz Tomaszkiewicz (@tomaszkiewicz)
 extends_documentation_fragment:
 - community.mysql.mysql
-
 '''
 
 EXAMPLES = r'''
diff --git a/plugins/modules/mysql_variables.py b/plugins/modules/mysql_variables.py
index dc54c82..f2d1d98 100644
--- a/plugins/modules/mysql_variables.py
+++ b/plugins/modules/mysql_variables.py
@@ -44,8 +44,9 @@ options:
     default: global
     version_added: '0.1.0'
 
-notes:
-- Does not support C(check_mode).
+attributes:
+  check_mode:
+    support: none
 
 seealso:
 - module: community.mysql.mysql_info