feat: generalized openapi error constructors, which introduces new core version

Author: bahkauv70

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## Release (2025-XX-YY)
-- `alb`: [v0.2.0](services/alb/CHANGELOG.md#v011-2025-03-20)
+- `core`: [0.17.0](core/CHANGELOG.md#v0170-2025-03-20)
+  - **New:** Helper functions for generic openapi error codes
+- `alb`: [v0.2.0](services/alb/CHANGELOG.md#v020-2025-03-20)
   - **New:** API for application load balancer
 - `cdn`: [v0.1.0](services/cdn/CHANGELOG.md#v010-2025-03-19)
   - **New:** Introduce new API for content delivery

core/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.17.0 (2025-03-20)
+
+- **New:** Helper functions for generic openapi error codes
+
 ## v0.16.1 (2025-02-25)
 
 - **Bugfix:** STACKIT_PRIVATE_KEY and STACKIT_SERVICE_ACCOUNT_KEY can be set via environment variable or via credentials file.

core/oapierror/oapierror.go

@@ -19,6 +19,23 @@ type GenericOpenAPIError struct {
 	Model        interface{}
 }
 
+func NewError(code int, status string) *GenericOpenAPIError {
+	return &GenericOpenAPIError{
+		StatusCode:   code,
+		ErrorMessage: status,
+		Model:        map[string]any{},
+	}
+}
+
+func NewErrorWithBody(code int, status string, body []byte, model any) *GenericOpenAPIError {
+	return &GenericOpenAPIError{
+		StatusCode:   code,
+		ErrorMessage: status,
+		Body:         body,
+		Model:        model,
+	}
+}
+
 // Error returns non-empty string if there was an errorMessage.
 func (e GenericOpenAPIError) Error() string {
 	// Prevent panic in case of negative value

services/alb/wait/wait_test.go

@@ -116,13 +116,6 @@ func TestCreateOrUpdateLoadbalancerWaitHandler(t *testing.T) {
 		})
 	}
 }
-func httpStatus(code int, status string) *oapierror.GenericOpenAPIError {
-	return &oapierror.GenericOpenAPIError{
-		StatusCode:   code,
-		ErrorMessage: status,
-		Model:        map[string]any{},
-	}
-}
 
 func TestDeleteLoadbalancerWaitHandler(t *testing.T) {
 	tests := []struct {
@@ -133,7 +126,7 @@ func TestDeleteLoadbalancerWaitHandler(t *testing.T) {
 		{
 			"Delete with '404' succeeded immediately",
 			[]response{
-				{nil, httpStatus(http.StatusNotFound, "not found")},
+				{nil, oapierror.NewError(http.StatusNotFound, "not found")},
 			},
 			false,
 		},
@@ -143,14 +136,14 @@ func TestDeleteLoadbalancerWaitHandler(t *testing.T) {
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
-				{nil, httpStatus(http.StatusNotFound, "not found")},
+				{nil, oapierror.NewError(http.StatusNotFound, "not found")},
 			},
 			false,
 		},
 		{
 			"Delete with 'gone' succeeded immediately",
 			[]response{
-				{nil, httpStatus(http.StatusGone, "gone")},
+				{nil, oapierror.NewError(http.StatusGone, "gone")},
 			},
 			false,
 		},
@@ -160,7 +153,7 @@ func TestDeleteLoadbalancerWaitHandler(t *testing.T) {
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
-				{nil, httpStatus(http.StatusGone, "not found")},
+				{nil, oapierror.NewError(http.StatusGone, "not found")},
 			},
 			false,
 		},
@@ -170,7 +163,7 @@ func TestDeleteLoadbalancerWaitHandler(t *testing.T) {
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
-				{&alb.LoadBalancer{Status: utils.Ptr(string(StatusError))}, httpStatus(http.StatusInternalServerError, "kapow")},
+				{&alb.LoadBalancer{Status: utils.Ptr(string(StatusError))}, oapierror.NewError(http.StatusInternalServerError, "kapow")},
 			},
 			true,
 		},
@@ -180,7 +173,7 @@ func TestDeleteLoadbalancerWaitHandler(t *testing.T) {
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
 				{&alb.LoadBalancer{Status: utils.Ptr(StatusPending)}, nil},
-				{&alb.LoadBalancer{Status: utils.Ptr(string(StatusError))}, httpStatus(http.StatusOK, "ok")},
+				{&alb.LoadBalancer{Status: utils.Ptr(string(StatusError))}, oapierror.NewError(http.StatusOK, "ok")},
 			},
 			true,
 		},