...

Source file src/github.com/openshift/api/authorization/v1/zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/authorization/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_Action = map[string]string{
    15  	"":                   "Action describes a request to the API server",
    16  	"namespace":          "Namespace is the namespace of the action being requested.  Currently, there is no distinction between no namespace and all namespaces",
    17  	"verb":               "Verb is one of: get, list, watch, create, update, delete",
    18  	"resourceAPIGroup":   "Group is the API group of the resource Serialized as resourceAPIGroup to avoid confusion with the 'groups' field when inlined",
    19  	"resourceAPIVersion": "Version is the API version of the resource Serialized as resourceAPIVersion to avoid confusion with TypeMeta.apiVersion and ObjectMeta.resourceVersion when inlined",
    20  	"resource":           "Resource is one of the existing resource types",
    21  	"resourceName":       "ResourceName is the name of the resource being requested for a \"get\" or deleted for a \"delete\"",
    22  	"path":               "Path is the path of a non resource URL",
    23  	"isNonResourceURL":   "IsNonResourceURL is true if this is a request for a non-resource URL (outside of the resource hierarchy)",
    24  	"content":            "Content is the actual content of the request for create and update",
    25  }
    26  
    27  func (Action) SwaggerDoc() map[string]string {
    28  	return map_Action
    29  }
    30  
    31  var map_ClusterRole = map[string]string{
    32  	"":                "ClusterRole is a logical grouping of PolicyRules that can be referenced as a unit by ClusterRoleBindings.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    33  	"metadata":        "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    34  	"rules":           "Rules holds all the PolicyRules for this ClusterRole",
    35  	"aggregationRule": "AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.",
    36  }
    37  
    38  func (ClusterRole) SwaggerDoc() map[string]string {
    39  	return map_ClusterRole
    40  }
    41  
    42  var map_ClusterRoleBinding = map[string]string{
    43  	"":           "ClusterRoleBinding references a ClusterRole, but not contain it.  It can reference any ClusterRole in the same namespace or in the global namespace. It adds who information via (Users and Groups) OR Subjects and namespace information by which namespace it exists in. ClusterRoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    44  	"metadata":   "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    45  	"userNames":  "UserNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.",
    46  	"groupNames": "GroupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.",
    47  	"subjects":   "Subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.",
    48  	"roleRef":    "RoleRef can only reference the current namespace and the global namespace. If the ClusterRoleRef cannot be resolved, the Authorizer must return an error. Since Policy is a singleton, this is sufficient knowledge to locate a role.",
    49  }
    50  
    51  func (ClusterRoleBinding) SwaggerDoc() map[string]string {
    52  	return map_ClusterRoleBinding
    53  }
    54  
    55  var map_ClusterRoleBindingList = map[string]string{
    56  	"":         "ClusterRoleBindingList is a collection of ClusterRoleBindings\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    57  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    58  	"items":    "Items is a list of ClusterRoleBindings",
    59  }
    60  
    61  func (ClusterRoleBindingList) SwaggerDoc() map[string]string {
    62  	return map_ClusterRoleBindingList
    63  }
    64  
    65  var map_ClusterRoleList = map[string]string{
    66  	"":         "ClusterRoleList is a collection of ClusterRoles\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    67  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    68  	"items":    "Items is a list of ClusterRoles",
    69  }
    70  
    71  func (ClusterRoleList) SwaggerDoc() map[string]string {
    72  	return map_ClusterRoleList
    73  }
    74  
    75  var map_GroupRestriction = map[string]string{
    76  	"":       "GroupRestriction matches a group either by a string match on the group name or a label selector applied to group labels.",
    77  	"groups": "Groups is a list of groups used to match against an individual user's groups. If the user is a member of one of the whitelisted groups, the user is allowed to be bound to a role.",
    78  	"labels": "Selectors specifies a list of label selectors over group labels.",
    79  }
    80  
    81  func (GroupRestriction) SwaggerDoc() map[string]string {
    82  	return map_GroupRestriction
    83  }
    84  
    85  var map_IsPersonalSubjectAccessReview = map[string]string{
    86  	"": "IsPersonalSubjectAccessReview is a marker for PolicyRule.AttributeRestrictions that denotes that subjectaccessreviews on self should be allowed\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    87  }
    88  
    89  func (IsPersonalSubjectAccessReview) SwaggerDoc() map[string]string {
    90  	return map_IsPersonalSubjectAccessReview
    91  }
    92  
    93  var map_LocalResourceAccessReview = map[string]string{
    94  	"": "LocalResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec in a particular namespace\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
    95  }
    96  
    97  func (LocalResourceAccessReview) SwaggerDoc() map[string]string {
    98  	return map_LocalResourceAccessReview
    99  }
   100  
   101  var map_LocalSubjectAccessReview = map[string]string{
   102  	"":       "LocalSubjectAccessReview is an object for requesting information about whether a user or group can perform an action in a particular namespace\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   103  	"user":   "User is optional.  If both User and Groups are empty, the current authenticated user is used.",
   104  	"groups": "Groups is optional.  Groups is the list of groups to which the User belongs.",
   105  	"scopes": "Scopes to use for the evaluation.  Empty means \"use the unscoped (full) permissions of the user/groups\". Nil for a self-SAR, means \"use the scopes on this request\". Nil for a regular SAR, means the same as empty.",
   106  }
   107  
   108  func (LocalSubjectAccessReview) SwaggerDoc() map[string]string {
   109  	return map_LocalSubjectAccessReview
   110  }
   111  
   112  var map_NamedClusterRole = map[string]string{
   113  	"":     "NamedClusterRole relates a name with a cluster role",
   114  	"name": "Name is the name of the cluster role",
   115  	"role": "Role is the cluster role being named",
   116  }
   117  
   118  func (NamedClusterRole) SwaggerDoc() map[string]string {
   119  	return map_NamedClusterRole
   120  }
   121  
   122  var map_NamedClusterRoleBinding = map[string]string{
   123  	"":            "NamedClusterRoleBinding relates a name with a cluster role binding",
   124  	"name":        "Name is the name of the cluster role binding",
   125  	"roleBinding": "RoleBinding is the cluster role binding being named",
   126  }
   127  
   128  func (NamedClusterRoleBinding) SwaggerDoc() map[string]string {
   129  	return map_NamedClusterRoleBinding
   130  }
   131  
   132  var map_NamedRole = map[string]string{
   133  	"":     "NamedRole relates a Role with a name",
   134  	"name": "Name is the name of the role",
   135  	"role": "Role is the role being named",
   136  }
   137  
   138  func (NamedRole) SwaggerDoc() map[string]string {
   139  	return map_NamedRole
   140  }
   141  
   142  var map_NamedRoleBinding = map[string]string{
   143  	"":            "NamedRoleBinding relates a role binding with a name",
   144  	"name":        "Name is the name of the role binding",
   145  	"roleBinding": "RoleBinding is the role binding being named",
   146  }
   147  
   148  func (NamedRoleBinding) SwaggerDoc() map[string]string {
   149  	return map_NamedRoleBinding
   150  }
   151  
   152  var map_PolicyRule = map[string]string{
   153  	"":                      "PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.",
   154  	"verbs":                 "Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule.  VerbAll represents all kinds.",
   155  	"attributeRestrictions": "AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error.",
   156  	"apiGroups":             "APIGroups is the name of the APIGroup that contains the resources.  If this field is empty, then both kubernetes and origin API groups are assumed. That means that if an action is requested against one of the enumerated resources in either the kubernetes or the origin API group, the request will be allowed",
   157  	"resources":             "Resources is a list of resources this rule applies to.  ResourceAll represents all resources.",
   158  	"resourceNames":         "ResourceNames is an optional white list of names that the rule applies to.  An empty set means that everything is allowed.",
   159  	"nonResourceURLs":       "NonResourceURLsSlice is a set of partial urls that a user should have access to.  *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different.",
   160  }
   161  
   162  func (PolicyRule) SwaggerDoc() map[string]string {
   163  	return map_PolicyRule
   164  }
   165  
   166  var map_ResourceAccessReview = map[string]string{
   167  	"": "ResourceAccessReview is a means to request a list of which users and groups are authorized to perform the action specified by spec\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   168  }
   169  
   170  func (ResourceAccessReview) SwaggerDoc() map[string]string {
   171  	return map_ResourceAccessReview
   172  }
   173  
   174  var map_ResourceAccessReviewResponse = map[string]string{
   175  	"":               "ResourceAccessReviewResponse describes who can perform the action\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   176  	"namespace":      "Namespace is the namespace used for the access review",
   177  	"users":          "UsersSlice is the list of users who can perform the action",
   178  	"groups":         "GroupsSlice is the list of groups who can perform the action",
   179  	"evalutionError": "EvaluationError is an indication that some error occurred during resolution, but partial results can still be returned. It is entirely possible to get an error and be able to continue determine authorization status in spite of it.  This is most common when a bound role is missing, but enough roles are still present and bound to reason about the request.",
   180  }
   181  
   182  func (ResourceAccessReviewResponse) SwaggerDoc() map[string]string {
   183  	return map_ResourceAccessReviewResponse
   184  }
   185  
   186  var map_Role = map[string]string{
   187  	"":         "Role is a logical grouping of PolicyRules that can be referenced as a unit by RoleBindings.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   188  	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
   189  	"rules":    "Rules holds all the PolicyRules for this Role",
   190  }
   191  
   192  func (Role) SwaggerDoc() map[string]string {
   193  	return map_Role
   194  }
   195  
   196  var map_RoleBinding = map[string]string{
   197  	"":           "RoleBinding references a Role, but not contain it.  It can reference any Role in the same namespace or in the global namespace. It adds who information via (Users and Groups) OR Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace (excepting the master namespace which has power in all namespaces).\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   198  	"metadata":   "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
   199  	"userNames":  "UserNames holds all the usernames directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.",
   200  	"groupNames": "GroupNames holds all the groups directly bound to the role. This field should only be specified when supporting legacy clients and servers. See Subjects for further details.",
   201  	"subjects":   "Subjects hold object references to authorize with this rule. This field is ignored if UserNames or GroupNames are specified to support legacy clients and servers. Thus newer clients that do not need to support backwards compatibility should send only fully qualified Subjects and should omit the UserNames and GroupNames fields. Clients that need to support backwards compatibility can use this field to build the UserNames and GroupNames.",
   202  	"roleRef":    "RoleRef can only reference the current namespace and the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. Since Policy is a singleton, this is sufficient knowledge to locate a role.",
   203  }
   204  
   205  func (RoleBinding) SwaggerDoc() map[string]string {
   206  	return map_RoleBinding
   207  }
   208  
   209  var map_RoleBindingList = map[string]string{
   210  	"":         "RoleBindingList is a collection of RoleBindings\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   211  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
   212  	"items":    "Items is a list of RoleBindings",
   213  }
   214  
   215  func (RoleBindingList) SwaggerDoc() map[string]string {
   216  	return map_RoleBindingList
   217  }
   218  
   219  var map_RoleBindingRestriction = map[string]string{
   220  	"":         "RoleBindingRestriction is an object that can be matched against a subject (user, group, or service account) to determine whether rolebindings on that subject are allowed in the namespace to which the RoleBindingRestriction belongs.  If any one of those RoleBindingRestriction objects matches a subject, rolebindings on that subject in the namespace are allowed.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   221  	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
   222  	"spec":     "Spec defines the matcher.",
   223  }
   224  
   225  func (RoleBindingRestriction) SwaggerDoc() map[string]string {
   226  	return map_RoleBindingRestriction
   227  }
   228  
   229  var map_RoleBindingRestrictionList = map[string]string{
   230  	"":         "RoleBindingRestrictionList is a collection of RoleBindingRestriction objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   231  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
   232  	"items":    "Items is a list of RoleBindingRestriction objects.",
   233  }
   234  
   235  func (RoleBindingRestrictionList) SwaggerDoc() map[string]string {
   236  	return map_RoleBindingRestrictionList
   237  }
   238  
   239  var map_RoleBindingRestrictionSpec = map[string]string{
   240  	"":                          "RoleBindingRestrictionSpec defines a rolebinding restriction.  Exactly one field must be non-nil.",
   241  	"userrestriction":           "UserRestriction matches against user subjects.",
   242  	"grouprestriction":          "GroupRestriction matches against group subjects.",
   243  	"serviceaccountrestriction": "ServiceAccountRestriction matches against service-account subjects.",
   244  }
   245  
   246  func (RoleBindingRestrictionSpec) SwaggerDoc() map[string]string {
   247  	return map_RoleBindingRestrictionSpec
   248  }
   249  
   250  var map_RoleList = map[string]string{
   251  	"":         "RoleList is a collection of Roles\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   252  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
   253  	"items":    "Items is a list of Roles",
   254  }
   255  
   256  func (RoleList) SwaggerDoc() map[string]string {
   257  	return map_RoleList
   258  }
   259  
   260  var map_SelfSubjectRulesReview = map[string]string{
   261  	"":       "SelfSubjectRulesReview is a resource you can create to determine which actions you can perform in a namespace\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   262  	"spec":   "Spec adds information about how to conduct the check",
   263  	"status": "Status is completed by the server to tell which permissions you have",
   264  }
   265  
   266  func (SelfSubjectRulesReview) SwaggerDoc() map[string]string {
   267  	return map_SelfSubjectRulesReview
   268  }
   269  
   270  var map_SelfSubjectRulesReviewSpec = map[string]string{
   271  	"":       "SelfSubjectRulesReviewSpec adds information about how to conduct the check",
   272  	"scopes": "Scopes to use for the evaluation.  Empty means \"use the unscoped (full) permissions of the user/groups\". Nil means \"use the scopes on this request\".",
   273  }
   274  
   275  func (SelfSubjectRulesReviewSpec) SwaggerDoc() map[string]string {
   276  	return map_SelfSubjectRulesReviewSpec
   277  }
   278  
   279  var map_ServiceAccountReference = map[string]string{
   280  	"":          "ServiceAccountReference specifies a service account and namespace by their names.",
   281  	"name":      "Name is the name of the service account.",
   282  	"namespace": "Namespace is the namespace of the service account.  Service accounts from inside the whitelisted namespaces are allowed to be bound to roles.  If Namespace is empty, then the namespace of the RoleBindingRestriction in which the ServiceAccountReference is embedded is used.",
   283  }
   284  
   285  func (ServiceAccountReference) SwaggerDoc() map[string]string {
   286  	return map_ServiceAccountReference
   287  }
   288  
   289  var map_ServiceAccountRestriction = map[string]string{
   290  	"":                "ServiceAccountRestriction matches a service account by a string match on either the service-account name or the name of the service account's namespace.",
   291  	"serviceaccounts": "ServiceAccounts specifies a list of literal service-account names.",
   292  	"namespaces":      "Namespaces specifies a list of literal namespace names.",
   293  }
   294  
   295  func (ServiceAccountRestriction) SwaggerDoc() map[string]string {
   296  	return map_ServiceAccountRestriction
   297  }
   298  
   299  var map_SubjectAccessReview = map[string]string{
   300  	"":       "SubjectAccessReview is an object for requesting information about whether a user or group can perform an action\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   301  	"user":   "User is optional. If both User and Groups are empty, the current authenticated user is used.",
   302  	"groups": "GroupsSlice is optional. Groups is the list of groups to which the User belongs.",
   303  	"scopes": "Scopes to use for the evaluation.  Empty means \"use the unscoped (full) permissions of the user/groups\". Nil for a self-SAR, means \"use the scopes on this request\". Nil for a regular SAR, means the same as empty.",
   304  }
   305  
   306  func (SubjectAccessReview) SwaggerDoc() map[string]string {
   307  	return map_SubjectAccessReview
   308  }
   309  
   310  var map_SubjectAccessReviewResponse = map[string]string{
   311  	"":                "SubjectAccessReviewResponse describes whether or not a user or group can perform an action\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   312  	"namespace":       "Namespace is the namespace used for the access review",
   313  	"allowed":         "Allowed is required.  True if the action would be allowed, false otherwise.",
   314  	"reason":          "Reason is optional.  It indicates why a request was allowed or denied.",
   315  	"evaluationError": "EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it.  This is most common when a bound role is missing, but enough roles are still present and bound to reason about the request.",
   316  }
   317  
   318  func (SubjectAccessReviewResponse) SwaggerDoc() map[string]string {
   319  	return map_SubjectAccessReviewResponse
   320  }
   321  
   322  var map_SubjectRulesReview = map[string]string{
   323  	"":       "SubjectRulesReview is a resource you can create to determine which actions another user can perform in a namespace\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
   324  	"spec":   "Spec adds information about how to conduct the check",
   325  	"status": "Status is completed by the server to tell which permissions you have",
   326  }
   327  
   328  func (SubjectRulesReview) SwaggerDoc() map[string]string {
   329  	return map_SubjectRulesReview
   330  }
   331  
   332  var map_SubjectRulesReviewSpec = map[string]string{
   333  	"":       "SubjectRulesReviewSpec adds information about how to conduct the check",
   334  	"user":   "User is optional.  At least one of User and Groups must be specified.",
   335  	"groups": "Groups is optional.  Groups is the list of groups to which the User belongs.  At least one of User and Groups must be specified.",
   336  	"scopes": "Scopes to use for the evaluation.  Empty means \"use the unscoped (full) permissions of the user/groups\".",
   337  }
   338  
   339  func (SubjectRulesReviewSpec) SwaggerDoc() map[string]string {
   340  	return map_SubjectRulesReviewSpec
   341  }
   342  
   343  var map_SubjectRulesReviewStatus = map[string]string{
   344  	"":                "SubjectRulesReviewStatus is contains the result of a rules check",
   345  	"rules":           "Rules is the list of rules (no particular sort) that are allowed for the subject",
   346  	"evaluationError": "EvaluationError can appear in combination with Rules.  It means some error happened during evaluation that may have prevented additional rules from being populated.",
   347  }
   348  
   349  func (SubjectRulesReviewStatus) SwaggerDoc() map[string]string {
   350  	return map_SubjectRulesReviewStatus
   351  }
   352  
   353  var map_UserRestriction = map[string]string{
   354  	"":       "UserRestriction matches a user either by a string match on the user name, a string match on the name of a group to which the user belongs, or a label selector applied to the user labels.",
   355  	"users":  "Users specifies a list of literal user names.",
   356  	"groups": "Groups specifies a list of literal group names.",
   357  	"labels": "Selectors specifies a list of label selectors over user labels.",
   358  }
   359  
   360  func (UserRestriction) SwaggerDoc() map[string]string {
   361  	return map_UserRestriction
   362  }
   363  
   364  // AUTO-GENERATED FUNCTIONS END HERE
   365  

View as plain text