Skip to content

Commit

Permalink
Merge pull request #127 from phisco/space-backups-descriptions
Browse files Browse the repository at this point in the history
docs: fix space backups docs leftovers
  • Loading branch information
phisco authored Nov 20, 2024
2 parents e9cd7fc + 2bc5f5d commit 0dc3c64
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions apis/admin/v1alpha1/spacebackup_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import (
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
// +kubebuilder:resource:scope=Cluster,categories=spaces

// SpaceBackup represents a single backup of a ControlPlane.
// SpaceBackup represents a backup of a Space.
type SpaceBackup struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Expand Down Expand Up @@ -61,9 +61,9 @@ type SpaceBackupSpec struct {

// SpaceBackupDefinition defines all the parameters for a space backup.
type SpaceBackupDefinition struct {
// ConfigRef is a reference to the backup configuration.
// ConfigRef is a reference to the space backup configuration.
// ApiGroup is optional and defaults to "spaces.upbound.io".
// Kind is required, and the only supported value is "SharedBackupConfig" at
// Kind is required, and the only supported value is "SpaceBackupConfig" at
// the moment.
// Name is required.
// +kubebuilder:validation:Required
Expand Down Expand Up @@ -140,7 +140,7 @@ type GenericSpaceBackupResourceSelector struct {
spacesv1alpha1.ResourceSelector `json:",inline"`
}

// SpaceBackupStatus represents the observed state of a Backup.
// SpaceBackupStatus represents the observed state of a SpaceBackup.
type SpaceBackupStatus struct {
xpv1.ResourceStatus `json:",inline"`

Expand Down
2 changes: 1 addition & 1 deletion apis/admin/v1alpha1/spacebackupschedule_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const SpaceBackupScheduleLabelKey = "admin.spaces.upbound.io/spacebackupschedule
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
// +kubebuilder:resource:scope=Cluster,categories=spaces

// SpaceBackupSchedule represents a single ControlPlane schedule for Backups.
// SpaceBackupSchedule represents a schedule to backup a Space.
type SpaceBackupSchedule struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Expand Down

0 comments on commit 0dc3c64

Please sign in to comment.