Region adjustment

STACKIT will move to a new way of specifying regions with v1.
Instead of providing the region in the URL directly it is provided via path parameter.
Once all services have migrated, the methods to specify the region in the client
configuration will be removed.

Signed-off-by: Alexander Dahmen <[email protected]>

Author: Fyusel

core/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.15.0 (2025-01-02)
+
+- **Breaking Change:**: `ConfigureRegion` returns an error if a region is specified for a global URL.
+
+STACKIT will move to a new way of specifying regions with v1. Instead of providing the region in the URL directly it is provided via path parameter. Once all services have migrated, the methods to specify the region in the client configuration will be removed.
+
 ## v0.14.0 (2024-10-10)
 
 - **Feature:**: Added `IntermediateStateReached` to `AsyncActionHandler` that can be used to check for an intermediate state when executing the wait function of a wait handler.

core/config/config.go

@@ -478,7 +478,10 @@ func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint strin
 // ConfigureRegion configures the API server urls with the user specified region.
 // Does nothing if a custom endpoint is provided.
 // Throws an error if no region is given or if the region is not valid
+// Throws an error if a region is given for a global url.
 func ConfigureRegion(cfg *Configuration) error {
+	fmt.Println("Warning: STACKIT will move to a new way of specifying regions with v1. Instead of providing the region in the URL directly it is provided via path parameter." +
+		" Once all services have migrated, the methods to specify the region in the client configuration will be removed.")
 	if cfg.setCustomEndpoint {
 		return nil
 	}
@@ -519,13 +522,16 @@ func ConfigureRegion(cfg *Configuration) error {
 		// Region is not available.
 		return fmt.Errorf("the provided region is not available for this API, available regions are: %s", availableRegions)
 	}
-	// Global API. The provided region is ignored.
-	// If the url is a template, generated using deprecated config.json, the region variable is replaced
-	// If the url is already configured, there is no region variable and it remains the same
-	cfgUrl := strings.Replace(servers[0].URL, "{region}", "", -1)
+
+	// Global API. If a region is provided return an error.
+	// The region is not part of the url anymore instead the region is provided via path parameter.
+	if strings.Contains(servers[0].URL, "{region}") {
+		return fmt.Errorf("a region was provided in the url for a global api but has to be specified in the individual methods; STACKIT will move to a new way of specifying regions with v1")
+	}
+
 	cfg.Servers = ServerConfigurations{
 		{
-			URL:         cfgUrl,
+			URL:         servers[0].URL,
 			Description: servers[0].Description,
 		},
 	}

core/config/config_test.go

@@ -41,7 +41,7 @@ func TestConfigureRegion(t *testing.T) {
 			isValid: true,
 		},
 		{
-			desc: "valid_deprecated_global",
+			desc: "invalid_global_with_region",
 			cfg: &Configuration{
 				Region: "",
 				Servers: ServerConfigurations{
@@ -56,13 +56,9 @@ func TestConfigureRegion(t *testing.T) {
 					},
 				},
 			},
-			regionEnvVar: "",
-			expectedServers: ServerConfigurations{
-				ServerConfiguration{
-					URL: "https://some-api.api.stackit.cloud",
-				},
-			},
-			isValid: true,
+			regionEnvVar:    "",
+			expectedServers: nil,
+			isValid:         false,
 		},
 		{
 			desc: "valid_global_empty_default",
@@ -113,7 +109,7 @@ func TestConfigureRegion(t *testing.T) {
 			isValid: true,
 		},
 		{
-			desc: "valid_deprecated_global_with_specified_region",
+			desc: "invalid_deprecated_global_with_specified_region",
 			cfg: &Configuration{
 				Region: "eu01",
 				Servers: ServerConfigurations{
@@ -128,13 +124,9 @@ func TestConfigureRegion(t *testing.T) {
 					},
 				},
 			},
-			regionEnvVar: "",
-			expectedServers: ServerConfigurations{
-				ServerConfiguration{
-					URL: "https://some-api.api.stackit.cloud",
-				},
-			},
-			isValid: true,
+			regionEnvVar:    "",
+			expectedServers: nil,
+			isValid:         false,
 		},
 		{
 			desc: "env_var_valid_region",