zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/example/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_CELUnion = map[string]string{
    15  	"":               "CELUnion demonstrates how to use a discriminated union and how to validate it using CEL.",
    16  	"type":           "type determines which of the union members should be populated.",
    17  	"requiredMember": "requiredMember is a union member that is required.",
    18  	"optionalMember": "optionalMember is a union member that is optional.",
    19  }
    20  
    21  func (CELUnion) SwaggerDoc() map[string]string {
    22  	return map_CELUnion
    23  }
    24  
    25  var map_EvolvingUnion = map[string]string{
    26  	"type": "type is the discriminator. It has different values for Default and for TechPreviewNoUpgrade",
    27  }
    28  
    29  func (EvolvingUnion) SwaggerDoc() map[string]string {
    30  	return map_EvolvingUnion
    31  }
    32  
    33  var map_StableConfigType = map[string]string{
    34  	"":         "StableConfigType is a stable config type that may include TechPreviewNoUpgrade fields.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    35  	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    36  	"spec":     "spec is the specification of the desired behavior of the StableConfigType.",
    37  	"status":   "status is the most recently observed status of the StableConfigType.",
    38  }
    39  
    40  func (StableConfigType) SwaggerDoc() map[string]string {
    41  	return map_StableConfigType
    42  }
    43  
    44  var map_StableConfigTypeList = map[string]string{
    45  	"":         "StableConfigTypeList contains a list of StableConfigTypes.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    46  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    47  }
    48  
    49  func (StableConfigTypeList) SwaggerDoc() map[string]string {
    50  	return map_StableConfigTypeList
    51  }
    52  
    53  var map_StableConfigTypeSpec = map[string]string{
    54  	"":                       "StableConfigTypeSpec is the desired state",
    55  	"coolNewField":           "coolNewField is a field that is for tech preview only.  On normal clusters this shouldn't be present",
    56  	"stableField":            "stableField is a field that is present on default clusters and on tech preview clusters\n\nIf empty, the platform will choose a good default, which may change over time without notice.",
    57  	"immutableField":         "immutableField is a field that is immutable once the object has been created. It is required at all times.",
    58  	"optionalImmutableField": "optionalImmutableField is a field that is immutable once set. It is optional but may not be changed once set.",
    59  	"evolvingUnion":          "evolvingUnion demonstrates how to phase in new values into discriminated union",
    60  	"celUnion":               "celUnion demonstrates how to validate a discrminated union using CEL",
    61  }
    62  
    63  func (StableConfigTypeSpec) SwaggerDoc() map[string]string {
    64  	return map_StableConfigTypeSpec
    65  }
    66  
    67  var map_StableConfigTypeStatus = map[string]string{
    68  	"":               "StableConfigTypeStatus defines the observed status of the StableConfigType.",
    69  	"conditions":     "Represents the observations of a foo's current state. Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"",
    70  	"immutableField": "immutableField is a field that is immutable once the object has been created. It is required at all times.",
    71  }
    72  
    73  func (StableConfigTypeStatus) SwaggerDoc() map[string]string {
    74  	return map_StableConfigTypeStatus
    75  }
    76  
    77  // AUTO-GENERATED FUNCTIONS END HERE
    78
View as plain text