zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/user/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_Group = map[string]string{
    15  	"":         "Group represents a referenceable set of Users\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  	"users":    "Users is the list of users in this group.",
    18  }
    19  
    20  func (Group) SwaggerDoc() map[string]string {
    21  	return map_Group
    22  }
    23  
    24  var map_GroupList = map[string]string{
    25  	"":         "GroupList is a collection of Groups\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    26  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    27  	"items":    "Items is the list of groups",
    28  }
    29  
    30  func (GroupList) SwaggerDoc() map[string]string {
    31  	return map_GroupList
    32  }
    33  
    34  var map_Identity = map[string]string{
    35  	"":                 "Identity records a successful authentication of a user with an identity provider. The information about the source of authentication is stored on the identity, and the identity is then associated with a single user object. Multiple identities can reference a single user. Information retrieved from the authentication provider is stored in the extra field using a schema determined by the provider.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    36  	"metadata":         "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    37  	"providerName":     "ProviderName is the source of identity information",
    38  	"providerUserName": "ProviderUserName uniquely represents this identity in the scope of the provider",
    39  	"user":             "User is a reference to the user this identity is associated with Both Name and UID must be set",
    40  	"extra":            "Extra holds extra information about this identity",
    41  }
    42  
    43  func (Identity) SwaggerDoc() map[string]string {
    44  	return map_Identity
    45  }
    46  
    47  var map_IdentityList = map[string]string{
    48  	"":         "IdentityList is a collection of Identities\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    49  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    50  	"items":    "Items is the list of identities",
    51  }
    52  
    53  func (IdentityList) SwaggerDoc() map[string]string {
    54  	return map_IdentityList
    55  }
    56  
    57  var map_User = map[string]string{
    58  	"":           "Upon log in, every user of the system receives a User and Identity resource. Administrators may directly manipulate the attributes of the users for their own tracking, or set groups via the API. The user name is unique and is chosen based on the value provided by the identity provider - if a user already exists with the incoming name, the user name may have a number appended to it depending on the configuration of the system.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    59  	"metadata":   "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    60  	"fullName":   "FullName is the full name of user",
    61  	"identities": "Identities are the identities associated with this user",
    62  	"groups":     "Groups specifies group names this user is a member of. This field is deprecated and will be removed in a future release. Instead, create a Group object containing the name of this User.",
    63  }
    64  
    65  func (User) SwaggerDoc() map[string]string {
    66  	return map_User
    67  }
    68  
    69  var map_UserIdentityMapping = map[string]string{
    70  	"":         "UserIdentityMapping maps a user to an identity\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    71  	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    72  	"identity": "Identity is a reference to an identity",
    73  	"user":     "User is a reference to a user",
    74  }
    75  
    76  func (UserIdentityMapping) SwaggerDoc() map[string]string {
    77  	return map_UserIdentityMapping
    78  }
    79  
    80  var map_UserList = map[string]string{
    81  	"":         "UserList is a collection of Users\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    82  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    83  	"items":    "Items is the list of users",
    84  }
    85  
    86  func (UserList) SwaggerDoc() map[string]string {
    87  	return map_UserList
    88  }
    89  
    90  // AUTO-GENERATED FUNCTIONS END HERE
    91
View as plain text