Merge pull request #6 from SchwarzIT/fix/ske-cluster-list

Fix/ske cluster list
SchwarzIT · Sep 30, 2022 · 24c5cf7 · 24c5cf7
2 parents 13b9e06 + 319658a
commit 24c5cf7
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ func main() {
 
 Another usage example can be found in [`terraform-provider-stackit`](https://github.com/SchwarzIT/terraform-provider-stackit) which is built using the community client
 
-[^1]: In order to use the client, a Service Account and Token must be created [using the Service Account API](https://api.stackit.schwarz/service-account/openapi.v1.html#operation/post-projects-projectId-service-accounts-v2)<br />
+[^1]: In order to use the client, a Service Account and Token must be created using [Service Account API](https://api.stackit.schwarz/service-account/openapi.v1.html#operation/post-projects-projectId-service-accounts-v2)<br />
 After creation, assign roles to the Service Account using [Membership API](https://api.stackit.schwarz/membership-service/openapi.v1.html#operation/post-organizations-organizationId-projects-projectId-roles-roleName-service-accounts)<br />
 If your Service Account needs to operate outside the scope of your project, you may need to contact STACKIT to assign further permissions
 

diff --git a/pkg/api/v1/kubernetes/clusters/clusters.go b/pkg/api/v1/kubernetes/clusters/clusters.go
@@ -30,6 +30,11 @@ func New(c common.Client) *KubernetesClusterService {
 // CRUD functionality for SKE clusters
 type KubernetesClusterService common.Service
 
+// ClusterList is the response for listing clusters
+type ClusterList struct {
+	Items []Cluster `json:"items"`
+}
+
 // Cluster is a struct representation of a cluster in STACKIT api
 type Cluster struct {
 	Name        string       `json:"name"` // 11 lowercase letters, numbers, or hyphens
@@ -146,7 +151,7 @@ type Status struct {
 
 // List returns the clusters in the project
 // See also https://api.stackit.schwarz/ske-service/openapi.v1.html#operation/SkeService_ListClusters
-func (svc *KubernetesClusterService) List(ctx context.Context, projectID string) (res []Cluster, err error) {
+func (svc *KubernetesClusterService) List(ctx context.Context, projectID string) (res ClusterList, err error) {
 	req, err := svc.Client.Request(ctx, http.MethodGet, fmt.Sprintf(apiPath, projectID), nil)
 	if err != nil {
 		return

diff --git a/pkg/api/v1/kubernetes/clusters/clusters_test.go b/pkg/api/v1/kubernetes/clusters/clusters_test.go
@@ -8,7 +8,7 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/SchwarzIT/community-stackit-go-client"
+	client "github.com/SchwarzIT/community-stackit-go-client"
 	"github.com/SchwarzIT/community-stackit-go-client/pkg/api/v1/kubernetes"
 	"github.com/SchwarzIT/community-stackit-go-client/pkg/api/v1/kubernetes/clusters"
 	"github.com/SchwarzIT/community-stackit-go-client/pkg/consts"
@@ -256,13 +256,15 @@ func TestKubernetesClusterService_List(t *testing.T) {
 
 	projectID := "5dae0612-f5b1-4615-b7ca-b18796aa7e78"
 	clusterName := "cname"
-	want := []clusters.Cluster{{
-		Name:        clusterName,
-		Kubernetes:  k_ok,
-		Nodepools:   np_ok,
-		Maintenance: m_ok,
-		Hibernation: h_ok,
-	}}
+	want := clusters.ClusterList{
+		Items: []clusters.Cluster{{
+			Name:        clusterName,
+			Kubernetes:  k_ok,
+			Nodepools:   np_ok,
+			Maintenance: m_ok,
+			Hibernation: h_ok,
+		}},
+	}
 
 	mux.HandleFunc("/ske/v1/projects/"+projectID+"/clusters", func(w http.ResponseWriter, r *http.Request) {
 		if r.Method != http.MethodGet {
@@ -286,7 +288,7 @@ func TestKubernetesClusterService_List(t *testing.T) {
 	tests := []struct {
 		name    string
 		args    args
-		wantRes []clusters.Cluster
+		wantRes clusters.ClusterList
 		wantErr bool
 	}{
 		{"ctx is canceled", args{ctx_bad, projectID}, want, true},