Add comments to Space struct members

bonsai/space.go

@@ -17,16 +17,24 @@ const (
 // CloudProvider contains details about the cloud provider and region
 // attributes.
 type CloudProvider struct {
+	// A machine-readable name for the cloud provider in which this space is
+	// deployed.
 	Provider string `json:"provider"`
-	Region   string `json:"region"`
+	// A machine-readable name for the geographic region of the server group.
+	Region string `json:"region"`
 }
 
 // Space represents the server groups and geographic regions available to their
 // account, where clusters may be provisioned.
 type Space struct {
-	Path           string        `json:"path"`
-	PrivateNetwork bool          `json:"private_network"`
-	Cloud          CloudProvider `json:"cloud,omitempty"`
+	// A machine-readable name for the server group.
+	Path string `json:"path"`
+	// Indicates whether the space is isolated and inaccessible from the
+	// public Internet. A VPC connection will be needed to communicate
+	// with a private cluster.
+	PrivateNetwork bool `json:"private_network"`
+	// Details about the cloud provider and region attributes.
+	Cloud CloudProvider `json:"cloud,omitempty"`
 
 	// The geographic region in which the cluster is running.
 	Region string `json:"region,omitempty"`
@@ -125,7 +133,7 @@ func (c *SpaceClient) All(ctx context.Context) ([]Space, error) {
 		return allResults, fmt.Errorf("client.all failed: %w", err)
 	}
 
-	return allResults, err
+	return allResults, err //nolint:nolintlint
 }
 
 //nolint:dupl // Allow duplicated code blocks in code paths that may change