From 775c4975a0962bde3c11b2984aa62322417dce63 Mon Sep 17 00:00:00 2001
From: Tim Meusel <tim@bastelfreak.de>
Date: Sat, 13 Jan 2024 23:07:30 +0100
Subject: [PATCH] mysql::innobackupex_args: Fix documentation

Those changes were required to make `bundle exec rake
strings:generate:reference` pass again.
---
 REFERENCE.md                                  | 46 ++++++++++++++++++-
 .../functions/mysql/innobackupex_args.rb      | 11 ++---
 2 files changed, 50 insertions(+), 7 deletions(-)

diff --git a/REFERENCE.md b/REFERENCE.md
index 481f1903c..5952075ce 100644
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -56,6 +56,7 @@
 
 ### Functions
 
+* [`mysql::innobackupex_args`](#mysql--innobackupex_args): this function populates and returns the string of arguments which later gets injected in template.
 * [`mysql::normalise_and_deepmerge`](#mysql--normalise_and_deepmerge): Recursively merges two or more hashes together, normalises keys with differing use of dashes and underscores.
 * [`mysql::password`](#mysql--password): Hash a string as mysql's "PASSWORD()" function would do it
 * [`mysql::strip_hash`](#mysql--strip_hash): When given a hash this function strips out all blank entries.
@@ -707,7 +708,7 @@ Data type: `Optional[String[1]]`
 
 The provider to use to manage the service. For Ubuntu, defaults to 'upstart'; otherwise, default is undefined.
 
-Default value: `$mysql::params::server_service_provider`
+Default value: `undef`
 
 ##### <a name="-mysql--server--create_root_user"></a>`create_root_user`
 
@@ -1606,6 +1607,49 @@ discover the appropriate provider for your platform.
 
 ## Functions
 
+### <a name="mysql--innobackupex_args"></a>`mysql::innobackupex_args`
+
+Type: Ruby 4.x API
+
+arguments that return string holds is conditional and decided by the the input given to function.
+
+#### `mysql::innobackupex_args(Optional[String] $backupuser, Boolean $backupcompress, Optional[Variant[String, Sensitive[String]]] $backuppassword_unsensitive, Array[String[1]] $backupdatabases, Array[String[1]] $optional_args)`
+
+arguments that return string holds is conditional and decided by the the input given to function.
+
+Returns: `Variant[String]` String
+Generated on the basis of provided values.
+
+##### `backupuser`
+
+Data type: `Optional[String]`
+
+
+
+##### `backupcompress`
+
+Data type: `Boolean`
+
+
+
+##### `backuppassword_unsensitive`
+
+Data type: `Optional[Variant[String, Sensitive[String]]]`
+
+
+
+##### `backupdatabases`
+
+Data type: `Array[String[1]]`
+
+
+
+##### `optional_args`
+
+Data type: `Array[String[1]]`
+
+
+
 ### <a name="mysql--normalise_and_deepmerge"></a>`mysql::normalise_and_deepmerge`
 
 Type: Ruby 4.x API
diff --git a/lib/puppet/functions/mysql/innobackupex_args.rb b/lib/puppet/functions/mysql/innobackupex_args.rb
index e9cc12064..557981a31 100644
--- a/lib/puppet/functions/mysql/innobackupex_args.rb
+++ b/lib/puppet/functions/mysql/innobackupex_args.rb
@@ -4,12 +4,11 @@
 # arguments that return string holds is conditional and decided by the the input given to function.
 
 Puppet::Functions.create_function(:'mysql::innobackupex_args') do
-  # @param args
-  #   String backupuser
-  #   Boolean backupcompress
-  #   String backuppassword_unsensitive
-  #   Array backupdatabases
-  #   Array optional_args
+  # @param backupuser
+  # @param backupcompress
+  # @param backuppassword_unsensitive
+  # @param backupdatabases
+  # @param optional_args
   #
   # @return String
   #   Generated on the basis of provided values.