Documentation: yes/no/True/False -> true/false (#133) (#135)

(cherry picked from commit 4c7df75)

Co-authored-by: Andrew Klychkov <[email protected]>

plugins/modules/proxysql_backend_servers.py

@@ -25,7 +25,7 @@
     description:
       - The ip address at which the mysqld instance can be contacted.
     type: str
-    required: True
+    required: true
   port:
     description:
       - The port at which the mysqld instance can be contacted.
@@ -118,7 +118,7 @@
     login_password: 'admin'
     hostname: 'mysql01'
     state: present
-    load_to_runtime: False
+    load_to_runtime: false
 
 # This example removes a server, saves the mysql server config to disk, and
 # dynamically loads the mysql server config to runtime.  It uses credentials

plugins/modules/proxysql_global_variables.py

@@ -20,7 +20,7 @@
       - Defines which variable should be returned, or if I(value) is specified
         which variable should be updated.
     type: str
-    required: True
+    required: true
   value:
     description:
       - Defines a value the variable specified using I(variable) should be set

plugins/modules/proxysql_manage_config.py

@@ -26,14 +26,14 @@
         between the I(config_layers).
     type: str
     choices: [ "LOAD", "SAVE" ]
-    required: True
+    required: true
   config_settings:
     description:
       - The I(config_settings) specifies which configuration we're writing.
     type: str
     choices: [ "MYSQL USERS", "MYSQL SERVERS", "MYSQL QUERY RULES",
                "MYSQL VARIABLES", "ADMIN VARIABLES", "SCHEDULER" ]
-    required: True
+    required: true
   direction:
     description:
       - FROM - denotes we're reading values FROM the supplied I(config_layer)
@@ -42,7 +42,7 @@
              supplied I(config_layer)."
     type: str
     choices: [ "FROM", "TO" ]
-    required: True
+    required: true
   config_layer:
     description:
       - RUNTIME - represents the in-memory data structures of ProxySQL used by
@@ -54,7 +54,7 @@
                  config file.
     type: str
     choices: [ "MEMORY", "DISK", "RUNTIME", "CONFIG" ]
-    required: True
+    required: true
 extends_documentation_fragment:
 - community.proxysql.proxysql.connectivity
 notes:

plugins/modules/proxysql_mysql_users.py

@@ -19,7 +19,7 @@
     description:
       - Name of the user connecting to the mysqld or ProxySQL instance.
     type: str
-    required: True
+    required: true
   password:
     description:
       - Password of the user connecting to the mysqld or ProxySQL instance.
@@ -28,7 +28,7 @@
     description:
       - Encrypt a cleartext password passed in the I(password) option, using
         the method defined in I(encryption_method).
-    default: False
+    default: false
     type: bool
   encryption_method:
     description:
@@ -78,13 +78,13 @@
     description:
       -  If I(backend) is set to C(True), this (username, password) pair is
          used for authenticating to the ProxySQL instance.
-    default: True
+    default: true
     type: bool
   frontend:
     description:
       - If I(frontend) is set to C(True), this (username, password) pair is
         used for authenticating to the mysqld servers against any hostgroup.
-    default: True
+    default: true
     type: bool
   max_connections:
     description:
@@ -120,7 +120,7 @@
     login_password: 'admin'
     username: 'productiondba'
     state: present
-    load_to_runtime: False
+    load_to_runtime: false
 
 # This example removes a user, saves the mysql user config to disk, and
 # dynamically loads the mysql user config to runtime.  It uses credentials

plugins/modules/proxysql_query_rules.py

@@ -192,7 +192,7 @@
         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
+    default: false
 extends_documentation_fragment:
 - community.proxysql.proxysql.managing_config
 - community.proxysql.proxysql.connectivity
@@ -219,7 +219,7 @@
     active: 1
     retries: 3
     state: present
-    load_to_runtime: False
+    load_to_runtime: false
 
 # This example demonstrates the situation, if your application tries to set a
 # variable that will disable multiplexing, and you think it can be filtered out,

plugins/modules/proxysql_query_rules_fast_routing.py

@@ -21,13 +21,13 @@
       - Filtering criteria matching username, a query will match only if the connection is made with
         the correct username.
     type: str
-    required: True
+    required: true
   schemaname:
     description:
       - Filtering criteria matching schemaname, a query will match only if the connection uses
         schemaname as its default schema.
     type: str
-    required: True
+    required: true
   flagIN:
     description:
       - Evaluated in the same way as I(flagIN) is in B(mysql_query_rules) and correlates to the
@@ -41,7 +41,7 @@
         started transaction and the logged in user has
         I(transaction_persistent) set to C(True) (refer to M(community.proxysql.proxysql_mysql_users)).
     type: int
-    required: True
+    required: true
   comment:
     description:
       - Free form text field, usable for a descriptive comment of the query rule.
@@ -59,7 +59,7 @@
         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
+    default: false
 extends_documentation_fragment:
 - community.proxysql.proxysql.managing_config
 - community.proxysql.proxysql.connectivity

plugins/modules/proxysql_replication_hostgroups.py

@@ -23,12 +23,12 @@
     description:
       - Id of the writer hostgroup.
     type: int
-    required: True
+    required: true
   reader_hostgroup:
     description:
       - Id of the reader hostgroup.
     type: int
-    required: True
+    required: true
   comment:
     description:
       - Text field that can be used for any purposes defined by the user.
@@ -73,7 +73,7 @@
     writer_hostgroup: 1
     reader_hostgroup: 2
     state: present
-    load_to_runtime: False
+    load_to_runtime: false
 
 - name: Change check_type
   community.proxysql.proxysql_replication_hostgroups:
@@ -83,7 +83,7 @@
     reader_hostgroup: 2
     check_type: innodb_read_only
     state: present
-    load_to_runtime: False
+    load_to_runtime: false
 
 # This example removes a replication hostgroup, saves the mysql server config
 # to disk, and dynamically loads the mysql server config to runtime.  It uses

plugins/modules/proxysql_scheduler.py

@@ -20,7 +20,7 @@
       - A schedule with I(active) set to C(False) will be tracked in the
         database, but will be never loaded in the in-memory data structures.
     type: bool
-    default: True
+    default: true
   interval_ms:
     description:
       - How often (in millisecond) the job will be started. The minimum value
@@ -31,7 +31,7 @@
     description:
       - Full path of the executable to be executed.
     type: str
-    required: True
+    required: true
   arg1:
     description:
       - Argument that can be passed to the job.
@@ -69,7 +69,7 @@
         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
+    default: false
 extends_documentation_fragment:
 - community.proxysql.proxysql.managing_config
 - community.proxysql.proxysql.connectivity
@@ -93,7 +93,7 @@
     interval_ms: 1000
     filename: "/opt/maintenance.py"
     state: present
-    load_to_runtime: False
+    load_to_runtime: false
 
 # This example removes a schedule, saves the scheduler config to disk, and
 # dynamically loads the scheduler config to runtime.  It uses credentials