lint

internal/api/bots.go

@@ -7,21 +7,21 @@ import (
 	"github.com/google/uuid"
 )
 
-// BotsClient is a client for working with Service Accounts
+// BotsClient is a client for working with Service Accounts.
 type BotsClient interface {
 	Get(ctx context.Context, id uuid.UUID) (*Bot, error)
 }
 
 // BotAPIKey represents the nested API Key
-// included in a Service Account response
+// included in a Service Account response.
 type BotAPIKey struct {
 	BaseModel
 	Name       string     `json:"name"`
 	Key        *string    `json:"key"`
 	Expiration *time.Time `json:"expiration"`
 }
 
-// Bot is the base representation of a Service Account
+// Bot is the base representation of a Service Account.
 type Bot struct {
 	BaseModel
 	Name            string     `json:"name"`

internal/client/bots.go

@@ -20,6 +20,8 @@ type BotsClient struct {
 }
 
 // Bots returns a BotsClient.
+//
+//nolint:ireturn // required to support PrefectClient mocking
 func (c *Client) Bots() (api.BotsClient, error) {
 	return &BotsClient{
 		hc:          c.hc,
@@ -28,7 +30,7 @@ func (c *Client) Bots() (api.BotsClient, error) {
 	}, nil
 }
 
-// Get a single bot by ID
+// Get a single bot by ID.
 func (c *BotsClient) Get(ctx context.Context, id uuid.UUID) (*api.Bot, error) {
 	path := fmt.Sprintf("%s/%s", c.routePrefix, id.String())
 	req, err := http.NewRequestWithContext(ctx, http.MethodGet, path, http.NoBody)

internal/provider/datasources/bot.go

@@ -25,7 +25,7 @@ type BotDataSource struct {
 // AccountDataSourceModel defines the Terraform data source model.
 // the TF data source configuration will be unmarsheled into this struct
 // NOTE: the APIKey field is not included in bot fetches and
-// is excluded from this datasource model
+// is excluded from this datasource model.
 type BotDataSourceModel struct {
 	ID      customtypes.UUIDValue      `tfsdk:"id"`
 	Created customtypes.TimestampValue `tfsdk:"created"`
@@ -36,6 +36,10 @@ type BotDataSourceModel struct {
 	AccountRoleName types.String          `tfsdk:"account_role_name"`
 }
 
+// NewBotDataSource returns a new BotDataSource,
+// to be inserted into the provider during instantiation.
+//
+//nolint:ireturn // required by Terraform API
 func NewBotDataSource() datasource.DataSource {
 	return &BotDataSource{}
 }
@@ -115,6 +119,7 @@ func (d *BotDataSource) Read(ctx context.Context, req datasource.ReadRequest, re
 			"Error creating the Bots client",
 			fmt.Sprintf("Could not create Bots client, unexpected error: %s. This is a bug in the provider, please report this to the maintainers.", err.Error()),
 		)
+
 		return
 	}
 
@@ -124,6 +129,7 @@ func (d *BotDataSource) Read(ctx context.Context, req datasource.ReadRequest, re
 			"Failed to fetch Bot and refresh state",
 			fmt.Sprintf("Could not fetch Bot, unexpected error: %s", err.Error()),
 		)
+
 		return
 	}