Matthias Andreas Benkard | 832a54e | 2019-01-29 09:27:38 +0100 | [diff] [blame] | 1 | /* |
| 2 | Copyright The Kubernetes Authors. |
| 3 | |
| 4 | Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | you may not use this file except in compliance with the License. |
| 6 | You may obtain a copy of the License at |
| 7 | |
| 8 | http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | |
| 10 | Unless required by applicable law or agreed to in writing, software |
| 11 | distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | See the License for the specific language governing permissions and |
| 14 | limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package v1beta1 |
| 18 | |
| 19 | // This file contains a collection of methods that can be used from go-restful to |
| 20 | // generate Swagger API documentation for its models. Please read this PR for more |
| 21 | // information on the implementation: https://github.com/emicklei/go-restful/pull/215 |
| 22 | // |
| 23 | // TODOs are ignored from the parser (e.g. TODO(andronat):... || TODO:...) if and only if |
| 24 | // they are on one line! For multiple line or blocks that you want to ignore use ---. |
| 25 | // Any context after a --- is ignored. |
| 26 | // |
| 27 | // Those methods can be generated by using hack/update-generated-swagger-docs.sh |
| 28 | |
| 29 | // AUTO-GENERATED FUNCTIONS START HERE. DO NOT EDIT. |
| 30 | var map_TokenReview = map[string]string{ |
| 31 | "": "TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.", |
| 32 | "spec": "Spec holds information about the request being evaluated", |
| 33 | "status": "Status is filled in by the server and indicates whether the request can be authenticated.", |
| 34 | } |
| 35 | |
| 36 | func (TokenReview) SwaggerDoc() map[string]string { |
| 37 | return map_TokenReview |
| 38 | } |
| 39 | |
| 40 | var map_TokenReviewSpec = map[string]string{ |
| 41 | "": "TokenReviewSpec is a description of the token authentication request.", |
| 42 | "token": "Token is the opaque bearer token.", |
| 43 | } |
| 44 | |
| 45 | func (TokenReviewSpec) SwaggerDoc() map[string]string { |
| 46 | return map_TokenReviewSpec |
| 47 | } |
| 48 | |
| 49 | var map_TokenReviewStatus = map[string]string{ |
| 50 | "": "TokenReviewStatus is the result of the token authentication request.", |
| 51 | "authenticated": "Authenticated indicates that the token was associated with a known user.", |
| 52 | "user": "User is the UserInfo associated with the provided token.", |
| 53 | "error": "Error indicates that the token couldn't be checked", |
| 54 | } |
| 55 | |
| 56 | func (TokenReviewStatus) SwaggerDoc() map[string]string { |
| 57 | return map_TokenReviewStatus |
| 58 | } |
| 59 | |
| 60 | var map_UserInfo = map[string]string{ |
| 61 | "": "UserInfo holds the information about the user needed to implement the user.Info interface.", |
| 62 | "username": "The name that uniquely identifies this user among all active users.", |
| 63 | "uid": "A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.", |
| 64 | "groups": "The names of groups this user is a part of.", |
| 65 | "extra": "Any additional information provided by the authenticator.", |
| 66 | } |
| 67 | |
| 68 | func (UserInfo) SwaggerDoc() map[string]string { |
| 69 | return map_UserInfo |
| 70 | } |
| 71 | |
| 72 | // AUTO-GENERATED FUNCTIONS END HERE |