From 371f601ead5751388cf65d32620a886d56d7019f Mon Sep 17 00:00:00 2001 From: Matteo Olivi Date: Tue, 4 Oct 2022 19:06:47 +0200 Subject: [PATCH] Advertise struct pointer requirement for Create Make it explicit in the function comments that the "obj" argument of the Client interface's Create method must be a struct pointer, because implementers will store in it the object returned by the K8s API server. --- pkg/client/interfaces.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pkg/client/interfaces.go b/pkg/client/interfaces.go index 7f8f8f31c6..10d9057510 100644 --- a/pkg/client/interfaces.go +++ b/pkg/client/interfaces.go @@ -60,7 +60,8 @@ type Reader interface { // Writer knows how to create, delete, and update Kubernetes objects. type Writer interface { - // Create saves the object obj in the Kubernetes cluster. + // Create saves the object obj in the Kubernetes cluster. obj must be a + // struct pointer so that obj can be updated with the content returned by the Server. Create(ctx context.Context, obj Object, opts ...CreateOption) error // Delete deletes the given obj from Kubernetes cluster.