github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-11-04 07:49:35 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #101687 from siddhartha97/add-feature

Browse Source 
Ensures Authentication types have descriptions
This commit is contained in:
Kubernetes Prow Robot
2021-05-03 13:00:09 -07:00
committed by GitHub
parent 576f0eb0b4 4425fd6bfe
commit 55635497d3
8 changed files with 42 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
api/openapi-spec/swagger.json generated
View File

@@ -1797,13 +1797,16 @@
"type": "string"
},
"metadata": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta",
"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/io.k8s.api.authentication.v1.TokenRequestSpec"
"$ref": "#/definitions/io.k8s.api.authentication.v1.TokenRequestSpec",
"description": "Spec holds information about the request being evaluated"
},
"status": {
"$ref": "#/definitions/io.k8s.api.authentication.v1.TokenRequestStatus"
"$ref": "#/definitions/io.k8s.api.authentication.v1.TokenRequestStatus",
"description": "Status is filled in by the server and indicates whether the token can be authenticated."
}
},
"required": [
@@ -1873,7 +1876,8 @@
"type": "string"
},
"metadata": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta",
"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/io.k8s.api.authentication.v1.TokenReviewSpec",
@@ -1981,7 +1985,8 @@
"type": "string"
},
"metadata": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta",
"description": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"$ref": "#/definitions/io.k8s.api.authentication.v1beta1.TokenReviewSpec",
@@ -1989,7 +1994,7 @@
},
"status": {
"$ref": "#/definitions/io.k8s.api.authentication.v1beta1.TokenReviewStatus",
"description": "Status is filled in by the server and indicates whether the request can be authenticated."
"description": "Status is filled in by the server and indicates whether the token can be authenticated."
}
},
"required": [

2
hack/.descriptions_failures
View File

@@ -2,8 +2,6 @@
./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
./staging/src/k8s.io/api/authentication/v1/types.go
./staging/src/k8s.io/api/authentication/v1beta1/types.go
./staging/src/k8s.io/api/autoscaling/v2beta2/types.go
./staging/src/k8s.io/api/certificates/v1/types.go
./staging/src/k8s.io/api/certificates/v1beta1/types.go

6
staging/src/k8s.io/api/authentication/v1/generated.proto
View File

@@ -58,11 +58,15 @@ message ExtraValue {
// TokenRequest requests a token for a given service account.
message TokenRequest {
// Standard object's 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.ObjectMeta metadata = 1;
// Spec holds information about the request being evaluated
optional TokenRequestSpec spec = 2;
// Status is filled in by the server and indicates whether the token can be authenticated.
// +optional
optional TokenRequestStatus status = 3;
}
@@ -105,6 +109,8 @@ message TokenRequestStatus {
// Note: TokenReview requests may be cached by the webhook token authenticator
// plugin in the kube-apiserver.
message TokenReview {
// Standard object's 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.ObjectMeta metadata = 1;

7
staging/src/k8s.io/api/authentication/v1/types.go
View File

@@ -48,6 +48,8 @@ const (
// plugin in the kube-apiserver.
type TokenReview struct {
metav1.TypeMeta `json:",inline"`
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
@@ -130,10 +132,15 @@ func (t ExtraValue) String() string {
// TokenRequest requests a token for a given service account.
type TokenRequest struct {
metav1.TypeMeta `json:",inline"`
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec holds information about the request being evaluated
Spec TokenRequestSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
// Status is filled in by the server and indicates whether the token can be authenticated.
// +optional
Status TokenRequestStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

4
staging/src/k8s.io/api/authentication/v1/types_swagger_doc_generated.go generated
View File

@@ -41,6 +41,9 @@ func (BoundObjectReference) SwaggerDoc() map[string]string {
var map_TokenRequest = map[string]string{
"": "TokenRequest requests a token for a given service account.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "Spec holds information about the request being evaluated",
"status": "Status is filled in by the server and indicates whether the token can be authenticated.",
}
func (TokenRequest) SwaggerDoc() map[string]string {
@@ -70,6 +73,7 @@ func (TokenRequestStatus) SwaggerDoc() map[string]string {
var map_TokenReview = map[string]string{
"": "TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "Spec holds information about the request being evaluated",
"status": "Status is filled in by the server and indicates whether the request can be authenticated.",
}

4
staging/src/k8s.io/api/authentication/v1beta1/generated.proto
View File

@@ -41,13 +41,15 @@ message ExtraValue {
// Note: TokenReview requests may be cached by the webhook token authenticator
// plugin in the kube-apiserver.
message TokenReview {
// Standard object's 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.ObjectMeta metadata = 1;
// Spec holds information about the request being evaluated
optional TokenReviewSpec spec = 2;
// Status is filled in by the server and indicates whether the request can be authenticated.
// Status is filled in by the server and indicates whether the token can be authenticated.
// +optional
optional TokenReviewStatus status = 3;
}

4
staging/src/k8s.io/api/authentication/v1beta1/types.go
View File

@@ -35,13 +35,15 @@ import (
// plugin in the kube-apiserver.
type TokenReview struct {
metav1.TypeMeta `json:",inline"`
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec holds information about the request being evaluated
Spec TokenReviewSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
// Status is filled in by the server and indicates whether the request can be authenticated.
// Status is filled in by the server and indicates whether the token can be authenticated.
// +optional
Status TokenReviewStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

3
staging/src/k8s.io/api/authentication/v1beta1/types_swagger_doc_generated.go generated
View File

@@ -29,8 +29,9 @@ package v1beta1
// AUTO-GENERATED FUNCTIONS START HERE. DO NOT EDIT.
var map_TokenReview = map[string]string{
"": "TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "Spec holds information about the request being evaluated",
"status": "Status is filled in by the server and indicates whether the request can be authenticated.",
"status": "Status is filled in by the server and indicates whether the token can be authenticated.",
}
func (TokenReview) SwaggerDoc() map[string]string {