zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/operatoringress/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_DNSRecord = map[string]string{
    15  	"":         "DNSRecord is a DNS record managed in the zones defined by dns.config.openshift.io/cluster .spec.publicZone and .spec.privateZone.\n\nCluster admin manipulation of this resource is not supported. This resource is only for internal communication of OpenShift operators.\n\nIf DNSManagementPolicy is \"Unmanaged\", the operator will not be responsible for managing the DNS records on the cloud provider.\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 specification of the desired behavior of the dnsRecord.",
    18  	"status":   "status is the most recently observed status of the dnsRecord.",
    19  }
    20  
    21  func (DNSRecord) SwaggerDoc() map[string]string {
    22  	return map_DNSRecord
    23  }
    24  
    25  var map_DNSRecordList = map[string]string{
    26  	"":         "DNSRecordList contains a list of dnsrecords.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    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  }
    29  
    30  func (DNSRecordList) SwaggerDoc() map[string]string {
    31  	return map_DNSRecordList
    32  }
    33  
    34  var map_DNSRecordSpec = map[string]string{
    35  	"":                    "DNSRecordSpec contains the details of a DNS record.",
    36  	"dnsName":             "dnsName is the hostname of the DNS record",
    37  	"targets":             "targets are record targets.",
    38  	"recordType":          "recordType is the DNS record type. For example, \"A\" or \"CNAME\".",
    39  	"recordTTL":           "recordTTL is the record TTL in seconds. If zero, the default is 30. RecordTTL will not be used in AWS regions Alias targets, but will be used in CNAME targets, per AWS API contract.",
    40  	"dnsManagementPolicy": "dnsManagementPolicy denotes the current policy applied on the DNS record. Records that have policy set as \"Unmanaged\" are ignored by the ingress operator.  This means that the DNS record on the cloud provider is not managed by the operator, and the \"Published\" status condition will be updated to \"Unknown\" status, since it is externally managed. Any existing record on the cloud provider can be deleted at the discretion of the cluster admin.\n\nThis field defaults to Managed. Valid values are \"Managed\" and \"Unmanaged\".",
    41  }
    42  
    43  func (DNSRecordSpec) SwaggerDoc() map[string]string {
    44  	return map_DNSRecordSpec
    45  }
    46  
    47  var map_DNSRecordStatus = map[string]string{
    48  	"":                   "DNSRecordStatus is the most recently observed status of each record.",
    49  	"zones":              "zones are the status of the record in each zone.",
    50  	"observedGeneration": "observedGeneration is the most recently observed generation of the DNSRecord.  When the DNSRecord is updated, the controller updates the corresponding record in each managed zone.  If an update for a particular zone fails, that failure is recorded in the status condition for the zone so that the controller can determine that it needs to retry the update for that specific zone.",
    51  }
    52  
    53  func (DNSRecordStatus) SwaggerDoc() map[string]string {
    54  	return map_DNSRecordStatus
    55  }
    56  
    57  var map_DNSZoneCondition = map[string]string{
    58  	"": "DNSZoneCondition is just the standard condition fields.",
    59  }
    60  
    61  func (DNSZoneCondition) SwaggerDoc() map[string]string {
    62  	return map_DNSZoneCondition
    63  }
    64  
    65  var map_DNSZoneStatus = map[string]string{
    66  	"":           "DNSZoneStatus is the status of a record within a specific zone.",
    67  	"dnsZone":    "dnsZone is the zone where the record is published.",
    68  	"conditions": "conditions are any conditions associated with the record in the zone.\n\nIf publishing the record succeeds, the \"Published\" condition will be set with status \"True\" and upon failure it will be set to \"False\" along with the reason and message describing the cause of the failure.",
    69  }
    70  
    71  func (DNSZoneStatus) SwaggerDoc() map[string]string {
    72  	return map_DNSZoneStatus
    73  }
    74  
    75  // AUTO-GENERATED FUNCTIONS END HERE
    76
View as plain text