package v1

// This file contains a collection of methods that can be used from go-restful to
// generate Swagger API documentation for its models. Please read this PR for more
// information on the implementation: https://github.com/emicklei/go-restful/pull/215
//
// TODOs are ignored from the parser (e.g. TODO(andronat):... || TODO:...) if and only if
// they are on one line! For multiple line or blocks that you want to ignore use ---.
// Any context after a --- is ignored.
//
// Those methods can be generated by using hack/update-swagger-docs.sh

// AUTO-GENERATED FUNCTIONS START HERE
var map_EgressRouter = map[string]string{
	"":         "EgressRouter is a feature allowing the user to define an egress router that acts as a bridge between pods and external systems. The egress router runs a service that redirects egress traffic originating from a pod or a group of pods to a remote external system or multiple destinations as per configuration.\n\nIt is consumed by the cluster-network-operator. More specifically, given an EgressRouter CR with <name>, the CNO will create and manage: - A service called <name> - An egress pod called <name> - A NAD called <name>\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).\n\nEgressRouter is a single egressrouter pod configuration object.",
	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
	"spec":     "Specification of the desired egress router.",
	"status":   "Observed status of EgressRouter.",
}

func (EgressRouter) SwaggerDoc() map[string]string {
	return map_EgressRouter
}

var map_EgressRouterAddress = map[string]string{
	"":        "EgressRouterAddress contains a pair of IP CIDR and gateway to be configured on the router's interface",
	"ip":      "ip is the address to configure on the router's interface. Can be IPv4 or IPv6.",
	"gateway": "IP address of the next-hop gateway, if it cannot be automatically determined. Can be IPv4 or IPv6.",
}

func (EgressRouterAddress) SwaggerDoc() map[string]string {
	return map_EgressRouterAddress
}

var map_EgressRouterInterface = map[string]string{
	"":        "EgressRouterInterface contains the configuration of interface to create/use.",
	"macvlan": "Arguments specific to the interfaceType macvlan",
}

func (EgressRouterInterface) SwaggerDoc() map[string]string {
	return map_EgressRouterInterface
}

var map_EgressRouterList = map[string]string{
	"":         "EgressRouterList is the list of egress router pods requested.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
}

func (EgressRouterList) SwaggerDoc() map[string]string {
	return map_EgressRouterList
}

var map_EgressRouterSpec = map[string]string{
	"":                 "EgressRouterSpec contains the configuration for an egress router. Mode, networkInterface and addresses fields must be specified along with exactly one \"Config\" that matches the mode. Each config consists of parameters specific to that mode.",
	"mode":             "mode depicts the mode that is used for the egress router. The default mode is \"Redirect\" and is the only supported mode currently.",
	"redirect":         "redirect represents the configuration parameters specific to redirect mode.",
	"networkInterface": "Specification of interface to create/use. The default is macvlan. Currently only macvlan is supported.",
	"addresses":        "List of IP addresses to configure on the pod's secondary interface.",
}

func (EgressRouterSpec) SwaggerDoc() map[string]string {
	return map_EgressRouterSpec
}

var map_EgressRouterStatus = map[string]string{
	"":           "EgressRouterStatus contains the observed status of EgressRouter. Read-only.",
	"conditions": "Observed status of the egress router",
}

func (EgressRouterStatus) SwaggerDoc() map[string]string {
	return map_EgressRouterStatus
}

var map_EgressRouterStatusCondition = map[string]string{
	"":                   "EgressRouterStatusCondition represents the state of the egress router's managed and monitored components.",
	"type":               "type specifies the aspect reported by this condition; one of Available, Progressing, Degraded",
	"status":             "status of the condition, one of True, False, Unknown.",
	"lastTransitionTime": "lastTransitionTime is the time of the last update to the current status property.",
	"reason":             "reason is the CamelCase reason for the condition's current status.",
	"message":            "message provides additional information about the current condition. This is only to be consumed by humans.  It may contain Line Feed characters (U+000A), which should be rendered as new lines.",
}

func (EgressRouterStatusCondition) SwaggerDoc() map[string]string {
	return map_EgressRouterStatusCondition
}

var map_L4RedirectRule = map[string]string{
	"":              "L4RedirectRule defines a DNAT redirection from a given port to a destination IP and port.",
	"destinationIP": "IP specifies the remote destination's IP address. Can be IPv4 or IPv6.",
	"port":          "port is the port number to which clients should send traffic to be redirected.",
	"protocol":      "protocol can be TCP, SCTP or UDP.",
	"targetPort":    "targetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. If unspecified, the value from \"Port\" is used.",
}

func (L4RedirectRule) SwaggerDoc() map[string]string {
	return map_L4RedirectRule
}

var map_MacvlanConfig = map[string]string{
	"":       "MacvlanConfig consists of arguments specific to the macvlan EgressRouterInterfaceType",
	"mode":   "mode depicts the mode that is used for the macvlan interface; one of Bridge|Private|VEPA|Passthru. The default mode is \"Bridge\".",
	"master": "Name of the master interface. Need not be specified if it can be inferred from the IP address.",
}

func (MacvlanConfig) SwaggerDoc() map[string]string {
	return map_MacvlanConfig
}

var map_RedirectConfig = map[string]string{
	"":              "RedirectConfig represents the configuration parameters specific to redirect mode.",
	"redirectRules": "List of L4RedirectRules that define the DNAT redirection from the pod to the destination in redirect mode.",
	"fallbackIP":    "fallbackIP specifies the remote destination's IP address. Can be IPv4 or IPv6. If no redirect rules are specified, all traffic from the router are redirected to this IP. If redirect rules are specified, then any connections on any other port (undefined in the rules) on the router will be redirected to this IP. If redirect rules are specified and no fallback IP is provided, connections on other ports will simply be rejected.",
}

func (RedirectConfig) SwaggerDoc() map[string]string {
	return map_RedirectConfig
}

// AUTO-GENERATED FUNCTIONS END HERE
