zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/operatorcontrolplane/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_LogEntry = map[string]string{
    15  	"":        "LogEntry records events",
    16  	"time":    "Start time of check action.",
    17  	"success": "Success indicates if the log entry indicates a success or failure.",
    18  	"reason":  "Reason for status in a machine readable format.",
    19  	"message": "Message explaining status in a human readable format.",
    20  	"latency": "Latency records how long the action mentioned in the entry took.",
    21  }
    22  
    23  func (LogEntry) SwaggerDoc() map[string]string {
    24  	return map_LogEntry
    25  }
    26  
    27  var map_OutageEntry = map[string]string{
    28  	"":          "OutageEntry records time period of an outage",
    29  	"start":     "Start of outage detected",
    30  	"end":       "End of outage detected",
    31  	"startLogs": "StartLogs contains log entries related to the start of this outage. Should contain the original failure, any entries where the failure mode changed.",
    32  	"endLogs":   "EndLogs contains log entries related to the end of this outage. Should contain the success entry that resolved the outage and possibly a few of the failure log entries that preceded it.",
    33  	"message":   "Message summarizes outage details in a human readable format.",
    34  }
    35  
    36  func (OutageEntry) SwaggerDoc() map[string]string {
    37  	return map_OutageEntry
    38  }
    39  
    40  var map_PodNetworkConnectivityCheck = map[string]string{
    41  	"":         "PodNetworkConnectivityCheck\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.",
    42  	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    43  	"spec":     "Spec defines the source and target of the connectivity check",
    44  	"status":   "Status contains the observed status of the connectivity check",
    45  }
    46  
    47  func (PodNetworkConnectivityCheck) SwaggerDoc() map[string]string {
    48  	return map_PodNetworkConnectivityCheck
    49  }
    50  
    51  var map_PodNetworkConnectivityCheckCondition = map[string]string{
    52  	"":                   "PodNetworkConnectivityCheckCondition represents the overall status of the pod network connectivity.",
    53  	"type":               "Type of the condition",
    54  	"status":             "Status of the condition",
    55  	"reason":             "Reason for the condition's last status transition in a machine readable format.",
    56  	"message":            "Message indicating details about last transition in a human readable format.",
    57  	"lastTransitionTime": "Last time the condition transitioned from one status to another.",
    58  }
    59  
    60  func (PodNetworkConnectivityCheckCondition) SwaggerDoc() map[string]string {
    61  	return map_PodNetworkConnectivityCheckCondition
    62  }
    63  
    64  var map_PodNetworkConnectivityCheckList = map[string]string{
    65  	"":         "PodNetworkConnectivityCheckList is a collection of PodNetworkConnectivityCheck\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.",
    66  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    67  	"items":    "Items contains the items",
    68  }
    69  
    70  func (PodNetworkConnectivityCheckList) SwaggerDoc() map[string]string {
    71  	return map_PodNetworkConnectivityCheckList
    72  }
    73  
    74  var map_PodNetworkConnectivityCheckSpec = map[string]string{
    75  	"sourcePod":      "SourcePod names the pod from which the condition will be checked",
    76  	"targetEndpoint": "EndpointAddress to check. A TCP address of the form host:port. Note that if host is a DNS name, then the check would fail if the DNS name cannot be resolved. Specify an IP address for host to bypass DNS name lookup.",
    77  	"tlsClientCert":  "TLSClientCert, if specified, references a kubernetes.io/tls type secret with 'tls.crt' and 'tls.key' entries containing an optional TLS client certificate and key to be used when checking endpoints that require a client certificate in order to gracefully preform the scan without causing excessive logging in the endpoint process. The secret must exist in the same namespace as this resource.",
    78  }
    79  
    80  func (PodNetworkConnectivityCheckSpec) SwaggerDoc() map[string]string {
    81  	return map_PodNetworkConnectivityCheckSpec
    82  }
    83  
    84  var map_PodNetworkConnectivityCheckStatus = map[string]string{
    85  	"successes":  "Successes contains logs successful check actions",
    86  	"failures":   "Failures contains logs of unsuccessful check actions",
    87  	"outages":    "Outages contains logs of time periods of outages",
    88  	"conditions": "Conditions summarize the status of the check",
    89  }
    90  
    91  func (PodNetworkConnectivityCheckStatus) SwaggerDoc() map[string]string {
    92  	return map_PodNetworkConnectivityCheckStatus
    93  }
    94  
    95  // AUTO-GENERATED FUNCTIONS END HERE
    96
View as plain text