zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/platform/v1alpha1

     1  package v1alpha1
     2  
     3  // This file contains a collection of methods that can be used from go-restful to
     4  // generate Swagger API documentation for its models. Please read this PR for more
     5  // information on the implementation: https://github.com/emicklei/go-restful/pull/215
     6  //
     7  // TODOs are ignored from the parser (e.g. TODO(andronat):... || TODO:...) if and only if
     8  // they are on one line! For multiple line or blocks that you want to ignore use ---.
     9  // Any context after a --- is ignored.
    10  //
    11  // Those methods can be generated by using hack/update-swagger-docs.sh
    12  
    13  // AUTO-GENERATED FUNCTIONS START HERE
    14  var map_ActiveBundleDeployment = map[string]string{
    15  	"":     "ActiveBundleDeployment references a BundleDeployment resource.",
    16  	"name": "name is the metadata.name of the referenced BundleDeployment object.",
    17  }
    18  
    19  func (ActiveBundleDeployment) SwaggerDoc() map[string]string {
    20  	return map_ActiveBundleDeployment
    21  }
    22  
    23  var map_Package = map[string]string{
    24  	"":     "Package contains fields to configure which OLM package this PlatformOperator will install",
    25  	"name": "name contains the desired OLM-based Operator package name that is defined in an existing CatalogSource resource in the cluster.\n\nThis configured package will be managed with the cluster's lifecycle. In the current implementation, it will be retrieving this name from a list of supported operators out of the catalogs included with OpenShift.",
    26  }
    27  
    28  func (Package) SwaggerDoc() map[string]string {
    29  	return map_Package
    30  }
    31  
    32  var map_PlatformOperator = map[string]string{
    33  	"":         "PlatformOperator is the Schema for the PlatformOperators API.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
    34  	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    35  }
    36  
    37  func (PlatformOperator) SwaggerDoc() map[string]string {
    38  	return map_PlatformOperator
    39  }
    40  
    41  var map_PlatformOperatorList = map[string]string{
    42  	"":         "PlatformOperatorList contains a list of PlatformOperators\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.",
    43  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    44  }
    45  
    46  func (PlatformOperatorList) SwaggerDoc() map[string]string {
    47  	return map_PlatformOperatorList
    48  }
    49  
    50  var map_PlatformOperatorSpec = map[string]string{
    51  	"":        "PlatformOperatorSpec defines the desired state of PlatformOperator.",
    52  	"package": "package contains the desired package and its configuration for this PlatformOperator.",
    53  }
    54  
    55  func (PlatformOperatorSpec) SwaggerDoc() map[string]string {
    56  	return map_PlatformOperatorSpec
    57  }
    58  
    59  var map_PlatformOperatorStatus = map[string]string{
    60  	"":                       "PlatformOperatorStatus defines the observed state of PlatformOperator",
    61  	"conditions":             "conditions represent the latest available observations of a platform operator's current state.",
    62  	"activeBundleDeployment": "activeBundleDeployment is the reference to the BundleDeployment resource that's being managed by this PO resource. If this field is not populated in the status then it means the PlatformOperator has either not been installed yet or is failing to install.",
    63  }
    64  
    65  func (PlatformOperatorStatus) SwaggerDoc() map[string]string {
    66  	return map_PlatformOperatorStatus
    67  }
    68  
    69  // AUTO-GENERATED FUNCTIONS END HERE
    70
View as plain text