Matteo Scandolo | a428586 | 2020-12-01 18:10:10 -0800 | [diff] [blame] | 1 | /* |
| 2 | Copyright The Kubernetes Authors. |
| 3 | |
| 4 | Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | you may not use this file except in compliance with the License. |
| 6 | You may obtain a copy of the License at |
| 7 | |
| 8 | http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | |
| 10 | Unless required by applicable law or agreed to in writing, software |
| 11 | distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | See the License for the specific language governing permissions and |
| 14 | limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package v1beta1 |
| 18 | |
| 19 | // This file contains a collection of methods that can be used from go-restful to |
| 20 | // generate Swagger API documentation for its models. Please read this PR for more |
| 21 | // information on the implementation: https://github.com/emicklei/go-restful/pull/215 |
| 22 | // |
| 23 | // TODOs are ignored from the parser (e.g. TODO(andronat):... || TODO:...) if and only if |
| 24 | // they are on one line! For multiple line or blocks that you want to ignore use ---. |
| 25 | // Any context after a --- is ignored. |
| 26 | // |
| 27 | // Those methods can be generated by using hack/update-generated-swagger-docs.sh |
| 28 | |
| 29 | // AUTO-GENERATED FUNCTIONS START HERE. DO NOT EDIT. |
| 30 | var map_CronJob = map[string]string{ |
| 31 | "": "CronJob represents the configuration of a single cron job.", |
| 32 | "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", |
| 33 | "spec": "Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", |
| 34 | "status": "Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", |
| 35 | } |
| 36 | |
| 37 | func (CronJob) SwaggerDoc() map[string]string { |
| 38 | return map_CronJob |
| 39 | } |
| 40 | |
| 41 | var map_CronJobList = map[string]string{ |
| 42 | "": "CronJobList is a collection of cron jobs.", |
| 43 | "metadata": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", |
| 44 | "items": "items is the list of CronJobs.", |
| 45 | } |
| 46 | |
| 47 | func (CronJobList) SwaggerDoc() map[string]string { |
| 48 | return map_CronJobList |
| 49 | } |
| 50 | |
| 51 | var map_CronJobSpec = map[string]string{ |
| 52 | "": "CronJobSpec describes how the job execution will look like and when it will actually run.", |
| 53 | "schedule": "The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.", |
| 54 | "startingDeadlineSeconds": "Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.", |
| 55 | "concurrencyPolicy": "Specifies how to treat concurrent executions of a Job. Valid values are: - \"Allow\" (default): allows CronJobs to run concurrently; - \"Forbid\": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - \"Replace\": cancels currently running job and replaces it with a new one", |
| 56 | "suspend": "This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.", |
| 57 | "jobTemplate": "Specifies the job that will be created when executing a CronJob.", |
| 58 | "successfulJobsHistoryLimit": "The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.", |
| 59 | "failedJobsHistoryLimit": "The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.", |
| 60 | } |
| 61 | |
| 62 | func (CronJobSpec) SwaggerDoc() map[string]string { |
| 63 | return map_CronJobSpec |
| 64 | } |
| 65 | |
| 66 | var map_CronJobStatus = map[string]string{ |
| 67 | "": "CronJobStatus represents the current state of a cron job.", |
| 68 | "active": "A list of pointers to currently running jobs.", |
| 69 | "lastScheduleTime": "Information when was the last time the job was successfully scheduled.", |
| 70 | } |
| 71 | |
| 72 | func (CronJobStatus) SwaggerDoc() map[string]string { |
| 73 | return map_CronJobStatus |
| 74 | } |
| 75 | |
| 76 | var map_JobTemplate = map[string]string{ |
| 77 | "": "JobTemplate describes a template for creating copies of a predefined pod.", |
| 78 | "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", |
| 79 | "template": "Defines jobs that will be created from this template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", |
| 80 | } |
| 81 | |
| 82 | func (JobTemplate) SwaggerDoc() map[string]string { |
| 83 | return map_JobTemplate |
| 84 | } |
| 85 | |
| 86 | var map_JobTemplateSpec = map[string]string{ |
| 87 | "": "JobTemplateSpec describes the data a Job should have when created from a template", |
| 88 | "metadata": "Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", |
| 89 | "spec": "Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", |
| 90 | } |
| 91 | |
| 92 | func (JobTemplateSpec) SwaggerDoc() map[string]string { |
| 93 | return map_JobTemplateSpec |
| 94 | } |
| 95 | |
| 96 | // AUTO-GENERATED FUNCTIONS END HERE |