zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/quota/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_AppliedClusterResourceQuota = map[string]string{
    15  	"":         "AppliedClusterResourceQuota mirrors ClusterResourceQuota at a project scope, for projection into a project.  It allows a project-admin to know which ClusterResourceQuotas are applied to his project and their associated usage.\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 defines the desired quota",
    18  	"status":   "Status defines the actual enforced quota and its current usage",
    19  }
    20  
    21  func (AppliedClusterResourceQuota) SwaggerDoc() map[string]string {
    22  	return map_AppliedClusterResourceQuota
    23  }
    24  
    25  var map_AppliedClusterResourceQuotaList = map[string]string{
    26  	"":         "AppliedClusterResourceQuotaList is a collection of AppliedClusterResourceQuotas\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  	"items":    "Items is a list of AppliedClusterResourceQuota",
    29  }
    30  
    31  func (AppliedClusterResourceQuotaList) SwaggerDoc() map[string]string {
    32  	return map_AppliedClusterResourceQuotaList
    33  }
    34  
    35  var map_ClusterResourceQuota = map[string]string{
    36  	"":         "ClusterResourceQuota mirrors ResourceQuota at a cluster scope.  This object is easily convertible to synthetic ResourceQuota object to allow quota evaluation re-use.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    37  	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    38  	"spec":     "Spec defines the desired quota",
    39  	"status":   "Status defines the actual enforced quota and its current usage",
    40  }
    41  
    42  func (ClusterResourceQuota) SwaggerDoc() map[string]string {
    43  	return map_ClusterResourceQuota
    44  }
    45  
    46  var map_ClusterResourceQuotaList = map[string]string{
    47  	"":         "ClusterResourceQuotaList is a collection of ClusterResourceQuotas\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    48  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    49  	"items":    "Items is a list of ClusterResourceQuotas",
    50  }
    51  
    52  func (ClusterResourceQuotaList) SwaggerDoc() map[string]string {
    53  	return map_ClusterResourceQuotaList
    54  }
    55  
    56  var map_ClusterResourceQuotaSelector = map[string]string{
    57  	"":            "ClusterResourceQuotaSelector is used to select projects.  At least one of LabelSelector or AnnotationSelector must present.  If only one is present, it is the only selection criteria.  If both are specified, the project must match both restrictions.",
    58  	"labels":      "LabelSelector is used to select projects by label.",
    59  	"annotations": "AnnotationSelector is used to select projects by annotation.",
    60  }
    61  
    62  func (ClusterResourceQuotaSelector) SwaggerDoc() map[string]string {
    63  	return map_ClusterResourceQuotaSelector
    64  }
    65  
    66  var map_ClusterResourceQuotaSpec = map[string]string{
    67  	"":         "ClusterResourceQuotaSpec defines the desired quota restrictions",
    68  	"selector": "Selector is the selector used to match projects. It should only select active projects on the scale of dozens (though it can select many more less active projects).  These projects will contend on object creation through this resource.",
    69  	"quota":    "Quota defines the desired quota",
    70  }
    71  
    72  func (ClusterResourceQuotaSpec) SwaggerDoc() map[string]string {
    73  	return map_ClusterResourceQuotaSpec
    74  }
    75  
    76  var map_ClusterResourceQuotaStatus = map[string]string{
    77  	"":           "ClusterResourceQuotaStatus defines the actual enforced quota and its current usage",
    78  	"total":      "Total defines the actual enforced quota and its current usage across all projects",
    79  	"namespaces": "Namespaces slices the usage by project.  This division allows for quick resolution of deletion reconciliation inside of a single project without requiring a recalculation across all projects.  This can be used to pull the deltas for a given project.",
    80  }
    81  
    82  func (ClusterResourceQuotaStatus) SwaggerDoc() map[string]string {
    83  	return map_ClusterResourceQuotaStatus
    84  }
    85  
    86  var map_ResourceQuotaStatusByNamespace = map[string]string{
    87  	"":          "ResourceQuotaStatusByNamespace gives status for a particular project",
    88  	"namespace": "Namespace the project this status applies to",
    89  	"status":    "Status indicates how many resources have been consumed by this project",
    90  }
    91  
    92  func (ResourceQuotaStatusByNamespace) SwaggerDoc() map[string]string {
    93  	return map_ResourceQuotaStatusByNamespace
    94  }
    95  
    96  // AUTO-GENERATED FUNCTIONS END HERE
    97
View as plain text