zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/project/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_Project = map[string]string{
    15  	"":         "Projects are the unit of isolation and collaboration in OpenShift. A project has one or more members, a quota on the resources that the project may consume, and the security controls on the resources in the project. Within a project, members may have different roles - project administrators can set membership, editors can create and manage the resources, and viewers can see but not access running containers. In a normal cluster project administrators are not able to alter their quotas - that is restricted to cluster administrators.\n\nListing or watching projects will return only projects the user has the reader role on.\n\nAn OpenShift project is an alternative representation of a Kubernetes namespace. Projects are exposed as editable to end users while namespaces are not. Direct creation of a project is typically restricted to administrators, while end users should use the requestproject resource.\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 behavior of the Namespace.",
    18  	"status":   "Status describes the current status of a Namespace",
    19  }
    20  
    21  func (Project) SwaggerDoc() map[string]string {
    22  	return map_Project
    23  }
    24  
    25  var map_ProjectList = map[string]string{
    26  	"":         "ProjectList is a list of Project objects.\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 the list of projects",
    29  }
    30  
    31  func (ProjectList) SwaggerDoc() map[string]string {
    32  	return map_ProjectList
    33  }
    34  
    35  var map_ProjectRequest = map[string]string{
    36  	"":            "ProjectRequest is the set of options necessary to fully qualify a project request\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  	"displayName": "DisplayName is the display name to apply to a project",
    39  	"description": "Description is the description to apply to a project",
    40  }
    41  
    42  func (ProjectRequest) SwaggerDoc() map[string]string {
    43  	return map_ProjectRequest
    44  }
    45  
    46  var map_ProjectSpec = map[string]string{
    47  	"":           "ProjectSpec describes the attributes on a Project",
    48  	"finalizers": "Finalizers is an opaque list of values that must be empty to permanently remove object from storage",
    49  }
    50  
    51  func (ProjectSpec) SwaggerDoc() map[string]string {
    52  	return map_ProjectSpec
    53  }
    54  
    55  var map_ProjectStatus = map[string]string{
    56  	"":           "ProjectStatus is information about the current status of a Project",
    57  	"phase":      "Phase is the current lifecycle phase of the project",
    58  	"conditions": "Represents the latest available observations of the project current state.",
    59  }
    60  
    61  func (ProjectStatus) SwaggerDoc() map[string]string {
    62  	return map_ProjectStatus
    63  }
    64  
    65  // AUTO-GENERATED FUNCTIONS END HERE
    66
View as plain text