Add godoc comments

gravitational · Dec 19, 2024 · 50599b5 · 50599b5
1 parent 421fbcb
commit 50599b5
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/api/client/client.go b/api/client/client.go
@@ -5091,6 +5091,7 @@ func (c *Client) UpsertUserLastSeenNotification(ctx context.Context, req *notifi
 	return rsp, trace.Wrap(err)
 }
 
+// GetWorkloadIdentity returns a workload identity by name.
 func (c *Client) GetWorkloadIdentity(ctx context.Context, name string) (*workloadidentityv1pb.WorkloadIdentity, error) {
 	resp, err := c.WorkloadIdentityResourceServiceClient().GetWorkloadIdentity(ctx, &workloadidentityv1pb.GetWorkloadIdentityRequest{
 		Name: name,
@@ -5101,6 +5102,8 @@ func (c *Client) GetWorkloadIdentity(ctx context.Context, name string) (*workloa
 	return resp, nil
 }
 
+// DeleteWorkloadIdentity deletes a workload identity by name. It will throw an
+// error if the workload identity does not exist.
 func (c *Client) DeleteWorkloadIdentity(ctx context.Context, name string) error {
 	_, err := c.WorkloadIdentityResourceServiceClient().DeleteWorkloadIdentity(ctx, &workloadidentityv1pb.DeleteWorkloadIdentityRequest{
 		Name: name,
@@ -5111,6 +5114,8 @@ func (c *Client) DeleteWorkloadIdentity(ctx context.Context, name string) error
 	return nil
 }
 
+// CreateWorkloadIdentity creates a new workload identity, it will not overwrite
+// an existing workload identity with the same name.
 func (c *Client) CreateWorkloadIdentity(ctx context.Context, r *workloadidentityv1pb.WorkloadIdentity) (*workloadidentityv1pb.WorkloadIdentity, error) {
 	resp, err := c.WorkloadIdentityResourceServiceClient().CreateWorkloadIdentity(ctx, &workloadidentityv1pb.CreateWorkloadIdentityRequest{
 		WorkloadIdentity: r,
@@ -5121,6 +5126,7 @@ func (c *Client) CreateWorkloadIdentity(ctx context.Context, r *workloadidentity
 	return resp, nil
 }
 
+// UpsertWorkloadIdentity creates or updates a workload identity.
 func (c *Client) UpsertWorkloadIdentity(ctx context.Context, r *workloadidentityv1pb.WorkloadIdentity) (*workloadidentityv1pb.WorkloadIdentity, error) {
 	resp, err := c.WorkloadIdentityResourceServiceClient().UpsertWorkloadIdentity(ctx, &workloadidentityv1pb.UpsertWorkloadIdentityRequest{
 		WorkloadIdentity: r,