zz_generated.swagger_doc_generated.go

Documentation: github.com/openshift/api/sharedresource/v1alpha1

     1  package v1alpha1
     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_SharedConfigMap = map[string]string{
    15  	"":         "SharedConfigMap allows a ConfigMap to be shared across namespaces. Pods can mount the shared ConfigMap by adding a CSI volume to the pod specification using the \"csi.sharedresource.openshift.io\" CSI driver and a reference to the SharedConfigMap in the volume attributes:\n\nspec:\n volumes:\n - name: shared-configmap\n   csi:\n     driver: csi.sharedresource.openshift.io\n     volumeAttributes:\n       sharedConfigMap: my-share\n\nFor the mount to be successful, the pod's service account must be granted permission to 'use' the named SharedConfigMap object within its namespace with an appropriate Role and RoleBinding. For compactness, here are example `oc` invocations for creating such Role and RoleBinding objects.\n\n `oc create role shared-resource-my-share --verb=use --resource=sharedconfigmaps.sharedresource.openshift.io --resource-name=my-share`\n `oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default`\n\nShared resource objects, in this case ConfigMaps, have default permissions of list, get, and watch for system authenticated users.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support.",
    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 is the specification of the desired shared configmap",
    18  	"status":   "status is the observed status of the shared configmap",
    19  }
    20  
    21  func (SharedConfigMap) SwaggerDoc() map[string]string {
    22  	return map_SharedConfigMap
    23  }
    24  
    25  var map_SharedConfigMapList = map[string]string{
    26  	"":         "SharedConfigMapList contains a list of SharedConfigMap objects.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support.",
    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  }
    29  
    30  func (SharedConfigMapList) SwaggerDoc() map[string]string {
    31  	return map_SharedConfigMapList
    32  }
    33  
    34  var map_SharedConfigMapReference = map[string]string{
    35  	"":          "SharedConfigMapReference contains information about which ConfigMap to share",
    36  	"name":      "name represents the name of the ConfigMap that is being referenced.",
    37  	"namespace": "namespace represents the namespace where the referenced ConfigMap is located.",
    38  }
    39  
    40  func (SharedConfigMapReference) SwaggerDoc() map[string]string {
    41  	return map_SharedConfigMapReference
    42  }
    43  
    44  var map_SharedConfigMapSpec = map[string]string{
    45  	"":             "SharedConfigMapSpec defines the desired state of a SharedConfigMap",
    46  	"configMapRef": "configMapRef is a reference to the ConfigMap to share",
    47  	"description":  "description is a user readable explanation of what the backing resource provides.",
    48  }
    49  
    50  func (SharedConfigMapSpec) SwaggerDoc() map[string]string {
    51  	return map_SharedConfigMapSpec
    52  }
    53  
    54  var map_SharedConfigMapStatus = map[string]string{
    55  	"":           "SharedSecretStatus contains the observed status of the shared resource",
    56  	"conditions": "conditions represents any observations made on this particular shared resource by the underlying CSI driver or Share controller.",
    57  }
    58  
    59  func (SharedConfigMapStatus) SwaggerDoc() map[string]string {
    60  	return map_SharedConfigMapStatus
    61  }
    62  
    63  var map_SharedSecret = map[string]string{
    64  	"":         "SharedSecret allows a Secret to be shared across namespaces. Pods can mount the shared Secret by adding a CSI volume to the pod specification using the \"csi.sharedresource.openshift.io\" CSI driver and a reference to the SharedSecret in the volume attributes:\n\nspec:\n volumes:\n - name: shared-secret\n   csi:\n     driver: csi.sharedresource.openshift.io\n     volumeAttributes:\n       sharedSecret: my-share\n\nFor the mount to be successful, the pod's service account must be granted permission to 'use' the named SharedSecret object within its namespace with an appropriate Role and RoleBinding. For compactness, here are example `oc` invocations for creating such Role and RoleBinding objects.\n\n `oc create role shared-resource-my-share --verb=use --resource=sharedsecrets.sharedresource.openshift.io --resource-name=my-share`\n `oc create rolebinding shared-resource-my-share --role=shared-resource-my-share --serviceaccount=my-namespace:default`\n\nShared resource objects, in this case Secrets, have default permissions of list, get, and watch for system authenticated users.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support.",
    65  	"metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    66  	"spec":     "spec is the specification of the desired shared secret",
    67  	"status":   "status is the observed status of the shared secret",
    68  }
    69  
    70  func (SharedSecret) SwaggerDoc() map[string]string {
    71  	return map_SharedSecret
    72  }
    73  
    74  var map_SharedSecretList = map[string]string{
    75  	"":         "SharedSecretList contains a list of SharedSecret objects.\n\nCompatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. These capabilities should not be used by applications needing long term support.",
    76  	"metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
    77  }
    78  
    79  func (SharedSecretList) SwaggerDoc() map[string]string {
    80  	return map_SharedSecretList
    81  }
    82  
    83  var map_SharedSecretReference = map[string]string{
    84  	"":          "SharedSecretReference contains information about which Secret to share",
    85  	"name":      "name represents the name of the Secret that is being referenced.",
    86  	"namespace": "namespace represents the namespace where the referenced Secret is located.",
    87  }
    88  
    89  func (SharedSecretReference) SwaggerDoc() map[string]string {
    90  	return map_SharedSecretReference
    91  }
    92  
    93  var map_SharedSecretSpec = map[string]string{
    94  	"":            "SharedSecretSpec defines the desired state of a SharedSecret",
    95  	"secretRef":   "secretRef is a reference to the Secret to share",
    96  	"description": "description is a user readable explanation of what the backing resource provides.",
    97  }
    98  
    99  func (SharedSecretSpec) SwaggerDoc() map[string]string {
   100  	return map_SharedSecretSpec
   101  }
   102  
   103  var map_SharedSecretStatus = map[string]string{
   104  	"":           "SharedSecretStatus contains the observed status of the shared resource",
   105  	"conditions": "conditions represents any observations made on this particular shared resource by the underlying CSI driver or Share controller.",
   106  }
   107  
   108  func (SharedSecretStatus) SwaggerDoc() map[string]string {
   109  	return map_SharedSecretStatus
   110  }
   111  
   112  // AUTO-GENERATED FUNCTIONS END HERE
   113
View as plain text