"summary":"list or watch objects of kind PodDisruptionBudget",
"nickname":"listNamespacedPodDisruptionBudget",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"labelSelector",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"fieldSelector",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"includeUninitialized",
"description":"If true, partially initialized resources are included in the response.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"watch",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"resourceVersion",
"description":"When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"continue",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"namespace",
"description":"object name and auth scope, such as for teams and projects",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"labelSelector",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"fieldSelector",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"includeUninitialized",
"description":"If true, partially initialized resources are included in the response.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"watch",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"resourceVersion",
"description":"When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"continue",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"namespace",
"description":"object name and auth scope, such as for teams and projects",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"labelSelector",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"fieldSelector",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"includeUninitialized",
"description":"If true, partially initialized resources are included in the response.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"watch",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"resourceVersion",
"description":"When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"continue",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"namespace",
"description":"object name and auth scope, such as for teams and projects",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"v1beta1.PodDisruptionBudget",
"paramType":"body",
"name":"body",
"description":"",
"required":true,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"namespace",
"description":"object name and auth scope, such as for teams and projects",
"required":true,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"name",
"description":"name of the PodDisruptionBudget",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.PodDisruptionBudget"
},
{
"code":201,
"message":"Created",
"responseModel":"v1beta1.PodDisruptionBudget"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"*/*"
]
},
{
"type":"v1beta1.PodDisruptionBudget",
"method":"PATCH",
"summary":"partially update the specified PodDisruptionBudget",
"nickname":"patchNamespacedPodDisruptionBudget",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"v1.Patch",
"paramType":"body",
"name":"body",
"description":"",
"required":true,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"namespace",
"description":"object name and auth scope, such as for teams and projects",
"required":true,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"name",
"description":"name of the PodDisruptionBudget",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.PodDisruptionBudget"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"application/json-patch+json",
"application/merge-patch+json",
"application/strategic-merge-patch+json"
]
},
{
"type":"v1.Status",
"method":"DELETE",
"summary":"delete a PodDisruptionBudget",
"nickname":"deleteNamespacedPodDisruptionBudget",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"v1.DeleteOptions",
"paramType":"body",
"name":"body",
"description":"",
"required":true,
"allowMultiple":false
},
{
"type":"integer",
"paramType":"query",
"name":"gracePeriodSeconds",
"description":"The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"orphanDependents",
"description":"Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"propagationPolicy",
"description":"Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"namespace",
"description":"object name and auth scope, such as for teams and projects",
"summary":"watch changes to an object of kind PodDisruptionBudget",
"nickname":"watchNamespacedPodDisruptionBudget",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"labelSelector",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"fieldSelector",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"includeUninitialized",
"description":"If true, partially initialized resources are included in the response.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"watch",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"resourceVersion",
"description":"When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"continue",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"namespace",
"description":"object name and auth scope, such as for teams and projects",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"labelSelector",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"fieldSelector",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"includeUninitialized",
"description":"If true, partially initialized resources are included in the response.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"watch",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"resourceVersion",
"description":"When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"continue",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"labelSelector",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"fieldSelector",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"includeUninitialized",
"description":"If true, partially initialized resources are included in the response.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"watch",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"resourceVersion",
"description":"When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"continue",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"summary":"list or watch objects of kind PodSecurityPolicy",
"nickname":"listPodSecurityPolicy",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"labelSelector",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"fieldSelector",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"includeUninitialized",
"description":"If true, partially initialized resources are included in the response.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"watch",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"resourceVersion",
"description":"When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.",
"required":false,
"allowMultiple":false
},
{
"type":"integer",
"paramType":"query",
"name":"timeoutSeconds",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"required":false,
"allowMultiple":false
},
{
"type":"integer",
"paramType":"query",
"name":"limit",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"continue",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"v1beta1.PodSecurityPolicy",
"paramType":"body",
"name":"body",
"description":"",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.PodSecurityPolicy"
},
{
"code":201,
"message":"Created",
"responseModel":"v1beta1.PodSecurityPolicy"
},
{
"code":202,
"message":"Accepted",
"responseModel":"v1beta1.PodSecurityPolicy"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"*/*"
]
},
{
"type":"v1.Status",
"method":"DELETE",
"summary":"delete collection of PodSecurityPolicy",
"nickname":"deletecollectionPodSecurityPolicy",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"labelSelector",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"fieldSelector",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"includeUninitialized",
"description":"If true, partially initialized resources are included in the response.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"watch",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"resourceVersion",
"description":"When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.",
"required":false,
"allowMultiple":false
},
{
"type":"integer",
"paramType":"query",
"name":"timeoutSeconds",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"required":false,
"allowMultiple":false
},
{
"type":"integer",
"paramType":"query",
"name":"limit",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"continue",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"summary":"watch individual changes to a list of PodSecurityPolicy",
"nickname":"watchPodSecurityPolicyList",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"labelSelector",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"fieldSelector",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"includeUninitialized",
"description":"If true, partially initialized resources are included in the response.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"watch",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"resourceVersion",
"description":"When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.",
"required":false,
"allowMultiple":false
},
{
"type":"integer",
"paramType":"query",
"name":"timeoutSeconds",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"required":false,
"allowMultiple":false
},
{
"type":"integer",
"paramType":"query",
"name":"limit",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"continue",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"export",
"description":"Should this value be exported. Export strips fields that a user can not specify.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"exact",
"description":"Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"name",
"description":"name of the PodSecurityPolicy",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.PodSecurityPolicy"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"*/*"
]
},
{
"type":"v1beta1.PodSecurityPolicy",
"method":"PUT",
"summary":"replace the specified PodSecurityPolicy",
"nickname":"replacePodSecurityPolicy",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"v1beta1.PodSecurityPolicy",
"paramType":"body",
"name":"body",
"description":"",
"required":true,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"name",
"description":"name of the PodSecurityPolicy",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.PodSecurityPolicy"
},
{
"code":201,
"message":"Created",
"responseModel":"v1beta1.PodSecurityPolicy"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"*/*"
]
},
{
"type":"v1beta1.PodSecurityPolicy",
"method":"PATCH",
"summary":"partially update the specified PodSecurityPolicy",
"nickname":"patchPodSecurityPolicy",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"v1.Patch",
"paramType":"body",
"name":"body",
"description":"",
"required":true,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"name",
"description":"name of the PodSecurityPolicy",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.PodSecurityPolicy"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"application/json-patch+json",
"application/merge-patch+json",
"application/strategic-merge-patch+json"
]
},
{
"type":"v1.Status",
"method":"DELETE",
"summary":"delete a PodSecurityPolicy",
"nickname":"deletePodSecurityPolicy",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"v1.DeleteOptions",
"paramType":"body",
"name":"body",
"description":"",
"required":true,
"allowMultiple":false
},
{
"type":"integer",
"paramType":"query",
"name":"gracePeriodSeconds",
"description":"The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"orphanDependents",
"description":"Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"propagationPolicy",
"description":"Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
"summary":"watch changes to an object of kind PodSecurityPolicy",
"nickname":"watchPodSecurityPolicy",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"labelSelector",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"fieldSelector",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"includeUninitialized",
"description":"If true, partially initialized resources are included in the response.",
"required":false,
"allowMultiple":false
},
{
"type":"boolean",
"paramType":"query",
"name":"watch",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"resourceVersion",
"description":"When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.",
"required":false,
"allowMultiple":false
},
{
"type":"integer",
"paramType":"query",
"name":"timeoutSeconds",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"required":false,
"allowMultiple":false
},
{
"type":"integer",
"paramType":"query",
"name":"limit",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"required":false,
"allowMultiple":false
},
{
"type":"string",
"paramType":"query",
"name":"continue",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"description":"PodDisruptionBudgetList is a collection of PodDisruptionBudgets.",
"required":[
"items"
],
"properties":{
"kind":{
"type":"string",
"description":"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
},
"apiVersion":{
"type":"string",
"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"
},
"metadata":{
"$ref":"v1.ListMeta"
},
"items":{
"type":"array",
"items":{
"$ref":"v1beta1.PodDisruptionBudget"
}
}
}
},
"v1.ListMeta":{
"id":"v1.ListMeta",
"description":"ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.",
"properties":{
"selfLink":{
"type":"string",
"description":"selfLink is a URL representing this object. Populated by the system. Read-only."
},
"resourceVersion":{
"type":"string",
"description":"String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency"
},
"continue":{
"type":"string",
"description":"continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response."
}
}
},
"v1beta1.PodDisruptionBudget":{
"id":"v1beta1.PodDisruptionBudget",
"description":"PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods",
"properties":{
"kind":{
"type":"string",
"description":"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
},
"apiVersion":{
"type":"string",
"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"
},
"metadata":{
"$ref":"v1.ObjectMeta"
},
"spec":{
"$ref":"v1beta1.PodDisruptionBudgetSpec",
"description":"Specification of the desired behavior of the PodDisruptionBudget."
},
"status":{
"$ref":"v1beta1.PodDisruptionBudgetStatus",
"description":"Most recently observed status of the PodDisruptionBudget."
}
}
},
"v1.ObjectMeta":{
"id":"v1.ObjectMeta",
"description":"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties":{
"name":{
"type":"string",
"description":"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
},
"generateName":{
"type":"string",
"description":"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency"
},
"namespace":{
"type":"string",
"description":"Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
},
"selfLink":{
"type":"string",
"description":"SelfLink is a URL representing this object. Populated by the system. Read-only."
},
"uid":{
"type":"string",
"description":"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
},
"resourceVersion":{
"type":"string",
"description":"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency"
},
"generation":{
"type":"integer",
"format":"int64",
"description":"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
},
"creationTimestamp":{
"type":"string",
"description":"CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"
},
"deletionTimestamp":{
"type":"string",
"description":"DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"
},
"deletionGracePeriodSeconds":{
"type":"integer",
"format":"int64",
"description":"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
},
"labels":{
"type":"object",
"description":"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
},
"annotations":{
"type":"object",
"description":"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
},
"ownerReferences":{
"type":"array",
"items":{
"$ref":"v1.OwnerReference"
},
"description":"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
},
"initializers":{
"$ref":"v1.Initializers",
"description":"An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.\n\nWhen an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user."
},
"finalizers":{
"type":"array",
"items":{
"type":"string"
},
"description":"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed."
},
"clusterName":{
"type":"string",
"description":"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
}
}
},
"v1.OwnerReference":{
"id":"v1.OwnerReference",
"description":"OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.",
"required":[
"apiVersion",
"kind",
"name",
"uid"
],
"properties":{
"apiVersion":{
"type":"string",
"description":"API version of the referent."
},
"kind":{
"type":"string",
"description":"Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
},
"name":{
"type":"string",
"description":"Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
},
"uid":{
"type":"string",
"description":"UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
},
"controller":{
"type":"boolean",
"description":"If true, this reference points to the managing controller."
},
"blockOwnerDeletion":{
"type":"boolean",
"description":"If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned."
}
}
},
"v1.Initializers":{
"id":"v1.Initializers",
"description":"Initializers tracks the progress of initialization.",
"required":[
"pending"
],
"properties":{
"pending":{
"type":"array",
"items":{
"$ref":"v1.Initializer"
},
"description":"Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients."
},
"result":{
"$ref":"v1.Status",
"description":"If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion."
}
}
},
"v1.Initializer":{
"id":"v1.Initializer",
"description":"Initializer is information about an initializer that has not yet completed.",
"required":[
"name"
],
"properties":{
"name":{
"type":"string",
"description":"name of the process that is responsible for initializing this object."
}
}
},
"v1.Status":{
"id":"v1.Status",
"description":"Status is a return value for calls that don't return other objects.",
"properties":{
"kind":{
"type":"string",
"description":"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
},
"apiVersion":{
"type":"string",
"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"
},
"metadata":{
"$ref":"v1.ListMeta",
"description":"Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
},
"status":{
"type":"string",
"description":"Status of the operation. One of: \"Success\" or \"Failure\". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status"
},
"message":{
"type":"string",
"description":"A human-readable description of the status of this operation."
},
"reason":{
"type":"string",
"description":"A machine-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it."
},
"details":{
"$ref":"v1.StatusDetails",
"description":"Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type."
},
"code":{
"type":"integer",
"format":"int32",
"description":"Suggested HTTP return code for this status, 0 if not set."
}
}
},
"v1.StatusDetails":{
"id":"v1.StatusDetails",
"description":"StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.",
"properties":{
"name":{
"type":"string",
"description":"The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described)."
},
"group":{
"type":"string",
"description":"The group attribute of the resource associated with the status StatusReason."
},
"kind":{
"type":"string",
"description":"The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
},
"uid":{
"type":"string",
"description":"UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
},
"causes":{
"type":"array",
"items":{
"$ref":"v1.StatusCause"
},
"description":"The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes."
},
"retryAfterSeconds":{
"type":"integer",
"format":"int32",
"description":"If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action."
}
}
},
"v1.StatusCause":{
"id":"v1.StatusCause",
"description":"StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.",
"properties":{
"reason":{
"type":"string",
"description":"A machine-readable description of the cause of the error. If this value is empty there is no information available."
},
"message":{
"type":"string",
"description":"A human-readable description of the cause of the error. This field may be presented as-is to a reader."
},
"field":{
"type":"string",
"description":"The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.\n\nExamples:\n \"name\" - the field \"name\" on the current resource\n \"items[0].name\" - the field \"name\" on the first array entry in \"items\""
}
}
},
"v1beta1.PodDisruptionBudgetSpec":{
"id":"v1beta1.PodDisruptionBudgetSpec",
"description":"PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.",
"properties":{
"minAvailable":{
"type":"string",
"description":"An eviction is allowed if at least \"minAvailable\" pods selected by \"selector\" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying \"100%\"."
},
"selector":{
"$ref":"v1.LabelSelector",
"description":"Label query over pods whose evictions are managed by the disruption budget."
},
"maxUnavailable":{
"type":"string",
"description":"An eviction is allowed if at most \"maxUnavailable\" pods selected by \"selector\" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with \"minAvailable\"."
}
}
},
"v1.LabelSelector":{
"id":"v1.LabelSelector",
"description":"A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties":{
"matchLabels":{
"type":"object",
"description":"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed."
},
"matchExpressions":{
"type":"array",
"items":{
"$ref":"v1.LabelSelectorRequirement"
},
"description":"matchExpressions is a list of label selector requirements. The requirements are ANDed."
}
}
},
"v1.LabelSelectorRequirement":{
"id":"v1.LabelSelectorRequirement",
"description":"A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"required":[
"key",
"operator"
],
"properties":{
"key":{
"type":"string",
"description":"key is the label key that the selector applies to."
},
"operator":{
"type":"string",
"description":"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."
},
"values":{
"type":"array",
"items":{
"type":"string"
},
"description":"values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch."
}
}
},
"v1beta1.PodDisruptionBudgetStatus":{
"id":"v1beta1.PodDisruptionBudgetStatus",
"description":"PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.",
"required":[
"disruptedPods",
"disruptionsAllowed",
"currentHealthy",
"desiredHealthy",
"expectedPods"
],
"properties":{
"observedGeneration":{
"type":"integer",
"format":"int64",
"description":"Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status informatio is valid only if observedGeneration equals to PDB's object generation."
},
"disruptedPods":{
"type":"object",
"description":"DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions."
},
"disruptionsAllowed":{
"type":"integer",
"format":"int32",
"description":"Number of pod disruptions that are currently allowed."
},
"currentHealthy":{
"type":"integer",
"format":"int32",
"description":"current number of healthy pods"
},
"desiredHealthy":{
"type":"integer",
"format":"int32",
"description":"minimum desired number of healthy pods"
},
"expectedPods":{
"type":"integer",
"format":"int32",
"description":"total number of pods counted by this disruption budget"
}
}
},
"v1.WatchEvent":{
"id":"v1.WatchEvent",
"required":[
"type",
"object"
],
"properties":{
"type":{
"type":"string"
},
"object":{
"type":"string"
}
}
},
"v1.Patch":{
"id":"v1.Patch",
"description":"Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.",
"properties":{}
},
"v1.DeleteOptions":{
"id":"v1.DeleteOptions",
"description":"DeleteOptions may be provided when deleting an API object.",
"properties":{
"kind":{
"type":"string",
"description":"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
},
"apiVersion":{
"type":"string",
"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"
},
"gracePeriodSeconds":{
"type":"integer",
"format":"int64",
"description":"The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately."
},
"preconditions":{
"$ref":"v1.Preconditions",
"description":"Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned."
},
"orphanDependents":{
"type":"boolean",
"description":"Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both."
},
"propagationPolicy":{
"$ref":"v1.DeletionPropagation",
"description":"Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground."
}
}
},
"v1.Preconditions":{
"id":"v1.Preconditions",
"description":"Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.",
"description":"Pod Security Policy List is a list of PodSecurityPolicy objects.",
"required":[
"items"
],
"properties":{
"kind":{
"type":"string",
"description":"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
},
"apiVersion":{
"type":"string",
"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"
},
"metadata":{
"$ref":"v1.ListMeta",
"description":"Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"
},
"items":{
"type":"array",
"items":{
"$ref":"v1beta1.PodSecurityPolicy"
},
"description":"Items is a list of schema objects."
}
}
},
"v1beta1.PodSecurityPolicy":{
"id":"v1beta1.PodSecurityPolicy",
"description":"Pod Security Policy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.",
"properties":{
"kind":{
"type":"string",
"description":"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
},
"apiVersion":{
"type":"string",
"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"
},
"metadata":{
"$ref":"v1.ObjectMeta",
"description":"Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"
},
"spec":{
"$ref":"v1beta1.PodSecurityPolicySpec",
"description":"spec defines the policy enforced."
}
}
},
"v1beta1.PodSecurityPolicySpec":{
"id":"v1beta1.PodSecurityPolicySpec",
"description":"Pod Security Policy Spec defines the policy enforced.",
"required":[
"seLinux",
"runAsUser",
"supplementalGroups",
"fsGroup"
],
"properties":{
"privileged":{
"type":"boolean",
"description":"privileged determines if a pod can request to be run as privileged."
},
"defaultAddCapabilities":{
"type":"array",
"items":{
"$ref":"v1.Capability"
},
"description":"DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both DefaultAddCapabilities and RequiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the AllowedCapabilities list."
},
"requiredDropCapabilities":{
"type":"array",
"items":{
"$ref":"v1.Capability"
},
"description":"RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added."
},
"allowedCapabilities":{
"type":"array",
"items":{
"$ref":"v1.Capability"
},
"description":"AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities."
},
"volumes":{
"type":"array",
"items":{
"$ref":"v1beta1.FSType"
},
"description":"volumes is a white list of allowed volume plugins. Empty indicates that all plugins may be used."
},
"hostNetwork":{
"type":"boolean",
"description":"hostNetwork determines if the policy allows the use of HostNetwork in the pod spec."
},
"hostPorts":{
"type":"array",
"items":{
"$ref":"v1beta1.HostPortRange"
},
"description":"hostPorts determines which host port ranges are allowed to be exposed."
},
"hostPID":{
"type":"boolean",
"description":"hostPID determines if the policy allows the use of HostPID in the pod spec."
},
"hostIPC":{
"type":"boolean",
"description":"hostIPC determines if the policy allows the use of HostIPC in the pod spec."
},
"seLinux":{
"$ref":"v1beta1.SELinuxStrategyOptions",
"description":"seLinux is the strategy that will dictate the allowable labels that may be set."
},
"runAsUser":{
"$ref":"v1beta1.RunAsUserStrategyOptions",
"description":"runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set."
"description":"SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext."
},
"fsGroup":{
"$ref":"v1beta1.FSGroupStrategyOptions",
"description":"FSGroup is the strategy that will dictate what fs group is used by the SecurityContext."
},
"readOnlyRootFilesystem":{
"type":"boolean",
"description":"ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to."
},
"defaultAllowPrivilegeEscalation":{
"type":"boolean",
"description":"DefaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process."
},
"allowPrivilegeEscalation":{
"type":"boolean",
"description":"AllowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true."
},
"allowedHostPaths":{
"type":"array",
"items":{
"$ref":"v1beta1.AllowedHostPath"
},
"description":"is a white list of allowed host paths. Empty indicates that all host paths may be used."
},
"allowedFlexVolumes":{
"type":"array",
"items":{
"$ref":"v1beta1.AllowedFlexVolume"
},
"description":"AllowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the \"Volumes\" field."
}
}
},
"v1.Capability":{
"id":"v1.Capability",
"properties":{}
},
"v1beta1.FSType":{
"id":"v1beta1.FSType",
"properties":{}
},
"v1beta1.HostPortRange":{
"id":"v1beta1.HostPortRange",
"description":"Host Port Range defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined.",
"required":[
"min",
"max"
],
"properties":{
"min":{
"type":"integer",
"format":"int32",
"description":"min is the start of the range, inclusive."
},
"max":{
"type":"integer",
"format":"int32",
"description":"max is the end of the range, inclusive."
}
}
},
"v1beta1.SELinuxStrategyOptions":{
"id":"v1beta1.SELinuxStrategyOptions",
"description":"SELinux Strategy Options defines the strategy type and any options used to create the strategy.",
"required":[
"rule"
],
"properties":{
"rule":{
"type":"string",
"description":"type is the strategy that will dictate the allowable labels that may be set."
},
"seLinuxOptions":{
"$ref":"v1.SELinuxOptions",
"description":"seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
}
}
},
"v1.SELinuxOptions":{
"id":"v1.SELinuxOptions",
"description":"SELinuxOptions are the labels to be applied to the container",
"properties":{
"user":{
"type":"string",
"description":"User is a SELinux user label that applies to the container."
},
"role":{
"type":"string",
"description":"Role is a SELinux role label that applies to the container."
},
"type":{
"type":"string",
"description":"Type is a SELinux type label that applies to the container."
},
"level":{
"type":"string",
"description":"Level is SELinux level label that applies to the container."
}
}
},
"v1beta1.RunAsUserStrategyOptions":{
"id":"v1beta1.RunAsUserStrategyOptions",
"description":"Run A sUser Strategy Options defines the strategy type and any options used to create the strategy.",
"required":[
"rule"
],
"properties":{
"rule":{
"type":"string",
"description":"Rule is the strategy that will dictate the allowable RunAsUser values that may be set."
},
"ranges":{
"type":"array",
"items":{
"$ref":"v1beta1.IDRange"
},
"description":"Ranges are the allowed ranges of uids that may be used."
}
}
},
"v1beta1.IDRange":{
"id":"v1beta1.IDRange",
"description":"ID Range provides a min/max of an allowed range of IDs.",
"required":[
"min",
"max"
],
"properties":{
"min":{
"type":"integer",
"format":"int64",
"description":"Min is the start of the range, inclusive."
},
"max":{
"type":"integer",
"format":"int64",
"description":"Max is the end of the range, inclusive."
}
}
},
"v1beta1.SupplementalGroupsStrategyOptions":{
"id":"v1beta1.SupplementalGroupsStrategyOptions",
"description":"SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.",
"properties":{
"rule":{
"type":"string",
"description":"Rule is the strategy that will dictate what supplemental groups is used in the SecurityContext."
},
"ranges":{
"type":"array",
"items":{
"$ref":"v1beta1.IDRange"
},
"description":"Ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end."
}
}
},
"v1beta1.FSGroupStrategyOptions":{
"id":"v1beta1.FSGroupStrategyOptions",
"description":"FSGroupStrategyOptions defines the strategy type and options used to create the strategy.",
"properties":{
"rule":{
"type":"string",
"description":"Rule is the strategy that will dictate what FSGroup is used in the SecurityContext."
},
"ranges":{
"type":"array",
"items":{
"$ref":"v1beta1.IDRange"
},
"description":"Ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end."
}
}
},
"v1beta1.AllowedHostPath":{
"id":"v1beta1.AllowedHostPath",
"description":"defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined.",
"properties":{
"pathPrefix":{
"type":"string",
"description":"is the path prefix that the host volume must match. It does not support `*`. Trailing slashes are trimmed when validating the path prefix with a host path.\n\nExamples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo`"
}
}
},
"v1beta1.AllowedFlexVolume":{
"id":"v1beta1.AllowedFlexVolume",
"description":"AllowedFlexVolume represents a single Flexvolume that is allowed to be used.",
"required":[
"driver"
],
"properties":{
"driver":{
"type":"string",
"description":"Driver is the name of the Flexvolume driver."
"description":"APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.",
"required":[
"groupVersion",
"resources"
],
"properties":{
"kind":{
"type":"string",
"description":"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
},
"apiVersion":{
"type":"string",
"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"
},
"groupVersion":{
"type":"string",
"description":"groupVersion is the group and version this APIResourceList is for."
},
"resources":{
"type":"array",
"items":{
"$ref":"v1.APIResource"
},
"description":"resources contains the name of the resources and if they are namespaced."
}
}
},
"v1.APIResource":{
"id":"v1.APIResource",
"description":"APIResource specifies the name of a resource and whether it is namespaced.",
"required":[
"name",
"singularName",
"namespaced",
"kind",
"verbs"
],
"properties":{
"name":{
"type":"string",
"description":"name is the plural name of the resource."
},
"singularName":{
"type":"string",
"description":"singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface."
},
"namespaced":{
"type":"boolean",
"description":"namespaced indicates if a resource is namespaced or not."
},
"group":{
"type":"string",
"description":"group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale\"."
},
"version":{
"type":"string",
"description":"version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)\"."
},
"kind":{
"type":"string",
"description":"kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')"
},
"verbs":{
"type":"array",
"items":{
"type":"string"
},
"description":"verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)"
},
"shortNames":{
"type":"array",
"items":{
"type":"string"
},
"description":"shortNames is a list of suggested short names of the resource."
},
"categories":{
"type":"array",
"items":{
"type":"string"
},
"description":"categories is a list of the grouped resources this resource belongs to (e.g. 'all')"
