Skip to content

Commit

Permalink
Update space and cluster comment on URI/description
Browse files Browse the repository at this point in the history
  • Loading branch information
momer committed May 15, 2024
1 parent dcd3baf commit f597910
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions bonsai/cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ type ClusterStats struct {

// ClusterAccess holds information about connecting to the cluster.
type ClusterAccess struct {
// Host name of the cluster
// Host name of the cluster.
Host string `json:"host"`
// HTTP Port the cluster is running on.
Port int `json:"port"`
Expand Down Expand Up @@ -67,19 +67,20 @@ const (
ClusterStateUpdatingPlan ClusterState = "UPDATING PLAN"
)

// Cluster represents a subscription cluster.
// Cluster represents a single cluster on your account.
type Cluster struct {
// Slug represents a unique, machine-readable name for the cluster.
// A cluster slug is based its name at creation, to which a random integer
// is concatenated.
Slug string `json:"slug"`
// Name is the human-readable name of the cluster.
Name string `json:"name"`
// URI is a machine-readable name for the cluster.
// URI is a link to additional information about this cluster.
URI string `json:"uri"`

// Plan holds some information about the cluster's current subscription plan.
Plan Plan `json:"plan"`

// Release holds some information about the cluster's current release.
Release Release `json:"release"`

Expand Down Expand Up @@ -282,7 +283,7 @@ func (c *ClusterClient) list(ctx context.Context, opt clusterListOpts) (
return results.Clusters, resp, nil
}

// All lists all Clusters from the Clusters API.
// All lists all active clusters on your account.
func (c *ClusterClient) All(ctx context.Context) ([]Cluster, error) {
var (
err error
Expand Down
2 changes: 1 addition & 1 deletion bonsai/space.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ type Space struct {

// The geographic region in which the cluster is running.
Region string `json:"region,omitempty"`
// A URI to retrieve more information about this Release.
// A URI to retrieve more information about this Space.
URI string `json:"uri,omitempty"`
}

Expand Down

0 comments on commit f597910

Please sign in to comment.