diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json index d2a287b1fb4..5fea7b63839 100644 --- a/api/openapi-spec/swagger.json +++ b/api/openapi-spec/swagger.json @@ -787,6 +787,7 @@ "type": "string" }, "items": { + "description": "Items holds a list of StorageVersion", "items": { "$ref": "#/definitions/io.k8s.api.apiserverinternal.v1alpha1.StorageVersion" }, @@ -797,7 +798,8 @@ "type": "string" }, "metadata": { - "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta" + "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta", + "description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata" } }, "required": [ diff --git a/hack/.descriptions_failures b/hack/.descriptions_failures index fd6669c3e0c..57feb02e148 100644 --- a/hack/.descriptions_failures +++ b/hack/.descriptions_failures @@ -1,4 +1,3 @@ -./staging/src/k8s.io/api/apiserverinternal/v1alpha1/types.go ./staging/src/k8s.io/api/apps/v1/types.go ./staging/src/k8s.io/api/apps/v1beta1/types.go ./staging/src/k8s.io/api/apps/v1beta2/types.go diff --git a/staging/src/k8s.io/api/apiserverinternal/v1alpha1/generated.proto b/staging/src/k8s.io/api/apiserverinternal/v1alpha1/generated.proto index 539c8c9e2b2..c4506eb9236 100644 --- a/staging/src/k8s.io/api/apiserverinternal/v1alpha1/generated.proto +++ b/staging/src/k8s.io/api/apiserverinternal/v1alpha1/generated.proto @@ -86,9 +86,12 @@ message StorageVersionCondition { // A list of StorageVersions. message StorageVersionList { + // Standard list metadata. + // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // +optional optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; + // Items holds a list of StorageVersion repeated StorageVersion items = 2; } diff --git a/staging/src/k8s.io/api/apiserverinternal/v1alpha1/types.go b/staging/src/k8s.io/api/apiserverinternal/v1alpha1/types.go index 880091b6f82..bfa249e135c 100644 --- a/staging/src/k8s.io/api/apiserverinternal/v1alpha1/types.go +++ b/staging/src/k8s.io/api/apiserverinternal/v1alpha1/types.go @@ -121,7 +121,10 @@ type StorageVersionCondition struct { // A list of StorageVersions. type StorageVersionList struct { metav1.TypeMeta `json:",inline"` + // Standard list metadata. + // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // +optional metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` - Items []StorageVersion `json:"items" protobuf:"bytes,2,rep,name=items"` + // Items holds a list of StorageVersion + Items []StorageVersion `json:"items" protobuf:"bytes,2,rep,name=items"` } diff --git a/staging/src/k8s.io/api/apiserverinternal/v1alpha1/types_swagger_doc_generated.go b/staging/src/k8s.io/api/apiserverinternal/v1alpha1/types_swagger_doc_generated.go index b05c2859543..297ed08a715 100644 --- a/staging/src/k8s.io/api/apiserverinternal/v1alpha1/types_swagger_doc_generated.go +++ b/staging/src/k8s.io/api/apiserverinternal/v1alpha1/types_swagger_doc_generated.go @@ -64,7 +64,9 @@ func (StorageVersionCondition) SwaggerDoc() map[string]string { } var map_StorageVersionList = map[string]string{ - "": "A list of StorageVersions.", + "": "A list of StorageVersions.", + "metadata": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", + "items": "Items holds a list of StorageVersion", } func (StorageVersionList) SwaggerDoc() map[string]string {