From e64a439232a129732c6ff0bb07a028d331b89622 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Thu, 22 Jul 2021 15:19:25 +0300 Subject: [PATCH] Various Doc fixes (#53) * Various Doc fixes * Check * Put back * Fix --- plugins/modules/proxysql_backend_servers.py | 5 +++-- plugins/modules/proxysql_global_variables.py | 5 +++-- plugins/modules/proxysql_manage_config.py | 5 +++-- plugins/modules/proxysql_mysql_users.py | 7 ++++--- plugins/modules/proxysql_query_rules.py | 13 +++++++------ .../modules/proxysql_query_rules_fast_routing.py | 4 ++-- plugins/modules/proxysql_replication_hostgroups.py | 7 ++++--- plugins/modules/proxysql_scheduler.py | 9 +++++---- 8 files changed, 31 insertions(+), 24 deletions(-) diff --git a/plugins/modules/proxysql_backend_servers.py b/plugins/modules/proxysql_backend_servers.py index fe4c795..1265dcd 100644 --- a/plugins/modules/proxysql_backend_servers.py +++ b/plugins/modules/proxysql_backend_servers.py @@ -10,7 +10,7 @@ --- module: proxysql_backend_servers author: "Ben Mildren (@bmildren)" -short_description: Adds or removes mysql hosts from proxysql admin interface. +short_description: Adds or removes mysql hosts from proxysql admin interface description: - The M(community.proxysql.proxysql_backend_servers) module adds or removes mysql hosts using the proxysql admin interface. @@ -99,7 +99,8 @@ extends_documentation_fragment: - community.proxysql.proxysql.managing_config - community.proxysql.proxysql.connectivity - +notes: +- Supports C(check_mode). ''' EXAMPLES = ''' diff --git a/plugins/modules/proxysql_global_variables.py b/plugins/modules/proxysql_global_variables.py index 1e65bc8..2514a42 100644 --- a/plugins/modules/proxysql_global_variables.py +++ b/plugins/modules/proxysql_global_variables.py @@ -10,7 +10,7 @@ --- module: proxysql_global_variables author: "Ben Mildren (@bmildren)" -short_description: Gets or sets the proxysql global variables. +short_description: Gets or sets the proxysql global variables description: - The M(community.proxysql.proxysql_global_variables) module gets or sets the proxysql global variables. @@ -29,7 +29,8 @@ extends_documentation_fragment: - community.proxysql.proxysql.managing_config - community.proxysql.proxysql.connectivity - +notes: +- Supports C(check_mode). ''' EXAMPLES = ''' diff --git a/plugins/modules/proxysql_manage_config.py b/plugins/modules/proxysql_manage_config.py index 0ca99b3..a1a122c 100644 --- a/plugins/modules/proxysql_manage_config.py +++ b/plugins/modules/proxysql_manage_config.py @@ -11,7 +11,7 @@ module: proxysql_manage_config author: "Ben Mildren (@bmildren)" -short_description: Writes the proxysql configuration settings between layers. +short_description: Writes the proxysql configuration settings between layers description: - The M(community.proxysql.proxysql_global_variables) module writes the proxysql configuration settings between layers. Currently this module will always report a @@ -57,7 +57,8 @@ required: True extends_documentation_fragment: - community.proxysql.proxysql.connectivity - +notes: +- Supports C(check_mode). ''' EXAMPLES = ''' diff --git a/plugins/modules/proxysql_mysql_users.py b/plugins/modules/proxysql_mysql_users.py index aa60ed1..927052a 100644 --- a/plugins/modules/proxysql_mysql_users.py +++ b/plugins/modules/proxysql_mysql_users.py @@ -10,7 +10,7 @@ --- module: proxysql_mysql_users author: "Ben Mildren (@bmildren)" -short_description: Adds or removes mysql users from proxysql admin interface. +short_description: Adds or removes mysql users from proxysql admin interface description: - The M(community.proxysql.proxysql_mysql_users) module adds or removes mysql users using the proxysql admin interface. @@ -101,7 +101,8 @@ extends_documentation_fragment: - community.proxysql.proxysql.managing_config - community.proxysql.proxysql.connectivity - +notes: +- Supports C(check_mode). ''' EXAMPLES = ''' @@ -134,7 +135,7 @@ RETURN = ''' stdout: - description: The mysql user modified or removed from proxysql + description: The mysql user modified or removed from proxysql. returned: On create/update will return the newly modified user, on delete it will return the deleted record. type: dict diff --git a/plugins/modules/proxysql_query_rules.py b/plugins/modules/proxysql_query_rules.py index 440e17c..fe8c147 100644 --- a/plugins/modules/proxysql_query_rules.py +++ b/plugins/modules/proxysql_query_rules.py @@ -10,7 +10,7 @@ --- module: proxysql_query_rules author: "Ben Mildren (@bmildren)" -short_description: Modifies query rules using the proxysql admin interface. +short_description: Modifies query rules using the proxysql admin interface description: - The M(community.proxysql.proxysql_query_rules) module modifies query rules using the proxysql admin interface. @@ -61,12 +61,12 @@ match_digest: description: - Regular expression that matches the query digest. The dialect of - regular expressions used is that of re2 - https://github.com/google/re2 + regular expressions used is that of re2 - U(https://github.com/google/re2). type: str match_pattern: description: - Regular expression that matches the query text. The dialect of regular - expressions used is that of re2 - https://github.com/google/re2 + expressions used is that of re2 - U(https://github.com/google/re2). type: str negate_match_pattern: description: @@ -176,14 +176,15 @@ force_delete: description: - By default we avoid deleting more than one schedule in a single batch, - however if you need this behaviour and you're not concerned about the + however if you need this behaviour and you are not concerned about the schedules deleted, you can set I(force_delete) to C(True). type: bool default: False extends_documentation_fragment: - community.proxysql.proxysql.managing_config - community.proxysql.proxysql.connectivity - +notes: +- Supports C(check_mode). ''' EXAMPLES = ''' @@ -265,7 +266,7 @@ RETURN = ''' stdout: - description: The mysql user modified or removed from proxysql + description: The mysql user modified or removed from proxysql. returned: On create/update will return the newly modified rule, in all other cases will return a list of rules that match the supplied criteria. diff --git a/plugins/modules/proxysql_query_rules_fast_routing.py b/plugins/modules/proxysql_query_rules_fast_routing.py index 17adb90..716f4b6 100644 --- a/plugins/modules/proxysql_query_rules_fast_routing.py +++ b/plugins/modules/proxysql_query_rules_fast_routing.py @@ -59,11 +59,11 @@ schedules deleted, you can set I(force_delete) to C(True). type: bool default: False -notes: -- Supports C(check_mode). extends_documentation_fragment: - community.proxysql.proxysql.managing_config - community.proxysql.proxysql.connectivity +notes: +- Supports C(check_mode). ''' EXAMPLES = ''' diff --git a/plugins/modules/proxysql_replication_hostgroups.py b/plugins/modules/proxysql_replication_hostgroups.py index d8f5ee7..bdd412c 100644 --- a/plugins/modules/proxysql_replication_hostgroups.py +++ b/plugins/modules/proxysql_replication_hostgroups.py @@ -11,7 +11,7 @@ module: proxysql_replication_hostgroups author: "Ben Mildren (@bmildren)" short_description: Manages replication hostgroups using the proxysql admin - interface. + interface description: - Each row in mysql_replication_hostgroups represent a pair of writer_hostgroup and reader_hostgroup. ProxySQL will monitor the value of @@ -43,7 +43,8 @@ extends_documentation_fragment: - community.proxysql.proxysql.managing_config - community.proxysql.proxysql.connectivity - +notes: +- Supports C(check_mode). ''' EXAMPLES = ''' @@ -79,7 +80,7 @@ RETURN = ''' stdout: - description: The replication hostgroup modified or removed from proxysql + description: The replication hostgroup modified or removed from proxysql. returned: On create/update will return the newly modified group, on delete it will return the deleted record. type: dict diff --git a/plugins/modules/proxysql_scheduler.py b/plugins/modules/proxysql_scheduler.py index 136b328..1ee380d 100644 --- a/plugins/modules/proxysql_scheduler.py +++ b/plugins/modules/proxysql_scheduler.py @@ -10,7 +10,7 @@ --- module: proxysql_scheduler author: "Ben Mildren (@bmildren)" -short_description: Adds or removes schedules from proxysql admin interface. +short_description: Adds or removes schedules from proxysql admin interface description: - The M(community.proxysql.proxysql_scheduler) module adds or removes schedules using the proxysql admin interface. @@ -66,14 +66,15 @@ force_delete: description: - By default we avoid deleting more than one schedule in a single batch, - however if you need this behaviour and you're not concerned about the + however if you need this behaviour and you are not concerned about the schedules deleted, you can set I(force_delete) to C(True). type: bool default: False extends_documentation_fragment: - community.proxysql.proxysql.managing_config - community.proxysql.proxysql.connectivity - +notes: +- Supports C(check_mode). ''' EXAMPLES = ''' @@ -107,7 +108,7 @@ RETURN = ''' stdout: - description: The schedule modified or removed from proxysql + description: The schedule modified or removed from proxysql. returned: On create/update will return the newly modified schedule, on delete it will return the deleted record. type: dict