Ft/region adjustment fix

CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ### Highlights
 
+- `authorization`: [v0.2.1](services/authorization/CHANGELOG.md#v021-2025-01-14)
+  - **Bugfix**: `configuration.py` region adjustment was missing
+- `certificates`: [v0.2.1](services/certificates/CHANGELOG.md#v021-2025-01-14)
+  - **Bugfix**: `configuration.py` region adjustment was missing
+- `dns`: [v0.2.1](services/dns/CHANGELOG.md#v021-2025-01-14)
+  - **Bugfix**: `configuration.py` region adjustment was missing
+- `iaas`: [v0.3.1](services/iaas/CHANGELOG.md#v031-2025-01-14)
+  - **Bugfix**: `configuration.py` region adjustment was missing
+- `lbapplication`: [v0.2.1](services/lbapplication/CHANGELOG.md#v021-2025-01-14)
+  - **Bugfix**: `configuration.py` region adjustment was missing
+- `loadbalancer`: [v0.2.1](services/loadbalancer/CHANGELOG.md#v021-2025-01-14)
+  - **Bugfix**: `configuration.py` region adjustment was missing
+- `logme`: [v0.2.1](services/logme/CHANGELOG.md#v021-2025-01-14)
+  - **Bugfix**: `configuration.py` region adjustment was missing
+- `mariadb`: [v0.2.1](services/mariadb/CHANGELOG.md#v021-2025-01-14)
+  - **Bugfix**: `configuration.py` region adjustment was missing
+- `mongodbflex`: [v0.2.1](services/mongodbflex/CHANGELOG.md#v021-2025-01-14)
+  - **Bugfix**: `configuration.py` region adjustment was missing
+- `objectstorage`: [v0.2.1](services/objectstorage/CHANGELOG.md#v021-2025-01-14)
+  - **Bugfix**: `configuration.py` region adjustment was missing
+
 - `authorization`: [v0.2.0](services/authorization/CHANGELOG.md#v020-2025-01-13)
   - **Breaking Change:**: `get_host_from_settings` returns an error if a region is specified for a global URL.
 - `dns`: [v0.2.0](services/dns/CHANGELOG.md#v020-2025-01-13)

services/authorization/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.2.1 (2025-01-14)
+
+- **Bugfix**: `configuration.py` region adjustment was missing
+
 ## v0.2.0 (2025-01-13)
 
 - **Breaking Change:**: `get_host_from_settings` returns an error if a region is specified for a global URL.

services/authorization/pyproject.toml

@@ -3,7 +3,7 @@ name = "stackit-authorization"
 
 [tool.poetry]
 name = "stackit-authorization"
-version = "v0.2.0"
+version = "v0.2.1"
 authors = [
     "STACKIT Developer Tools <developer-tools@stackit.cloud>",
 ]

services/authorization/src/stackit/authorization/configuration.py

@@ -11,6 +11,8 @@
     Do not edit the class manually.
 """  # noqa: E501 docstring might be too long
 
+import os
+
 
 class HostConfiguration:
     def __init__(
@@ -22,8 +24,15 @@ def __init__(
         server_operation_variables=None,
         ignore_operation_servers=False,
     ) -> None:
-        """Constructor"""
-        self._base_path = "https://authorization.api.stackit.cloud"
+        print(
+            "WARNING: STACKIT will move to a new way of specifying regions, where the region is provided\n",
+            "as a function argument instead of being set in the client configuration.\n"
+            "Once all services have migrated, the methods to specify the region in the client configuration "
+            "will be removed.",
+        )
+        """Constructor
+        """
+        self._base_path = "https://authorization.api.eu01.stackit.cloud"
         """Default Base url
         """
         self.server_index = 0 if server_index is None else server_index
@@ -47,12 +56,13 @@ def get_host_settings(self):
         """
         return [
             {
-                "url": "https://authorization.api.stackit.cloud",
+                "url": "https://authorization.api.{region}stackit.cloud",
                 "description": "No description provided",
                 "variables": {
                     "region": {
                         "description": "No description provided",
-                        "default_value": "global",
+                        "default_value": "eu01.",
+                        "enum_values": ["eu01.", "eu02."],
                     }
                 },
             }
@@ -63,6 +73,7 @@ def get_host_from_settings(self, index, variables=None, servers=None):
         :param index: array index of the host settings
         :param variables: hash of variable and the corresponding value
         :param servers: an array of host settings or None
+        :error: if a region is given for a global url
         :return: URL based on host settings
         """
         if index is None:
@@ -81,8 +92,25 @@ def get_host_from_settings(self, index, variables=None, servers=None):
 
         url = server["url"]
 
+        # check if environment variable was provided for region
+        # if nothing was set this is None
+        region_env = os.environ.get("STACKIT_REGION")
+
         # go through variables and replace placeholders
         for variable_name, variable in server.get("variables", {}).items():
+            # If a region is provided by the user for a global url
+            # return an error (except for providing via environment variable).
+            # The region is provided as a function argument instead of being set in the client configuration.
+            if (
+                variable_name == "region"
+                and (variable["default_value"] == "global" or variable["default_value"] == "")
+                and region_env is None
+                and variables.get(variable_name) is not None
+            ):
+                raise ValueError(
+                    "this API does not support setting a region in the the client configuration, "
+                    "please check if the region can be specified as a function parameter"
+                )
             used_value = variables.get(variable_name, variable["default_value"])
 
             if "enum_values" in variable and used_value not in variable["enum_values"]:

services/certificates/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.2.1 (2025-01-14)
+
+- **Bugfix**: `configuration.py` region adjustment was missing
+
 ## v0.2.0 (2025-01-13)
 
 - **Breaking Change:**: `get_host_from_settings` returns an error if a region is specified for a global URL.

services/certificates/pyproject.toml

@@ -3,7 +3,7 @@ name = "stackit-certificates"
 
 [tool.poetry]
 name = "stackit-certificates"
-version = "v0.2.0"
+version = "v0.2.1"
 authors = [
     "STACKIT Developer Tools <developer-tools@stackit.cloud>",
 ]

services/certificates/src/stackit/certificates/configuration.py

@@ -11,6 +11,8 @@
     Do not edit the class manually.
 """  # noqa: E501 docstring might be too long
 
+import os
+
 
 class HostConfiguration:
     def __init__(
@@ -22,7 +24,14 @@ def __init__(
         server_operation_variables=None,
         ignore_operation_servers=False,
     ) -> None:
-        """Constructor"""
+        print(
+            "WARNING: STACKIT will move to a new way of specifying regions, where the region is provided\n",
+            "as a function argument instead of being set in the client configuration.\n"
+            "Once all services have migrated, the methods to specify the region in the client configuration "
+            "will be removed.",
+        )
+        """Constructor
+        """
         self._base_path = "https://certificates.api.eu01.stackit.cloud"
         """Default Base url
         """
@@ -64,6 +73,7 @@ def get_host_from_settings(self, index, variables=None, servers=None):
         :param index: array index of the host settings
         :param variables: hash of variable and the corresponding value
         :param servers: an array of host settings or None
+        :error: if a region is given for a global url
         :return: URL based on host settings
         """
         if index is None:
@@ -82,8 +92,25 @@ def get_host_from_settings(self, index, variables=None, servers=None):
 
         url = server["url"]
 
+        # check if environment variable was provided for region
+        # if nothing was set this is None
+        region_env = os.environ.get("STACKIT_REGION")
+
         # go through variables and replace placeholders
         for variable_name, variable in server.get("variables", {}).items():
+            # If a region is provided by the user for a global url
+            # return an error (except for providing via environment variable).
+            # The region is provided as a function argument instead of being set in the client configuration.
+            if (
+                variable_name == "region"
+                and (variable["default_value"] == "global" or variable["default_value"] == "")
+                and region_env is None
+                and variables.get(variable_name) is not None
+            ):
+                raise ValueError(
+                    "this API does not support setting a region in the the client configuration, "
+                    "please check if the region can be specified as a function parameter"
+                )
             used_value = variables.get(variable_name, variable["default_value"])
 
             if "enum_values" in variable and used_value not in variable["enum_values"]:

services/dns/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.2.1 (2025-01-14)
+
+- **Bugfix**: `configuration.py` region adjustment was missing
+
 ## v0.2.0 (2025-01-13)
 
 - **Breaking Change:**: `get_host_from_settings` returns an error if a region is specified for a global URL.

services/dns/pyproject.toml

@@ -3,7 +3,7 @@ name = "stackit-dns"
 
 [tool.poetry]
 name = "stackit-dns"
-version = "v0.2.0"
+version = "v0.2.1"
 authors = ["STACKIT Developer Tools <developer-tools@stackit.cloud>"]
 description = "STACKIT DNS API"
 readme = "README.md"

services/dns/src/stackit/dns/configuration.py

@@ -12,6 +12,8 @@
     Do not edit the class manually.
 """  # noqa: E501 docstring might be too long
 
+import os
+
 
 class HostConfiguration:
     def __init__(
@@ -23,7 +25,14 @@ def __init__(
         server_operation_variables=None,
         ignore_operation_servers=False,
     ) -> None:
-        """Constructor"""
+        print(
+            "WARNING: STACKIT will move to a new way of specifying regions, where the region is provided\n",
+            "as a function argument instead of being set in the client configuration.\n"
+            "Once all services have migrated, the methods to specify the region in the client configuration "
+            "will be removed.",
+        )
+        """Constructor
+        """
         self._base_path = "https://dns.api.stackit.cloud"
         """Default Base url
         """
@@ -64,6 +73,7 @@ def get_host_from_settings(self, index, variables=None, servers=None):
         :param index: array index of the host settings
         :param variables: hash of variable and the corresponding value
         :param servers: an array of host settings or None
+        :error: if a region is given for a global url
         :return: URL based on host settings
         """
         if index is None:
@@ -82,8 +92,25 @@ def get_host_from_settings(self, index, variables=None, servers=None):
 
         url = server["url"]
 
+        # check if environment variable was provided for region
+        # if nothing was set this is None
+        region_env = os.environ.get("STACKIT_REGION")
+
         # go through variables and replace placeholders
         for variable_name, variable in server.get("variables", {}).items():
+            # If a region is provided by the user for a global url
+            # return an error (except for providing via environment variable).
+            # The region is provided as a function argument instead of being set in the client configuration.
+            if (
+                variable_name == "region"
+                and (variable["default_value"] == "global" or variable["default_value"] == "")
+                and region_env is None
+                and variables.get(variable_name) is not None
+            ):
+                raise ValueError(
+                    "this API does not support setting a region in the the client configuration, "
+                    "please check if the region can be specified as a function parameter"
+                )
             used_value = variables.get(variable_name, variable["default_value"])
 
             if "enum_values" in variable and used_value not in variable["enum_values"]:

services/iaas/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.2.1 (2025-01-14)
+
+- **Bugfix**: `configuration.py` region adjustment was missing
+
 ## v0.3.0 (2025-01-13)
 
 - **Breaking Change:**: `get_host_from_settings` returns an error if a region is specified for a global URL.

services/iaas/pyproject.toml

@@ -3,7 +3,7 @@ name = "stackit-iaas"
 
 [tool.poetry]
 name = "stackit-iaas"
-version = "v0.3.0"
+version = "v0.3.1"
 authors = [
     "STACKIT Developer Tools <developer-tools@stackit.cloud>",
 ]

services/iaas/src/stackit/iaas/configuration.py

@@ -12,6 +12,8 @@
     Do not edit the class manually.
 """  # noqa: E501 docstring might be too long
 
+import os
+
 
 class HostConfiguration:
     def __init__(
@@ -23,7 +25,14 @@ def __init__(
         server_operation_variables=None,
         ignore_operation_servers=False,
     ) -> None:
-        """Constructor"""
+        print(
+            "WARNING: STACKIT will move to a new way of specifying regions, where the region is provided\n",
+            "as a function argument instead of being set in the client configuration.\n"
+            "Once all services have migrated, the methods to specify the region in the client configuration "
+            "will be removed.",
+        )
+        """Constructor
+        """
         self._base_path = "https://iaas.api.eu01.stackit.cloud"
         """Default Base url
         """
@@ -65,6 +74,7 @@ def get_host_from_settings(self, index, variables=None, servers=None):
         :param index: array index of the host settings
         :param variables: hash of variable and the corresponding value
         :param servers: an array of host settings or None
+        :error: if a region is given for a global url
         :return: URL based on host settings
         """
         if index is None:
@@ -83,8 +93,25 @@ def get_host_from_settings(self, index, variables=None, servers=None):
 
         url = server["url"]
 
+        # check if environment variable was provided for region
+        # if nothing was set this is None
+        region_env = os.environ.get("STACKIT_REGION")
+
         # go through variables and replace placeholders
         for variable_name, variable in server.get("variables", {}).items():
+            # If a region is provided by the user for a global url
+            # return an error (except for providing via environment variable).
+            # The region is provided as a function argument instead of being set in the client configuration.
+            if (
+                variable_name == "region"
+                and (variable["default_value"] == "global" or variable["default_value"] == "")
+                and region_env is None
+                and variables.get(variable_name) is not None
+            ):
+                raise ValueError(
+                    "this API does not support setting a region in the the client configuration, "
+                    "please check if the region can be specified as a function parameter"
+                )
             used_value = variables.get(variable_name, variable["default_value"])
 
             if "enum_values" in variable and used_value not in variable["enum_values"]: