mysql_user: deprecate alias user for name argument

ansible-collections · Aug 29, 2024 · c4b6f6e · c4b6f6e
1 parent 87be61c
commit c4b6f6e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/changelogs/fragments/0-mysql_user.yml b/changelogs/fragments/0-mysql_user.yml
@@ -0,0 +1,2 @@
+breaking_changes:
+- mysql_user - the ``user`` alias of the ``name`` argument has been deprecated and will be removed in collection version 5.0.0. Use the ``name`` argument instead.
diff --git a/plugins/modules/mysql_user.py b/plugins/modules/mysql_user.py
@@ -439,7 +439,13 @@
 def main():
     argument_spec = mysql_common_argument_spec()
     argument_spec.update(
-        user=dict(type='str', required=True, aliases=['name']),
+        name=dict(type='str', required=True, aliases=['user'], deprecated_aliases=[
+            {
+                'name': 'user',
+                'version': '5.0.0',
+                'collection_name': 'community.mysql',
+            }],
+        ),
         password=dict(type='str', no_log=True),
         encrypted=dict(type='bool', default=False),
         host=dict(type='str', default='localhost'),
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		breaking_changes:
		- mysql_user - the ``user`` alias of the ``name`` argument has been deprecated and will be removed in collection version 5.0.0. Use the ``name`` argument instead.