chore: append comments for modified Validator and CustomValidator

Signed-off-by: STRRL <[email protected]>

Author: STRRL

pkg/webhook/admission/validator.go

@@ -28,11 +28,25 @@ import (
 )
 
 // Validator defines functions for validating an operation.
+// The custom resource kind which implements this interface can validate itself.
+// To validate the custom resource with another specific struct, use CustomValidator instead.
 type Validator interface {
 	runtime.Object
-	ValidateCreate() ([]string, error)
-	ValidateUpdate(old runtime.Object) ([]string, error)
-	ValidateDelete() ([]string, error)
+
+	// ValidateCreate validates the object on creation.
+	// The optional warnings will be added to the response as warning messages.
+	// Return an error if the object is invalid.
+	ValidateCreate() (warnings []string, err error)
+
+	// ValidateUpdate validates the object on update. The oldObj is the object before the update.
+	// The optional warnings will be added to the response as warning messages.
+	// Return an error if the object is invalid.
+	ValidateUpdate(old runtime.Object) (warnings []string, err error)
+
+	// ValidateDelete validates the object on deletion.
+	// The optional warnings will be added to the response as warning messages.
+	// Return an error if the object is invalid.
+	ValidateDelete() (warnings []string, err error)
 }
 
 // ValidatingWebhookFor creates a new Webhook for validating the provided type.

pkg/webhook/admission/validator_custom.go

@@ -28,10 +28,23 @@ import (
 )
 
 // CustomValidator defines functions for validating an operation.
+// The object to be validated is passed into methods as a parameter.
 type CustomValidator interface {
-	ValidateCreate(ctx context.Context, obj runtime.Object) ([]string, error)
-	ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) ([]string, error)
-	ValidateDelete(ctx context.Context, obj runtime.Object) ([]string, error)
+
+	// ValidateCreate validates the object on creation.
+	// The optional warnings will be added to the response as warning messages.
+	// Return an error if the object is invalid.
+	ValidateCreate(ctx context.Context, obj runtime.Object) (warnings []string, err error)
+
+	// ValidateUpdate validates the object on update.
+	// The optional warnings will be added to the response as warning messages.
+	// Return an error if the object is invalid.
+	ValidateUpdate(ctx context.Context, oldObj, newObj runtime.Object) (warnings []string, err error)
+
+	// ValidateDelete validates the object on deletion.
+	// The optional warnings will be added to the response as warning messages.
+	// Return an error if the object is invalid.
+	ValidateDelete(ctx context.Context, obj runtime.Object) (warnings []string, err error)
 }
 
 // WithCustomValidator creates a new Webhook for validating the provided type.