changelogs, examples, waiters

Author: rubenhoenle

CHANGELOG.md

@@ -14,6 +14,13 @@
   - **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 `v0api` package instead.
   - **Dependencies:** Bump STACKIT SDK core module from `v0.21.1` to `v0.22.0`
   - **Breaking Change:** Removal of deprecated constants `ActiveState` and `CreatingState` in `wait` package
+- `logs`: [v0.6.0](services/logs/CHANGELOG.md#v060)
+  - **Feature:** Introduction of multi API version support for the logs SDK module. For more details please see the announcement on GitHub: https://github.com/stackitcloud/stackit-sdk-go/discussions/5062
+  - `v1alphaapi`: New package which can be used for communication with the logs v1 alpha API
+  - `v1betaapi`: New package which can be used for communication with the logs v1 beta API
+  - `v1api`: New package which can be used for communication with the logs v1 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`
 
 ## Release (2026-02-20)
 - `core`: [v0.21.1](core/CHANGELOG.md#v0211) 

examples/logs/go.mod

@@ -2,8 +2,11 @@ module github.com/stackitcloud/stackit-sdk-go/examples/logs
 
 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/logs => ../../services/logs
+
 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/logs v0.5.2
 )
 

examples/logs/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/logs v0.5.2 h1:vr4atxFRT+EL+DqONMT5R44f7AzEMbePa9U7PEE0THU=
-github.com/stackitcloud/stackit-sdk-go/services/logs v0.5.2/go.mod h1:CAPsiTX7osAImfrG5RnIjaJ/Iz3QpoBKuH2fS346wuQ=
+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/logs/logs.go

@@ -5,7 +5,7 @@ import (
 	"log"
 
 	"github.com/stackitcloud/stackit-sdk-go/core/utils"
-	"github.com/stackitcloud/stackit-sdk-go/services/logs"
+	logs "github.com/stackitcloud/stackit-sdk-go/services/logs/v1api"
 )
 
 func main() {
@@ -22,60 +22,59 @@ func main() {
 	// Create a Logs Instance
 	var createdInstance string
 	createInstancePayload := logs.CreateLogsInstancePayload{
-		DisplayName:   utils.Ptr("my-logs-instance"),
-		RetentionDays: utils.Ptr(int64(1)),
+		DisplayName:   "my-logs-instance",
+		RetentionDays: int32(1),
 	}
-	createResp, err := client.CreateLogsInstance(ctx, projectId, regionId).
+	createResp, err := client.DefaultAPI.CreateLogsInstance(ctx, projectId, regionId).
 		CreateLogsInstancePayload(createInstancePayload).
 		Execute()
 	if err != nil {
 		log.Fatalf("[Logs API] Error when calling `CreateLogsInstance`: %v\n", err)
 	}
-	createdInstance = *createResp.Id
-	log.Printf("[Logs API] Created Logs Instance with ID \"%s\".\n", createdInstance)
+	log.Printf("[Logs API] Created Logs Instance with ID \"%s\".\n", createResp.Id)
 
 	// List Logs Instances
-	listResp, err := client.ListLogsInstances(ctx, projectId, regionId).Execute()
+	listResp, err := client.DefaultAPI.ListLogsInstances(ctx, projectId, regionId).Execute()
 	if err != nil {
 		log.Fatalf("[Logs API] Error when calling `ListLogsInstances`: %v\n", err)
 	}
-	log.Printf("[Logs API] Retrieved %d Logs Instances.\n", len(*listResp.Instances))
+	log.Printf("[Logs API] Retrieved %d Logs Instances.\n", len(listResp.Instances))
 
 	// Get the created Logs Instance
-	getResp, err := client.GetLogsInstance(ctx, projectId, regionId, createdInstance).Execute()
+	getResp, err := client.DefaultAPI.GetLogsInstance(ctx, projectId, regionId, createdInstance).Execute()
 	if err != nil {
 		log.Fatalf("[Logs API] Error when calling `GetLogsInstance`: %v\n", err)
 	}
-	log.Printf("[Logs API] Retrieved Logs Instance with ID \"%s\" and Display Name \"%s\".\n", *getResp.Id, *getResp.DisplayName)
+	log.Printf("[Logs API] Retrieved Logs Instance with ID \"%s\" and Display Name \"%s\".\n", getResp.Id, getResp.DisplayName)
 
 	// Update the created Logs Instance
 	updatePayload := logs.UpdateLogsInstancePayload{
 		DisplayName:   utils.Ptr("my-updated-logs-instance"),
-		RetentionDays: utils.Ptr(int64(7)),
+		RetentionDays: utils.Ptr(int32(7)),
 	}
-	updateResp, err := client.UpdateLogsInstance(ctx, projectId, regionId, createdInstance).
+	updateResp, err := client.DefaultAPI.UpdateLogsInstance(ctx, projectId, regionId, createdInstance).
 		UpdateLogsInstancePayload(updatePayload).
 		Execute()
 	if err != nil {
 		log.Fatalf("[Logs API] Error when calling `UpdateLogsInstance`: %v\n", err)
 	}
-	log.Printf("[Logs API] Updated Logs Instance with ID \"%s\" to Display Name \"%s\".\n", *updateResp.Id, *updateResp.DisplayName)
+	log.Printf("[Logs API] Updated Logs Instance with ID \"%s\" to Display Name \"%s\".\n", updateResp.Id, updateResp.DisplayName)
 
 	// Create an Access Token
 	createTokenPayload := logs.CreateAccessTokenPayload{
-		DisplayName: utils.Ptr("my-access-token"),
-		Permissions: &[]string{"read"},
+		DisplayName: "my-access-token",
+		Permissions: []string{"read"},
 	}
-	createTokenResp, err := client.CreateAccessToken(ctx, projectId, regionId, createdInstance).
+	createTokenResp, err := client.DefaultAPI.CreateAccessToken(ctx, projectId, regionId, createdInstance).
 		CreateAccessTokenPayload(createTokenPayload).
 		Execute()
 	if err != nil {
 		log.Fatalf("[Logs API] Error when calling `CreateAccessToken`: %v\n", err)
 	}
-	log.Printf("[Logs API] Created Access Token with ID \"%s\".\n", *createTokenResp.Id)
+	log.Printf("[Logs API] Created Access Token with ID \"%s\".\n", createTokenResp.Id)
 
 	// Add Access Token to Logs Instance
-	err = client.UpdateAccessToken(ctx, projectId, regionId, createdInstance, *createTokenResp.Id).
+	err = client.DefaultAPI.UpdateAccessToken(ctx, projectId, regionId, createdInstance, createTokenResp.Id).
 		// needs at least an empty payload
 		UpdateAccessTokenPayload(logs.UpdateAccessTokenPayload{}).
 		Execute()
@@ -84,14 +83,14 @@ func main() {
 	}
 
 	// Delete all Access Tokens from Logs Instance
-	tokenList, err := client.DeleteAllAccessTokens(ctx, projectId, regionId, createdInstance).Execute()
+	tokenList, err := client.DefaultAPI.DeleteAllAccessTokens(ctx, projectId, regionId, createdInstance).Execute()
 	if err != nil {
 		log.Fatalf("[Logs API] Error when calling `DeleteAllAccessTokens`: %v\n", err)
 	}
-	log.Printf("[Logs API] Deleted %d Access Tokens from Logs Instance with ID \"%s\".\n", len(*tokenList.Tokens), createdInstance)
+	log.Printf("[Logs API] Deleted %d Access Tokens from Logs Instance with ID \"%s\".\n", len(tokenList.Tokens), createdInstance)
 
 	// Delete the created Logs Instance
-	err = client.DeleteLogsInstance(ctx, projectId, regionId, createdInstance).Execute()
+	err = client.DefaultAPI.DeleteLogsInstance(ctx, projectId, regionId, createdInstance).Execute()
 	if err != nil {
 		log.Fatalf("[Logs API] Error when calling `DeleteLogsInstance`: %v\n", err)
 	}

services/logs/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v0.6.0
+- **Feature:** Introduction of multi API version support for the logs SDK module. For more details please see the announcement on GitHub: https://github.com/stackitcloud/stackit-sdk-go/discussions/5062
+- `v1alphaapi`: New package which can be used for communication with the logs v1 alpha API
+- `v1betaapi`: New package which can be used for communication with the logs v1 beta API
+- `v1api`: New package which can be used for communication with the logs v1 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`
+
 ## v0.5.2
 - Bump STACKIT SDK core module from `v0.21.0` to `v0.21.1`
 

services/logs/VERSION

@@ -1 +1 @@
-v0.5.2
+v0.6.0

services/logs/v1api/wait/wait.go

@@ -0,0 +1,55 @@
+package wait
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"net/http"
+	"time"
+
+	"github.com/stackitcloud/stackit-sdk-go/core/oapierror"
+	"github.com/stackitcloud/stackit-sdk-go/core/wait"
+	logs "github.com/stackitcloud/stackit-sdk-go/services/logs/v1api"
+)
+
+const (
+	instanceStatusActive   = "active"
+	instanceStatusDeleting = "deleting"
+)
+
+func CreateLogsInstanceWaitHandler(ctx context.Context, client logs.DefaultAPI, projectID, region, instanceID string) *wait.AsyncActionHandler[logs.LogsInstance] {
+	handler := wait.New(func() (waitFinished bool, response *logs.LogsInstance, err error) {
+		instance, err := client.GetLogsInstance(ctx, projectID, region, instanceID).Execute()
+		if err != nil {
+			return false, nil, err
+		}
+		if instance.Id == instanceID && instance.Status == instanceStatusActive {
+			return true, instance, nil
+		}
+		if instance.Status == instanceStatusDeleting {
+			return true, nil, fmt.Errorf("creating log instance failed, instance is being deleted")
+		}
+		return false, nil, nil
+	})
+	handler.SetTimeout(10 * time.Minute)
+	return handler
+}
+
+func DeleteLogsInstanceWaitHandler(ctx context.Context, client logs.DefaultAPI, projectID, region, instanceID string) *wait.AsyncActionHandler[logs.LogsInstance] {
+	handler := wait.New(func() (waitFinished bool, response *logs.LogsInstance, err error) {
+		_, err = client.GetLogsInstance(ctx, projectID, region, instanceID).Execute()
+		// the instances is still gettable, e.g. not deleted, when the errors is null
+		if err == nil {
+			return false, nil, nil
+		}
+		var oapiError *oapierror.GenericOpenAPIError
+		if errors.As(err, &oapiError) {
+			if statusCode := oapiError.StatusCode; statusCode == http.StatusNotFound {
+				return true, nil, nil
+			}
+		}
+		return false, nil, err
+	})
+	handler.SetTimeout(10 * time.Minute)
+	return handler
+}

services/logs/v1api/wait/wait_test.go

@@ -0,0 +1,175 @@
+package wait
+
+import (
+	"context"
+	"net/http"
+	"testing"
+	"time"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/google/uuid"
+	"github.com/stackitcloud/stackit-sdk-go/core/oapierror"
+	"github.com/stackitcloud/stackit-sdk-go/core/utils"
+	logs "github.com/stackitcloud/stackit-sdk-go/services/logs/v1api"
+)
+
+type mockSettings struct {
+	getFails        bool
+	returnInstance  bool
+	statusCode      int
+	getLogsResponse *logs.LogsInstance
+}
+
+func newAPIMock(settings mockSettings) logs.DefaultAPI {
+	return &logs.DefaultAPIServiceMock{
+		GetLogsInstanceExecuteMock: utils.Ptr(func(_ logs.ApiGetLogsInstanceRequest) (*logs.LogsInstance, error) {
+			if settings.getFails {
+				return nil, &oapierror.GenericOpenAPIError{
+					StatusCode: settings.statusCode,
+				}
+			}
+			if !settings.returnInstance {
+				return nil, nil
+			}
+			return settings.getLogsResponse, nil
+		}),
+	}
+}
+
+var projectId = uuid.NewString()
+var instanceId = uuid.NewString()
+
+const region = "eu01"
+
+func TestCreateLogsInstanceWaitHandler(t *testing.T) {
+	tests := []struct {
+		description     string
+		getFails        bool
+		wantErr         bool
+		wantResp        bool
+		returnInstance  bool
+		getLogsResponse *logs.LogsInstance
+	}{
+		{
+			description:    "create succeeded",
+			getFails:       false,
+			wantErr:        false,
+			wantResp:       true,
+			returnInstance: true,
+			getLogsResponse: &logs.LogsInstance{
+				Id:     instanceId,
+				Status: instanceStatusActive,
+			},
+		},
+		{
+			description:    "create failed with error",
+			getFails:       true,
+			wantErr:        true,
+			wantResp:       false,
+			returnInstance: true,
+			getLogsResponse: &logs.LogsInstance{
+				Id:     instanceId,
+				Status: instanceStatusActive,
+			},
+		},
+		{
+			description:    "create without id",
+			getFails:       false,
+			wantErr:        true,
+			wantResp:       false,
+			returnInstance: true,
+			getLogsResponse: &logs.LogsInstance{
+				Status: instanceStatusActive,
+			},
+		},
+		{
+			description:    "create without status",
+			getFails:       false,
+			wantErr:        true,
+			wantResp:       false,
+			returnInstance: true,
+			getLogsResponse: &logs.LogsInstance{
+				Id: instanceId,
+			},
+		},
+		{
+			description:    "instance deleting",
+			getFails:       false,
+			wantErr:        true,
+			wantResp:       false,
+			returnInstance: true,
+			getLogsResponse: &logs.LogsInstance{
+				Id:     instanceId,
+				Status: instanceStatusDeleting,
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			client := newAPIMock(mockSettings{
+				getFails:        tt.getFails,
+				getLogsResponse: tt.getLogsResponse,
+				returnInstance:  tt.returnInstance,
+			})
+
+			var instanceWanted *logs.LogsInstance
+			if tt.wantResp {
+				instanceWanted = tt.getLogsResponse
+			}
+
+			handler := CreateLogsInstanceWaitHandler(context.Background(), client, projectId, region, instanceId)
+
+			response, err := handler.SetTimeout(10 * time.Millisecond).WaitWithContext(context.Background())
+
+			if (err != nil) != tt.wantErr {
+				t.Fatalf("handler error = %v, wantErr %v", err, tt.wantErr)
+			}
+			if !cmp.Equal(response, instanceWanted) {
+				t.Fatalf("handler gotRes = %v, want %v", response, instanceWanted)
+			}
+		})
+	}
+}
+
+func TestDeleteLogsInstanceWaitHandler(t *testing.T) {
+	tests := []struct {
+		description string
+		getFails    bool
+		wantErr     bool
+		statusCode  int
+	}{
+		{
+			description: "delete succeeded",
+			getFails:    true,
+			statusCode:  http.StatusNotFound,
+		},
+		{
+			description: "delete failed with error",
+			getFails:    true,
+			wantErr:     true,
+			statusCode:  http.StatusInternalServerError,
+		},
+		{
+			description: "delete still in progress",
+			getFails:    false,
+			wantErr:     true,
+			statusCode:  http.StatusOK,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			client := newAPIMock(mockSettings{
+				getFails:        tt.getFails,
+				returnInstance:  false,
+				statusCode:      tt.statusCode,
+				getLogsResponse: nil,
+			})
+
+			handler := DeleteLogsInstanceWaitHandler(context.Background(), client, projectId, region, instanceId)
+			_, err := handler.SetTimeout(10 * time.Millisecond).WaitWithContext(context.Background())
+			if (err != nil) != tt.wantErr {
+				t.Fatalf("handler error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}