From d88ecdbccc0da0a61338d23673adf6a6fded211c Mon Sep 17 00:00:00 2001
From: Jonas L <jooola@users.noreply.github.com>
Date: Thu, 4 Apr 2024 12:40:24 +0200
Subject: [PATCH] feat: rename server `image_allow_deprecated` option (#487)

##### SUMMARY

Renamed the `allow_deprecated_image` to `image_allow_deprecated`
argument to ensure the `image` related options use the same namespace.

This is backward compatible, as we introduce a new alias for the old
option name.
---
 ...r-rename-image_allow_deprecated-argument.yml |  2 ++
 plugins/modules/server.py                       | 17 +++++++++--------
 2 files changed, 11 insertions(+), 8 deletions(-)
 create mode 100644 changelogs/fragments/server-rename-image_allow_deprecated-argument.yml

diff --git a/changelogs/fragments/server-rename-image_allow_deprecated-argument.yml b/changelogs/fragments/server-rename-image_allow_deprecated-argument.yml
new file mode 100644
index 0000000..f420894
--- /dev/null
+++ b/changelogs/fragments/server-rename-image_allow_deprecated-argument.yml
@@ -0,0 +1,2 @@
+minor_changes:
+  - server - Renamed the `allow_deprecated_image` option to `image_allow_deprecated`.
diff --git a/plugins/modules/server.py b/plugins/modules/server.py
index 44373e5..1579e66 100644
--- a/plugins/modules/server.py
+++ b/plugins/modules/server.py
@@ -57,6 +57,12 @@ options:
             - Hetzner Cloud Image (name or ID) to create the server from.
             - Required if server does not exist or when O(state=rebuild).
         type: str
+    image_allow_deprecated:
+        description:
+            - Allows the creation of servers with deprecated images.
+        type: bool
+        default: false
+        aliases: [allow_deprecated_image]
     location:
         description:
             - Hetzner Cloud Location (name or ID) to create the server in.
@@ -113,11 +119,6 @@ options:
         type: bool
         default: false
         aliases: [force_upgrade]
-    allow_deprecated_image:
-        description:
-            - Allows the creation of servers with deprecated images.
-        type: bool
-        default: false
     user_data:
         description:
             - User Data to be passed to the server on creation.
@@ -506,7 +507,7 @@ class AnsibleHCloudServer(AnsibleHCloud):
 
         if image.deprecated is not None:
             available_until = image.deprecated + timedelta(days=90)
-            if self.module.params.get("allow_deprecated_image"):
+            if self.module.params.get("image_allow_deprecated"):
                 self.module.warn(
                     f"You try to use a deprecated image. The image {image.name} will "
                     f"continue to be available until {available_until.strftime('%Y-%m-%d')}."
@@ -516,7 +517,7 @@ class AnsibleHCloudServer(AnsibleHCloud):
                     msg=(
                         f"You try to use a deprecated image. The image {image.name} will "
                         f"continue to be available until {available_until.strftime('%Y-%m-%d')}. "
-                        "If you want to use this image use allow_deprecated_image=true."
+                        "If you want to use this image use image_allow_deprecated=true."
                     )
                 )
         return image
@@ -884,6 +885,7 @@ class AnsibleHCloudServer(AnsibleHCloud):
                 id={"type": "int"},
                 name={"type": "str"},
                 image={"type": "str"},
+                image_allow_deprecated={"type": "bool", "default": False, "aliases": ["allow_deprecated_image"]},
                 server_type={"type": "str"},
                 location={"type": "str"},
                 datacenter={"type": "str"},
@@ -907,7 +909,6 @@ class AnsibleHCloudServer(AnsibleHCloud):
                         {"collection_name": "hetzner.hcloud", "name": "force_upgrade", "version": "4.0.0"}
                     ],
                 },
-                allow_deprecated_image={"type": "bool", "default": False},
                 rescue_mode={"type": "str"},
                 delete_protection={"type": "bool"},
                 rebuild_protection={"type": "bool"},