feat(observability): add multi API version support (#5839)

relates to STACKITSDK-346

Co-authored-by: Ruben Hoenle <Ruben.Hoenle@stackit.cloud>

Author: stackit-pipeline

CHANGELOG.md

@@ -212,6 +212,11 @@
   - `v2api`: New package which can be used for communication with the objectstorage v2 API
   - **Deprecation:** The contents in the root of this SDK module including the `wait` package are marked as deprecated and will be removed after 2026-09-30. Switch to the new packages for the available API versions instead.
   - **Dependencies:** Bump STACKIT SDK core module from `v0.21.1` to `v0.22.0`
+- `observability`: [v0.18.0](services/observability/CHANGELOG.md#v0180)
+  - **Feature:** Introduction of multi API version support for the observability SDK module. For more details please see the announcement on GitHub: https://github.com/stackitcloud/stackit-sdk-go/discussions/5062
+  - `v1api`: New package which should be used for communication with the STACKIT observability API in the future
+  - **Deprecation:** The contents in the root of this SDK module including the `wait` package are marked as deprecated and will be removed after 2026-09-30. Switch to the new `v1api` package instead.
+  - **Dependencies:** Bump STACKIT SDK core module from `v0.21.1` to `v0.22.0`
 
 ## Release (2026-02-20)
 - `core`: [v0.21.1](core/CHANGELOG.md#v0211) 

examples/observability/go.mod

@@ -1,9 +1,12 @@
-module github.com/stackitcloud/stackit-sdk-go/examples/argus
+module github.com/stackitcloud/stackit-sdk-go/examples/observability
 
 go 1.21
 
+// This is not needed in production. This is only here to point the golangci linter to the local version instead of the last release on GitHub.
+replace github.com/stackitcloud/stackit-sdk-go/services/observability => ../../services/observability
+
 require (
-	github.com/stackitcloud/stackit-sdk-go/core v0.21.1
+	github.com/stackitcloud/stackit-sdk-go/core v0.22.0
 	github.com/stackitcloud/stackit-sdk-go/services/observability v0.17.0
 )
 

examples/observability/go.sum

@@ -4,7 +4,5 @@ github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
 github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/stackitcloud/stackit-sdk-go/core v0.21.1 h1:Y/PcAgM7DPYMNqum0MLv4n1mF9ieuevzcCIZYQfm3Ts=
-github.com/stackitcloud/stackit-sdk-go/core v0.21.1/go.mod h1:osMglDby4csGZ5sIfhNyYq1bS1TxIdPY88+skE/kkmI=
-github.com/stackitcloud/stackit-sdk-go/services/observability v0.17.0 h1:LGwCvvST0fwUgZ6bOxYIfu45qqTgv421ZS07UhKjZL8=
-github.com/stackitcloud/stackit-sdk-go/services/observability v0.17.0/go.mod h1:9KdrXC5JS30Ay3mR0adb3vNdhca+qxiy/cPF5P4wehQ=
+github.com/stackitcloud/stackit-sdk-go/core v0.22.0 h1:6rViz7GnNwXSh51Lur5xuDzO8EWSZfN9J0HvEkBKq6c=
+github.com/stackitcloud/stackit-sdk-go/core v0.22.0/go.mod h1:osMglDby4csGZ5sIfhNyYq1bS1TxIdPY88+skE/kkmI=

examples/observability/observability.go

@@ -7,7 +7,7 @@ import (
 
 	"github.com/stackitcloud/stackit-sdk-go/core/config"
 	"github.com/stackitcloud/stackit-sdk-go/core/utils"
-	"github.com/stackitcloud/stackit-sdk-go/services/observability"
+	observability "github.com/stackitcloud/stackit-sdk-go/services/observability/v1api"
 )
 
 func main() {
@@ -23,25 +23,25 @@ func main() {
 	}
 
 	// Get the observability instances for your project
-	getInstanceResp, err := observabilityClient.ListInstances(context.Background(), projectId).Execute()
+	getInstanceResp, err := observabilityClient.DefaultAPI.ListInstances(context.Background(), projectId).Execute()
 
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "[Observability API] Error when calling `GetInstances`: %v\n", err)
 	} else {
-		fmt.Printf("[Observability API] Number of instances: %v\n", len(*getInstanceResp.Instances))
+		fmt.Printf("[Observability API] Number of instances: %v\n", len(getInstanceResp.Instances))
 	}
 
 	// Create an observability instance
 	createInstancePayload := observability.CreateInstancePayload{
 		Name:   utils.Ptr("myInstance"),
-		PlanId: utils.Ptr("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"),
+		PlanId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
 	}
 
-	createInstanceResp, err := observabilityClient.CreateInstance(context.Background(), projectId).CreateInstancePayload(createInstancePayload).Execute()
+	createInstanceResp, err := observabilityClient.DefaultAPI.CreateInstance(context.Background(), projectId).CreateInstancePayload(createInstancePayload).Execute()
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "[Observability API] Error when calling `CreateInstance`: %v\n", err)
 		os.Exit(1)
 	}
 
-	fmt.Printf("[Observability API] Created instance with id \"%s\" and dashboard url \"%s\".\n", *createInstanceResp.InstanceId, *createInstanceResp.DashboardUrl)
+	fmt.Printf("[Observability API] Created instance with id \"%s\" and dashboard url \"%s\".\n", createInstanceResp.InstanceId, createInstanceResp.DashboardUrl)
 }

services/observability/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.18.0
+- **Feature:** Introduction of multi API version support for the observability SDK module. For more details please see the announcement on GitHub: https://github.com/stackitcloud/stackit-sdk-go/discussions/5062
+- `v1api`: New package which should be used for communication with the STACKIT observability API in the future
+- **Deprecation:** The contents in the root of this SDK module including the `wait` package are marked as deprecated and will be removed after 2026-09-30. Switch to the new `v1api` package instead.
+- **Dependencies:** Bump STACKIT SDK core module from `v0.21.1` to `v0.22.0`
+
 ## v0.17.0
 - **Feature:** add AlertRecord
     - new related operations: `CreateAlertRecord`, `DeleteAlertRecord`, `DeleteAlertRecords`, `GetAlertRecord`, `ListAlertRecords`, `PartialUpdateAlertRecords`, `UpdateAlertRecord`

services/observability/VERSION

@@ -1 +1 @@
-v0.17.0
+v0.18.0