Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix golint errors by adding definition comments for pkg/apis/apiserverinternal #95502

Merged
merged 1 commit into from Oct 20, 2020
Merged

Fix golint errors by adding definition comments for pkg/apis/apiserverinternal #95502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion hack/.golint_failures
View file
Open in desktop
Expand Up @@ -8,7 +8,6 @@ pkg/apis/abac/v1beta1
pkg/apis/admission
pkg/apis/admissionregistration/v1
pkg/apis/admissionregistration/v1beta1
pkg/apis/apiserverinternal
pkg/apis/apps/v1
pkg/apis/apps/v1beta1
pkg/apis/apps/v1beta2
Expand Down
21 changes: 13 additions & 8 deletions pkg/apis/apiserverinternal/types.go
View file
Open in desktop
Expand Up @@ -22,7 +22,7 @@ import (

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// Storage version of a specific resource.
// StorageVersion of a specific resource.
type StorageVersion struct {
metav1.TypeMeta
// The name is <group>.<resource>.
Expand All @@ -39,7 +39,7 @@ type StorageVersion struct {
// StorageVersionSpec is an empty spec.
type StorageVersionSpec struct{}

// API server instances report the versions they can decode and the version they
// StorageVersionStatus API server instances report the versions they can decode and the version they
// encode objects to when persisting objects in the backend.
type StorageVersionStatus struct {
// The reported versions per API server instance.
Expand All @@ -57,7 +57,7 @@ type StorageVersionStatus struct {
Conditions []StorageVersionCondition
}

// An API server instance reports the version it can decode and the version it
// ServerStorageVersion An API server instance reports the version it can decode and the version it
// encodes objects to when persisting objects in the backend.
type ServerStorageVersion struct {
// The ID of the reporting API server.
Expand All @@ -72,22 +72,27 @@ type ServerStorageVersion struct {
DecodableVersions []string
}

// StorageVersionConditionType Indicates the storage version condition type
type StorageVersionConditionType string

const (
// Indicates that encoding storage versions reported by all servers are equal.
//AllEncodingVersionsEqual Indicates that encoding storage versions reported by all servers are equal.
AllEncodingVersionsEqual StorageVersionConditionType = "AllEncodingVersionsEqual"
)

// ConditionStatus indicates status of condition from "True", "False", or "Unknown"
type ConditionStatus string

const (
ConditionTrue ConditionStatus = "True"
ConditionFalse ConditionStatus = "False"
// ConditionTrue indicates condition as "True"
ConditionTrue ConditionStatus = "True"
// ConditionFalse indicates condition as "False"
ConditionFalse ConditionStatus = "False"
// ConditionUnknown indicates condition as "Unknown"
ConditionUnknown ConditionStatus = "Unknown"
)

// Describes the state of the storageVersion at a certain point.
// StorageVersionCondition Describes the state of the storageVersion at a certain point.
type StorageVersionCondition struct {
// Type of the condition.
// +optional
Expand All @@ -111,7 +116,7 @@ type StorageVersionCondition struct {

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// A list of StorageVersions.
// StorageVersionList A list of StorageVersions.
type StorageVersionList struct {
metav1.TypeMeta
// +optional
Expand Down