zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/config/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_GatherConfig = map[string]string{
    15  	"":                  "gatherConfig provides data gathering configuration options.",
    16  	"dataPolicy":        "dataPolicy allows user to enable additional global obfuscation of the IP addresses and base domain in the Insights archive data. Valid values are \"None\" and \"ObfuscateNetworking\". When set to None the data is not obfuscated. When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated. When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time. The current default is None.",
    17  	"disabledGatherers": "disabledGatherers is a list of gatherers to be excluded from the gathering. All the gatherers can be disabled by providing \"all\" value. If all the gatherers are disabled, the Insights operator does not gather any data. The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md. Run the following command to get the names of last active gatherers: \"oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'\" An example of disabling gatherers looks like this: `disabledGatherers: [\"clusterconfig/machine_configs\", \"workloads/workload_info\"]`",
    18  }
    19  
    20  func (GatherConfig) SwaggerDoc() map[string]string {
    21  	return map_GatherConfig
    22  }
    23  
    24  var map_InsightsDataGather = map[string]string{
    25  	"":         "\n\nInsightsDataGather provides data gather configuration options for the the Insights Operator.\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.",
    26  	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    27  	"spec":     "spec holds user settable values for configuration",
    28  	"status":   "status holds observed values from the cluster. They may not be overridden.",
    29  }
    30  
    31  func (InsightsDataGather) SwaggerDoc() map[string]string {
    32  	return map_InsightsDataGather
    33  }
    34  
    35  var map_InsightsDataGatherList = map[string]string{
    36  	"":         "InsightsDataGatherList is a collection of items\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.",
    37  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    38  }
    39  
    40  func (InsightsDataGatherList) SwaggerDoc() map[string]string {
    41  	return map_InsightsDataGatherList
    42  }
    43  
    44  var map_InsightsDataGatherSpec = map[string]string{
    45  	"gatherConfig": "gatherConfig spec attribute includes all the configuration options related to gathering of the Insights data and its uploading to the ingress.",
    46  }
    47  
    48  func (InsightsDataGatherSpec) SwaggerDoc() map[string]string {
    49  	return map_InsightsDataGatherSpec
    50  }
    51  
    52  // AUTO-GENERATED FUNCTIONS END HERE
    53
View as plain text