zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/cloudnetwork/v1

     1  package v1
     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_CloudPrivateIPConfig = map[string]string{
    15  	"":         "CloudPrivateIPConfig performs an assignment of a private IP address to the primary NIC associated with cloud VMs. This is done by specifying the IP and Kubernetes node which the IP should be assigned to. This CRD is intended to be used by the network plugin which manages the cluster network. The spec side represents the desired state requested by the network plugin, and the status side represents the current state that this CRD's controller has executed. No users will have permission to modify it, and if a cluster-admin decides to edit it for some reason, their changes will be overwritten the next time the network plugin reconciles the object. Note: the CR's name must specify the requested private IP address (can be IPv4 or IPv6).\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    16  	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    17  	"spec":     "spec is the definition of the desired private IP request.",
    18  	"status":   "status is the observed status of the desired private IP request. Read-only.",
    19  }
    20  
    21  func (CloudPrivateIPConfig) SwaggerDoc() map[string]string {
    22  	return map_CloudPrivateIPConfig
    23  }
    24  
    25  var map_CloudPrivateIPConfigList = map[string]string{
    26  	"":         "Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). CloudPrivateIPConfigList is the list of CloudPrivateIPConfigList.",
    27  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    28  	"items":    "List of CloudPrivateIPConfig.",
    29  }
    30  
    31  func (CloudPrivateIPConfigList) SwaggerDoc() map[string]string {
    32  	return map_CloudPrivateIPConfigList
    33  }
    34  
    35  var map_CloudPrivateIPConfigSpec = map[string]string{
    36  	"":     "CloudPrivateIPConfigSpec consists of a node name which the private IP should be assigned to.",
    37  	"node": "node is the node name, as specified by the Kubernetes field: node.metadata.name",
    38  }
    39  
    40  func (CloudPrivateIPConfigSpec) SwaggerDoc() map[string]string {
    41  	return map_CloudPrivateIPConfigSpec
    42  }
    43  
    44  var map_CloudPrivateIPConfigStatus = map[string]string{
    45  	"":           "CloudPrivateIPConfigStatus specifies the node assignment together with its assignment condition.",
    46  	"node":       "node is the node name, as specified by the Kubernetes field: node.metadata.name",
    47  	"conditions": "condition is the assignment condition of the private IP and its status",
    48  }
    49  
    50  func (CloudPrivateIPConfigStatus) SwaggerDoc() map[string]string {
    51  	return map_CloudPrivateIPConfigStatus
    52  }
    53  
    54  // AUTO-GENERATED FUNCTIONS END HERE
    55
View as plain text