github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-19 18:02:01 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #113876 from chiukapoor/coordination-api-doc

Browse Source 
Fix API field references for coordination v1 and v1beta1
This commit is contained in:
Kubernetes Prow Robot 2022-12-10 06:03:43 -08:00 committed by GitHub
commit 09b5e8a938
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3891,7 +3891,7 @@
}, },
"spec": { "spec": {
"$ref": "#/definitions/io.k8s.api.coordination.v1.LeaseSpec", "$ref": "#/definitions/io.k8s.api.coordination.v1.LeaseSpec",
"description": "Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" "description": "spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
} }
}, },
"type": "object", "type": "object",
@ -3911,7 +3911,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is a list of schema objects.", "description": "items is a list of schema objects.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.coordination.v1.Lease" "$ref": "#/definitions/io.k8s.api.coordination.v1.Lease"
}, },
@ -3950,7 +3950,7 @@
"type": "string" "type": "string"
}, },
"leaseDurationSeconds": { "leaseDurationSeconds": {
"description": "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.", "description": "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed renewTime.",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
}, },

6
api/openapi-spec/v3/apis__coordination.k8s.io__v1_openapi.json
View File

@ -28,7 +28,7 @@
} }
], ],
"default": {}, "default": {},
"description": "Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" "description": "spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
} }
}, },
"type": "object", "type": "object",
@ -48,7 +48,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is a list of schema objects.", "description": "items is a list of schema objects.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -101,7 +101,7 @@
"type": "string" "type": "string"
}, },
"leaseDurationSeconds": { "leaseDurationSeconds": {
"description": "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.", "description": "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed renewTime.",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
}, },

6
pkg/apis/coordination/types.go
View File

@ -28,7 +28,7 @@ type Lease struct {
// +optional // +optional
metav1.ObjectMeta metav1.ObjectMeta
// Specification of the Lease. // spec contains the specification of the Lease.
// +optional // +optional
Spec LeaseSpec Spec LeaseSpec
} }
@ -40,7 +40,7 @@ type LeaseSpec struct {
HolderIdentity *string HolderIdentity *string
// leaseDurationSeconds is a duration that candidates for a lease need // leaseDurationSeconds is a duration that candidates for a lease need
// to wait to force acquire it. This is measure against time of last // to wait to force acquire it. This is measure against time of last
// observed RenewTime. // observed renewTime.
// +optional // +optional
LeaseDurationSeconds *int32 LeaseDurationSeconds *int32
// acquireTime is a time when the current lease was acquired. // acquireTime is a time when the current lease was acquired.
@ -64,6 +64,6 @@ type LeaseList struct {
// +optional // +optional
metav1.ListMeta metav1.ListMeta
// Items is a list of schema objects. // items is a list of schema objects.
Items []Lease Items []Lease
} }

12
pkg/generated/openapi/zz_generated.openapi.go generated
View File

@ -15421,7 +15421,7 @@ func schema_k8sio_api_coordination_v1_Lease(ref common.ReferenceCallback) common
}, },
"spec": { "spec": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", Description: "spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/coordination/v1.LeaseSpec"), Ref: ref("k8s.io/api/coordination/v1.LeaseSpec"),
}, },
@ -15464,7 +15464,7 @@ func schema_k8sio_api_coordination_v1_LeaseList(ref common.ReferenceCallback) co
}, },
"items": { "items": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Items is a list of schema objects.", Description: "items is a list of schema objects.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -15501,7 +15501,7 @@ func schema_k8sio_api_coordination_v1_LeaseSpec(ref common.ReferenceCallback) co
}, },
"leaseDurationSeconds": { "leaseDurationSeconds": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.", Description: "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed renewTime.",
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
}, },
@ -15563,7 +15563,7 @@ func schema_k8sio_api_coordination_v1beta1_Lease(ref common.ReferenceCallback) c
}, },
"spec": { "spec": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", Description: "spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/coordination/v1beta1.LeaseSpec"), Ref: ref("k8s.io/api/coordination/v1beta1.LeaseSpec"),
}, },
@ -15606,7 +15606,7 @@ func schema_k8sio_api_coordination_v1beta1_LeaseList(ref common.ReferenceCallbac
}, },
"items": { "items": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Items is a list of schema objects.", Description: "items is a list of schema objects.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -15643,7 +15643,7 @@ func schema_k8sio_api_coordination_v1beta1_LeaseSpec(ref common.ReferenceCallbac
}, },
"leaseDurationSeconds": { "leaseDurationSeconds": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.", Description: "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed renewTime.",
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
}, },

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

@ -34,7 +34,7 @@ message Lease {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Specification of the Lease. // spec contains the specification of the Lease.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
optional LeaseSpec spec = 2; optional LeaseSpec spec = 2;
@ -47,7 +47,7 @@ message LeaseList {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is a list of schema objects. // items is a list of schema objects.
repeated Lease items = 2; repeated Lease items = 2;
} }
@ -59,7 +59,7 @@ message LeaseSpec {
// leaseDurationSeconds is a duration that candidates for a lease need // leaseDurationSeconds is a duration that candidates for a lease need
// to wait to force acquire it. This is measure against time of last // to wait to force acquire it. This is measure against time of last
// observed RenewTime. // observed renewTime.
// +optional // +optional
optional int32 leaseDurationSeconds = 2; optional int32 leaseDurationSeconds = 2;

6
staging/src/k8s.io/api/coordination/v1/types.go
View File

@ -30,7 +30,7 @@ type Lease struct {
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Specification of the Lease. // spec contains the specification of the Lease.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Spec LeaseSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec LeaseSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
@ -43,7 +43,7 @@ type LeaseSpec struct {
HolderIdentity *string `json:"holderIdentity,omitempty" protobuf:"bytes,1,opt,name=holderIdentity"` HolderIdentity *string `json:"holderIdentity,omitempty" protobuf:"bytes,1,opt,name=holderIdentity"`
// leaseDurationSeconds is a duration that candidates for a lease need // leaseDurationSeconds is a duration that candidates for a lease need
// to wait to force acquire it. This is measure against time of last // to wait to force acquire it. This is measure against time of last
// observed RenewTime. // observed renewTime.
// +optional // +optional
LeaseDurationSeconds *int32 `json:"leaseDurationSeconds,omitempty" protobuf:"varint,2,opt,name=leaseDurationSeconds"` LeaseDurationSeconds *int32 `json:"leaseDurationSeconds,omitempty" protobuf:"varint,2,opt,name=leaseDurationSeconds"`
// acquireTime is a time when the current lease was acquired. // acquireTime is a time when the current lease was acquired.
@ -69,6 +69,6 @@ type LeaseList struct {
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is a list of schema objects. // items is a list of schema objects.
Items []Lease `json:"items" protobuf:"bytes,2,rep,name=items"` Items []Lease `json:"items" protobuf:"bytes,2,rep,name=items"`
} }

6
staging/src/k8s.io/api/coordination/v1/types_swagger_doc_generated.go generated
View File

@ -30,7 +30,7 @@ package v1
var map_Lease = map[string]string{ var map_Lease = map[string]string{
"": "Lease defines a lease concept.", "": "Lease defines a lease concept.",
"metadata": "More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "spec": "spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
} }
func (Lease) SwaggerDoc() map[string]string { func (Lease) SwaggerDoc() map[string]string {
@ -40,7 +40,7 @@ func (Lease) SwaggerDoc() map[string]string {
var map_LeaseList = map[string]string{ var map_LeaseList = map[string]string{
"": "LeaseList is a list of Lease objects.", "": "LeaseList is a list of Lease objects.",
"metadata": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"items": "Items is a list of schema objects.", "items": "items is a list of schema objects.",
} }
func (LeaseList) SwaggerDoc() map[string]string { func (LeaseList) SwaggerDoc() map[string]string {
@ -50,7 +50,7 @@ func (LeaseList) SwaggerDoc() map[string]string {
var map_LeaseSpec = map[string]string{ var map_LeaseSpec = map[string]string{
"": "LeaseSpec is a specification of a Lease.", "": "LeaseSpec is a specification of a Lease.",
"holderIdentity": "holderIdentity contains the identity of the holder of a current lease.", "holderIdentity": "holderIdentity contains the identity of the holder of a current lease.",
"leaseDurationSeconds": "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.", "leaseDurationSeconds": "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed renewTime.",
"acquireTime": "acquireTime is a time when the current lease was acquired.", "acquireTime": "acquireTime is a time when the current lease was acquired.",
"renewTime": "renewTime is a time when the current holder of a lease has last updated the lease.", "renewTime": "renewTime is a time when the current holder of a lease has last updated the lease.",
"leaseTransitions": "leaseTransitions is the number of transitions of a lease between holders.", "leaseTransitions": "leaseTransitions is the number of transitions of a lease between holders.",

6
staging/src/k8s.io/api/coordination/v1beta1/generated.proto
View File

@ -34,7 +34,7 @@ message Lease {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Specification of the Lease. // spec contains the specification of the Lease.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
optional LeaseSpec spec = 2; optional LeaseSpec spec = 2;
@ -47,7 +47,7 @@ message LeaseList {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is a list of schema objects. // items is a list of schema objects.
repeated Lease items = 2; repeated Lease items = 2;
} }
@ -59,7 +59,7 @@ message LeaseSpec {
// leaseDurationSeconds is a duration that candidates for a lease need // leaseDurationSeconds is a duration that candidates for a lease need
// to wait to force acquire it. This is measure against time of last // to wait to force acquire it. This is measure against time of last
// observed RenewTime. // observed renewTime.
// +optional // +optional
optional int32 leaseDurationSeconds = 2; optional int32 leaseDurationSeconds = 2;

6
staging/src/k8s.io/api/coordination/v1beta1/types.go
View File

@ -33,7 +33,7 @@ type Lease struct {
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Specification of the Lease. // spec contains the specification of the Lease.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Spec LeaseSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec LeaseSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
@ -46,7 +46,7 @@ type LeaseSpec struct {
HolderIdentity *string `json:"holderIdentity,omitempty" protobuf:"bytes,1,opt,name=holderIdentity"` HolderIdentity *string `json:"holderIdentity,omitempty" protobuf:"bytes,1,opt,name=holderIdentity"`
// leaseDurationSeconds is a duration that candidates for a lease need // leaseDurationSeconds is a duration that candidates for a lease need
// to wait to force acquire it. This is measure against time of last // to wait to force acquire it. This is measure against time of last
// observed RenewTime. // observed renewTime.
// +optional // +optional
LeaseDurationSeconds *int32 `json:"leaseDurationSeconds,omitempty" protobuf:"varint,2,opt,name=leaseDurationSeconds"` LeaseDurationSeconds *int32 `json:"leaseDurationSeconds,omitempty" protobuf:"varint,2,opt,name=leaseDurationSeconds"`
// acquireTime is a time when the current lease was acquired. // acquireTime is a time when the current lease was acquired.
@ -75,6 +75,6 @@ type LeaseList struct {
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is a list of schema objects. // items is a list of schema objects.
Items []Lease `json:"items" protobuf:"bytes,2,rep,name=items"` Items []Lease `json:"items" protobuf:"bytes,2,rep,name=items"`
} }

6
staging/src/k8s.io/api/coordination/v1beta1/types_swagger_doc_generated.go generated
View File

@ -30,7 +30,7 @@ package v1beta1
var map_Lease = map[string]string{ var map_Lease = map[string]string{
"": "Lease defines a lease concept.", "": "Lease defines a lease concept.",
"metadata": "More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "spec": "spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
} }
func (Lease) SwaggerDoc() map[string]string { func (Lease) SwaggerDoc() map[string]string {
@ -40,7 +40,7 @@ func (Lease) SwaggerDoc() map[string]string {
var map_LeaseList = map[string]string{ var map_LeaseList = map[string]string{
"": "LeaseList is a list of Lease objects.", "": "LeaseList is a list of Lease objects.",
"metadata": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"items": "Items is a list of schema objects.", "items": "items is a list of schema objects.",
} }
func (LeaseList) SwaggerDoc() map[string]string { func (LeaseList) SwaggerDoc() map[string]string {
@ -50,7 +50,7 @@ func (LeaseList) SwaggerDoc() map[string]string {
var map_LeaseSpec = map[string]string{ var map_LeaseSpec = map[string]string{
"": "LeaseSpec is a specification of a Lease.", "": "LeaseSpec is a specification of a Lease.",
"holderIdentity": "holderIdentity contains the identity of the holder of a current lease.", "holderIdentity": "holderIdentity contains the identity of the holder of a current lease.",
"leaseDurationSeconds": "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime.", "leaseDurationSeconds": "leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed renewTime.",
"acquireTime": "acquireTime is a time when the current lease was acquired.", "acquireTime": "acquireTime is a time when the current lease was acquired.",
"renewTime": "renewTime is a time when the current holder of a lease has last updated the lease.", "renewTime": "renewTime is a time when the current holder of a lease has last updated the lease.",
"leaseTransitions": "leaseTransitions is the number of transitions of a lease between holders.", "leaseTransitions": "leaseTransitions is the number of transitions of a lease between holders.",