Skip to content

Instantly share code, notes, and snippets.

@hgfkeep

hgfkeep/custom_object_spec.json

Last active April 7, 2020 07:24
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save hgfkeep/9e65f5fb8f583f81fd4c8dc653793028 to your computer and use it in GitHub Desktop.
Save hgfkeep/9e65f5fb8f583f81fd4c8dc653793028 to your computer and use it in GitHub Desktop.
Download ZIP
core file when generate kubernetes client custom api with metrics api
Raw
custom_object_spec.json
{
"paths":{
"/apis/{group}/{version}/{plural}":{
"parameters":[
{
"uniqueItems":true,
"type":"string",
"description":"If 'true', then the output is pretty printed.",
"name":"pretty",
"in":"query"
},
{
"name":"group",
"in":"path",
"required":true,
"description":"The custom resource's group name",
"type":"string"
},
{
"name":"version",
"in":"path",
"required":true,
"description":"The custom resource's version",
"type":"string"
},
{
"name":"plural",
"in":"path",
"required":true,
"description":"The custom resource's plural name. For TPRs this would be lowercase plural kind.",
"type":"string"
}
],
"get":{
"operationId":"listClusterCustomObject",
"description":"list or watch cluster scoped custom objects",
"tags":[
"custom_objects"
],
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/json;stream=watch"
],
"schemes":[
"https"
],
"parameters":[
{
"uniqueItems":true,
"type":"string",
"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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\n 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.",
"name":"continue",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"name":"fieldSelector",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"name":"labelSelector",
"in":"query"
},
{
"uniqueItems":true,
"type":"integer",
"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. The 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.",
"name":"limit",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"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.",
"name":"resourceVersion",
"in":"query"
},
{
"uniqueItems":true,
"type":"integer",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"name":"timeoutSeconds",
"in":"query"
},
{
"name":"watch",
"uniqueItems":true,
"type":"boolean",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.",
"in":"query"
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"post":{
"operationId":"createClusterCustomObject",
"description":"Creates a cluster scoped Custom object",
"produces":[
"application/json"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"description":"The JSON schema of the Resource to create.",
"schema":{
"type":"object"
}
}
],
"responses":{
"201":{
"description":"Created",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
}
},
"/apis/{group}/{version}/namespaces/{namespace}/{plural}":{
"parameters":[
{
"uniqueItems":true,
"type":"string",
"description":"If 'true', then the output is pretty printed.",
"name":"pretty",
"in":"query"
},
{
"name":"group",
"in":"path",
"required":true,
"description":"The custom resource's group name",
"type":"string"
},
{
"name":"version",
"in":"path",
"required":true,
"description":"The custom resource's version",
"type":"string"
},
{
"name":"namespace",
"in":"path",
"required":true,
"description":"The custom resource's namespace",
"type":"string"
},
{
"name":"plural",
"in":"path",
"required":true,
"description":"The custom resource's plural name. For TPRs this would be lowercase plural kind.",
"type":"string"
}
],
"get":{
"operationId":"listNamespacedCustomObject",
"description":"list or watch namespace scoped custom objects",
"tags":[
"custom_objects"
],
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/json;stream=watch"
],
"schemes":[
"https"
],
"parameters":[
{
"uniqueItems":true,
"type":"string",
"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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". 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.",
"name":"continue",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"name":"fieldSelector",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"name":"labelSelector",
"in":"query"
},
{
"uniqueItems":true,
"type":"integer",
"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. The 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.",
"name":"limit",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"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.",
"name":"resourceVersion",
"in":"query"
},
{
"uniqueItems":true,
"type":"integer",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"name":"timeoutSeconds",
"in":"query"
},
{
"name":"watch",
"uniqueItems":true,
"type":"boolean",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications.",
"in":"query"
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"post":{
"operationId":"createNamespacedCustomObject",
"description":"Creates a namespace scoped Custom object",
"produces":[
"application/json"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"description":"The JSON schema of the Resource to create.",
"schema":{
"type":"object"
}
}
],
"responses":{
"201":{
"description":"Created",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
}
},
"/apis/{group}/{version}/{plural}/{name}":{
"parameters":[
{
"name":"group",
"in":"path",
"required":true,
"description":"the custom resource's group",
"type":"string"
},
{
"name":"version",
"in":"path",
"required":true,
"description":"the custom resource's version",
"type":"string"
},
{
"name":"plural",
"in":"path",
"required":true,
"description":"the custom object's plural name. For TPRs this would be lowercase plural kind.",
"type":"string"
},
{
"name":"name",
"in":"path",
"required":true,
"description":"the custom object's name",
"type":"string"
}
],
"get":{
"operationId":"getClusterCustomObject",
"description":"Returns a cluster scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"responses":{
"200":{
"description":"A single Resource",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"delete":{
"operationId":"deleteClusterCustomObject",
"description":"Deletes the specified cluster scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"parameters":[
{
"name":"body",
"in":"body",
"schema":{
"$ref":"#/definitions/v1.DeleteOptions"
}
},
{
"name":"gracePeriodSeconds",
"uniqueItems":true,
"type":"integer",
"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.",
"in":"query"
},
{
"name":"orphanDependents",
"uniqueItems":true,
"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.",
"in":"query"
},
{
"name":"propagationPolicy",
"uniqueItems":true,
"type":"string",
"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.",
"in":"query"
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"patch":{
"operationId":"patchClusterCustomObject",
"description":"patch the specified cluster scoped custom object",
"consumes":[
"application/json-patch+json",
"application/merge-patch+json"
],
"produces":[
"application/json"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"description":"The JSON schema of the Resource to patch.",
"schema":{
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"put":{
"operationId":"replaceClusterCustomObject",
"description":"replace the specified cluster scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"description":"The JSON schema of the Resource to replace.",
"schema":{
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
}
},
"/apis/{group}/{version}/{plural}/{name}/status":{
"parameters":[
{
"name":"group",
"in":"path",
"required":true,
"description":"the custom resource's group",
"type":"string"
},
{
"name":"version",
"in":"path",
"required":true,
"description":"the custom resource's version",
"type":"string"
},
{
"name":"plural",
"in":"path",
"required":true,
"description":"the custom resource's plural name. For TPRs this would be lowercase plural kind.",
"type":"string"
},
{
"name":"name",
"in":"path",
"required":true,
"description":"the custom object's name",
"type":"string"
}
],
"get":{
"description":"read status of the specified cluster scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"getClusterCustomObjectStatus",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"put":{
"description":"replace status of the cluster scoped specified custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"replaceClusterCustomObjectStatus",
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"201":{
"description":"Created",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"patch":{
"description":"partially update status of the specified cluster scoped custom object",
"consumes":[
"application/json-patch+json",
"application/merge-patch+json"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"patchClusterCustomObjectStatus",
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"description":"The JSON schema of the Resource to patch.",
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
}
},
"/apis/{group}/{version}/{plural}/{name}/scale":{
"parameters":[
{
"name":"group",
"in":"path",
"required":true,
"description":"the custom resource's group",
"type":"string"
},
{
"name":"version",
"in":"path",
"required":true,
"description":"the custom resource's version",
"type":"string"
},
{
"name":"plural",
"in":"path",
"required":true,
"description":"the custom resource's plural name. For TPRs this would be lowercase plural kind.",
"type":"string"
},
{
"name":"name",
"in":"path",
"required":true,
"description":"the custom object's name",
"type":"string"
}
],
"get":{
"description":"read scale of the specified custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"getClusterCustomObjectScale",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"put":{
"description":"replace scale of the specified cluster scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"replaceClusterCustomObjectScale",
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"201":{
"description":"Created",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"patch":{
"description":"partially update scale of the specified cluster scoped custom object",
"consumes":[
"application/json-patch+json",
"application/merge-patch+json"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"patchClusterCustomObjectScale",
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"description":"The JSON schema of the Resource to patch.",
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
}
},
"/apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}":{
"parameters":[
{
"name":"group",
"in":"path",
"required":true,
"description":"the custom resource's group",
"type":"string"
},
{
"name":"version",
"in":"path",
"required":true,
"description":"the custom resource's version",
"type":"string"
},
{
"name":"namespace",
"in":"path",
"required":true,
"description":"The custom resource's namespace",
"type":"string"
},
{
"name":"plural",
"in":"path",
"required":true,
"description":"the custom resource's plural name. For TPRs this would be lowercase plural kind.",
"type":"string"
},
{
"name":"name",
"in":"path",
"required":true,
"description":"the custom object's name",
"type":"string"
}
],
"get":{
"operationId":"getNamespacedCustomObject",
"description":"Returns a namespace scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"responses":{
"200":{
"description":"A single Resource",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"delete":{
"operationId":"deleteNamespacedCustomObject",
"description":"Deletes the specified namespace scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"parameters":[
{
"name":"body",
"in":"body",
"schema":{
"$ref":"#/definitions/v1.DeleteOptions"
}
},
{
"name":"gracePeriodSeconds",
"uniqueItems":true,
"type":"integer",
"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.",
"in":"query"
},
{
"name":"orphanDependents",
"uniqueItems":true,
"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.",
"in":"query"
},
{
"name":"propagationPolicy",
"uniqueItems":true,
"type":"string",
"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.",
"in":"query"
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"patch":{
"operationId":"patchNamespacedCustomObject",
"description":"patch the specified namespace scoped custom object",
"consumes":[
"application/json-patch+json",
"application/merge-patch+json"
],
"produces":[
"application/json"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"description":"The JSON schema of the Resource to patch.",
"schema":{
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"put":{
"operationId":"replaceNamespacedCustomObject",
"description":"replace the specified namespace scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"description":"The JSON schema of the Resource to replace.",
"schema":{
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
}
},
"/apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status":{
"parameters":[
{
"name":"group",
"in":"path",
"required":true,
"description":"the custom resource's group",
"type":"string"
},
{
"name":"version",
"in":"path",
"required":true,
"description":"the custom resource's version",
"type":"string"
},
{
"name":"namespace",
"in":"path",
"required":true,
"description":"The custom resource's namespace",
"type":"string"
},
{
"name":"plural",
"in":"path",
"required":true,
"description":"the custom resource's plural name. For TPRs this would be lowercase plural kind.",
"type":"string"
},
{
"name":"name",
"in":"path",
"required":true,
"description":"the custom object's name",
"type":"string"
}
],
"get":{
"description":"read status of the specified namespace scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"getNamespacedCustomObjectStatus",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"put":{
"description":"replace status of the specified namespace scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"replaceNamespacedCustomObjectStatus",
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"201":{
"description":"Created",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"patch":{
"description":"partially update status of the specified namespace scoped custom object",
"consumes":[
"application/json-patch+json",
"application/merge-patch+json"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"patchNamespacedCustomObjectStatus",
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"description":"The JSON schema of the Resource to patch.",
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
}
},
"/apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale":{
"parameters":[
{
"name":"group",
"in":"path",
"required":true,
"description":"the custom resource's group",
"type":"string"
},
{
"name":"version",
"in":"path",
"required":true,
"description":"the custom resource's version",
"type":"string"
},
{
"name":"namespace",
"in":"path",
"required":true,
"description":"The custom resource's namespace",
"type":"string"
},
{
"name":"plural",
"in":"path",
"required":true,
"description":"the custom resource's plural name. For TPRs this would be lowercase plural kind.",
"type":"string"
},
{
"name":"name",
"in":"path",
"required":true,
"description":"the custom object's name",
"type":"string"
}
],
"get":{
"description":"read scale of the specified namespace scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"getNamespacedCustomObjectScale",
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"put":{
"description":"replace scale of the specified namespace scoped custom object",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"replaceNamespacedCustomObjectScale",
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"201":{
"description":"Created",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
},
"patch":{
"description":"partially update scale of the specified namespace scoped custom object",
"consumes":[
"application/json-patch+json",
"application/merge-patch+json"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"custom_objects"
],
"operationId":"patchNamespacedCustomObjectScale",
"parameters":[
{
"name":"body",
"in":"body",
"required":true,
"schema":{
"description":"The JSON schema of the Resource to patch.",
"type":"object"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"type":"object"
}
},
"401":{
"description":"Unauthorized"
}
}
}
},
"/apis/metrics.k8s.io/":{
"get":{
"description":"get information of a group",
"consumes":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"metrics"
],
"operationId":"getMetricsAPIGroup",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup_v2"
}
}
}
}
},
"/apis/metrics.k8s.io/v1beta1/":{
"get":{
"description":"get available resources",
"consumes":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"metrics_v1beta1"
],
"operationId":"getMetricsV1beta1APIResources",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.APIResourceList_v2"
}
}
}
}
},
"/apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods":{
"get":{
"description":"list objects of kind PodMetrics",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf",
"application/json;stream=watch",
"application/vnd.kubernetes.protobuf;stream=watch"
],
"schemes":[
"https"
],
"tags":[
"metrics_v1beta1"
],
"operationId":"listMetricsV1beta1NamespacedPodMetrics",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/io.k8s.metrics.pkg.apis.metrics.v1beta1.PodMetricsList"
}
}
},
"x-kubernetes-action":"list",
"x-kubernetes-group-version-kind":{
"group":"metrics.k8s.io",
"kind":"PodMetrics",
"version":"v1beta1"
}
},
"parameters":[
{
"uniqueItems":true,
"type":"string",
"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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". 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.",
"name":"continue",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"name":"fieldSelector",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"name":"labelSelector",
"in":"query"
},
{
"uniqueItems":true,
"type":"integer",
"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. The 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.",
"name":"limit",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"object name and auth scope, such as for teams and projects",
"name":"namespace",
"in":"path",
"required":true
},
{
"uniqueItems":true,
"type":"string",
"description":"If 'true', then the output is pretty printed.",
"name":"pretty",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"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.",
"name":"resourceVersion",
"in":"query"
},
{
"uniqueItems":true,
"type":"integer",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"name":"timeoutSeconds",
"in":"query"
},
{
"uniqueItems":true,
"type":"boolean",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"name":"watch",
"in":"query"
}
]
},
"/apis/metrics.k8s.io/v1beta1/namespaces/{namespace}/pods/{name}":{
"get":{
"description":"read the specified PodMetrics",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"metrics_v1beta1"
],
"operationId":"readMetricsV1beta1NamespacedPodMetrics",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/io.k8s.metrics.pkg.apis.metrics.v1beta1.PodMetrics"
}
}
},
"x-kubernetes-action":"get",
"x-kubernetes-group-version-kind":{
"group":"metrics.k8s.io",
"kind":"PodMetrics",
"version":"v1beta1"
}
},
"parameters":[
{
"uniqueItems":true,
"type":"string",
"description":"name of the PodMetrics",
"name":"name",
"in":"path",
"required":true
},
{
"uniqueItems":true,
"type":"string",
"description":"object name and auth scope, such as for teams and projects",
"name":"namespace",
"in":"path",
"required":true
},
{
"uniqueItems":true,
"type":"string",
"description":"If 'true', then the output is pretty printed.",
"name":"pretty",
"in":"query"
}
]
},
"/apis/metrics.k8s.io/v1beta1/nodes":{
"get":{
"description":"list objects of kind NodeMetrics",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf",
"application/json;stream=watch",
"application/vnd.kubernetes.protobuf;stream=watch"
],
"schemes":[
"https"
],
"tags":[
"metrics_v1beta1"
],
"operationId":"listMetricsV1beta1NodeMetrics",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/io.k8s.metrics.pkg.apis.metrics.v1beta1.NodeMetricsList"
}
}
},
"x-kubernetes-action":"list",
"x-kubernetes-group-version-kind":{
"group":"metrics.k8s.io",
"kind":"NodeMetrics",
"version":"v1beta1"
}
},
"parameters":[
{
"uniqueItems":true,
"type":"string",
"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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". 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.",
"name":"continue",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"name":"fieldSelector",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"name":"labelSelector",
"in":"query"
},
{
"uniqueItems":true,
"type":"integer",
"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. The 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.",
"name":"limit",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"If 'true', then the output is pretty printed.",
"name":"pretty",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"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.",
"name":"resourceVersion",
"in":"query"
},
{
"uniqueItems":true,
"type":"integer",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"name":"timeoutSeconds",
"in":"query"
},
{
"uniqueItems":true,
"type":"boolean",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"name":"watch",
"in":"query"
}
]
},
"/apis/metrics.k8s.io/v1beta1/nodes/{name}":{
"get":{
"description":"read the specified NodeMetrics",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"schemes":[
"https"
],
"tags":[
"metrics_v1beta1"
],
"operationId":"readMetricsV1beta1NodeMetrics",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/io.k8s.metrics.pkg.apis.metrics.v1beta1.NodeMetrics"
}
}
},
"x-kubernetes-action":"get",
"x-kubernetes-group-version-kind":{
"group":"metrics.k8s.io",
"kind":"NodeMetrics",
"version":"v1beta1"
}
},
"parameters":[
{
"uniqueItems":true,
"type":"string",
"description":"name of the NodeMetrics",
"name":"name",
"in":"path",
"required":true
},
{
"uniqueItems":true,
"type":"string",
"description":"If 'true', then the output is pretty printed.",
"name":"pretty",
"in":"query"
}
]
},
"/apis/metrics.k8s.io/v1beta1/pods":{
"get":{
"description":"list objects of kind PodMetrics",
"consumes":[
"*/*"
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf",
"application/json;stream=watch",
"application/vnd.kubernetes.protobuf;stream=watch"
],
"schemes":[
"https"
],
"tags":[
"metrics_v1beta1"
],
"operationId":"listMetricsV1beta1PodMetricsForAllNamespaces",
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/io.k8s.metrics.pkg.apis.metrics.v1beta1.PodMetricsList"
}
}
},
"x-kubernetes-action":"list",
"x-kubernetes-group-version-kind":{
"group":"metrics.k8s.io",
"kind":"PodMetrics",
"version":"v1beta1"
}
},
"parameters":[
{
"uniqueItems":true,
"type":"string",
"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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". 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.",
"name":"continue",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"name":"fieldSelector",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"name":"labelSelector",
"in":"query"
},
{
"uniqueItems":true,
"type":"integer",
"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. The 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.",
"name":"limit",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"description":"If 'true', then the output is pretty printed.",
"name":"pretty",
"in":"query"
},
{
"uniqueItems":true,
"type":"string",
"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.",
"name":"resourceVersion",
"in":"query"
},
{
"uniqueItems":true,
"type":"integer",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"name":"timeoutSeconds",
"in":"query"
},
{
"uniqueItems":true,
"type":"boolean",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"name":"watch",
"in":"query"
}
]
}
},
"definitions":{
"io.k8s.metrics.pkg.apis.metrics.v1beta1.ContainerMetrics":{
"description":"ContainerMetrics sets resource usage metrics of a container.",
"type":"object",
"required":[
"name",
"usage"
],
"properties":{
"name":{
"description":"Container name corresponding to the one from pod.spec.containers.",
"type":"string"
},
"usage":{
"description":"The memory usage is the memory working set.",
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
}
}
}
},
"io.k8s.metrics.pkg.apis.metrics.v1beta1.NodeMetrics":{
"description":"NodeMetrics sets resource usage metrics of a node.",
"type":"object",
"required":[
"timestamp",
"window",
"usage"
],
"properties":{
"apiVersion":{
"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",
"type":"string"
},
"kind":{
"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",
"type":"string"
},
"metadata":{
"$ref":"#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2"
},
"timestamp":{
"description":"The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp].",
"$ref":"#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
},
"usage":{
"description":"The memory usage is the memory working set.",
"type":"object",
"additionalProperties":{
"$ref":"#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
}
},
"window":{
"$ref":"#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
}
},
"x-kubernetes-group-version-kind":[
{
"group":"metrics.k8s.io",
"kind":"NodeMetrics",
"version":"v1beta1"
}
]
},
"io.k8s.metrics.pkg.apis.metrics.v1beta1.NodeMetricsList":{
"description":"NodeMetricsList is a list of NodeMetrics.",
"type":"object",
"required":[
"items"
],
"properties":{
"apiVersion":{
"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",
"type":"string"
},
"items":{
"description":"List of node metrics.",
"type":"array",
"items":{
"$ref":"#/definitions/io.k8s.metrics.pkg.apis.metrics.v1beta1.NodeMetrics"
}
},
"kind":{
"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",
"type":"string"
},
"metadata":{
"description":"Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"$ref":"#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta_v2"
}
},
"x-kubernetes-group-version-kind":[
{
"group":"metrics.k8s.io",
"kind":"NodeMetricsList",
"version":"v1beta1"
}
]
},
"io.k8s.metrics.pkg.apis.metrics.v1beta1.PodMetrics":{
"description":"PodMetrics sets resource usage metrics of a pod.",
"type":"object",
"required":[
"timestamp",
"window",
"containers"
],
"properties":{
"apiVersion":{
"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",
"type":"string"
},
"containers":{
"description":"Metrics for all containers are collected within the same time window.",
"type":"array",
"items":{
"$ref":"#/definitions/io.k8s.metrics.pkg.apis.metrics.v1beta1.ContainerMetrics"
}
},
"kind":{
"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",
"type":"string"
},
"metadata":{
"$ref":"#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2"
},
"timestamp":{
"description":"The following fields define time interval from which metrics were collected from the interval [Timestamp-Window, Timestamp].",
"$ref":"#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
},
"window":{
"$ref":"#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
}
},
"x-kubernetes-group-version-kind":[
{
"group":"metrics.k8s.io",
"kind":"PodMetrics",
"version":"v1beta1"
}
]
},
"io.k8s.metrics.pkg.apis.metrics.v1beta1.PodMetricsList":{
"description":"PodMetricsList is a list of PodMetrics.",
"type":"object",
"required":[
"items"
],
"properties":{
"apiVersion":{
"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",
"type":"string"
},
"items":{
"description":"List of pod metrics.",
"type":"array",
"items":{
"$ref":"#/definitions/io.k8s.metrics.pkg.apis.metrics.v1beta1.PodMetrics"
}
},
"kind":{
"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",
"type":"string"
},
"metadata":{
"description":"Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"$ref":"#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta_v2"
}
},
"x-kubernetes-group-version-kind":[
{
"group":"metrics.k8s.io",
"kind":"PodMetricsList",
"version":"v1beta1"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.APIResourceList_v2": {
"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.",
"type": "object",
"required": [
"groupVersion",
"resources"
],
"properties": {
"apiVersion": {
"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",
"type": "string"
},
"groupVersion": {
"description": "groupVersion is the group and version this APIResourceList is for.",
"type": "string"
},
"kind": {
"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",
"type": "string"
},
"resources": {
"description": "resources contains the name of the resources and if they are namespaced.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.APIResource_v2"
}
}
},
"x-kubernetes-group-version-kind": [
{
"group": "",
"kind": "APIResourceList",
"version": "v1"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta_v2": {
"description": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.",
"type": "object",
"properties": {
"continue": {
"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 consistent 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, unless you have received this token from an error message.",
"type": "string"
},
"resourceVersion": {
"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",
"type": "string"
},
"selfLink": {
"description": "selfLink is a URL representing this object. Populated by the system. Read-only.",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup_v2": {
"description": "APIGroup contains the name, the supported versions, and the preferred version of a group.",
"type": "object",
"required": [
"name",
"versions"
],
"properties": {
"apiVersion": {
"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",
"type": "string"
},
"kind": {
"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",
"type": "string"
},
"name": {
"description": "name is the name of the group.",
"type": "string"
},
"preferredVersion": {
"description": "preferredVersion is the version preferred by the API server, which probably is the storage version.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery_v2"
},
"serverAddressByClientCIDRs": {
"description": "a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR_v2"
}
},
"versions": {
"description": "versions are the versions supported in this group.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery_v2"
}
}
},
"x-kubernetes-group-version-kind": [
{
"group": "",
"kind": "APIGroup",
"version": "v1"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta_v2": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"type": "object",
"properties": {
"annotations": {
"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",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"clusterName": {
"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.",
"type": "string"
},
"creationTimestamp": {
"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",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
},
"deletionGracePeriodSeconds": {
"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.",
"type": "integer",
"format": "int64"
},
"deletionTimestamp": {
"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",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
},
"finalizers": {
"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.",
"type": "array",
"items": {
"type": "string"
},
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"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",
"type": "string"
},
"generation": {
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"type": "integer",
"format": "int64"
},
"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.\n\nDEPRECATED - initializers are an alpha field and will be removed in v1.15.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Initializers_v2"
},
"labels": {
"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",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.\n\nThis field is alpha and can be changed or removed without notice.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry"
}
},
"name": {
"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",
"type": "string"
},
"namespace": {
"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",
"type": "string"
},
"ownerReferences": {
"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.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference_v2"
},
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"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",
"type": "string"
},
"selfLink": {
"description": "SelfLink is a URL representing this object. Populated by the system. Read-only.",
"type": "string"
},
"uid": {
"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",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery_v2": {
"description": "GroupVersion contains the \"group/version\" and \"version\" string of a version. It is made a struct to keep extensibility.",
"type": "object",
"required": [
"groupVersion",
"version"
],
"properties": {
"groupVersion": {
"description": "groupVersion specifies the API group and version in the form \"group/version\"",
"type": "string"
},
"version": {
"description": "version specifies the version in the form of \"version\". This is to save the clients the trouble of splitting the GroupVersion.",
"type": "string"
}
}
},"io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR_v2": {
"description": "ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.",
"type": "object",
"required": [
"clientCIDR",
"serverAddress"
],
"properties": {
"clientCIDR": {
"description": "The CIDR with which clients can match their IP to figure out the server address that they should use.",
"type": "string"
},
"serverAddress": {
"description": "Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.APIResource_v2": {
"description": "APIResource specifies the name of a resource and whether it is namespaced.",
"type": "object",
"required": [
"name",
"singularName",
"namespaced",
"kind",
"verbs"
],
"properties": {
"categories": {
"description": "categories is a list of the grouped resources this resource belongs to (e.g. 'all')",
"type": "array",
"items": {
"type": "string"
}
},
"group": {
"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\".",
"type": "string"
},
"kind": {
"description": "kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')",
"type": "string"
},
"name": {
"description": "name is the plural name of the resource.",
"type": "string"
},
"namespaced": {
"description": "namespaced indicates if a resource is namespaced or not.",
"type": "boolean"
},
"shortNames": {
"description": "shortNames is a list of suggested short names of the resource.",
"type": "array",
"items": {
"type": "string"
}
},
"singularName": {
"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.",
"type": "string"
},
"storageVersionHash": {
"description": "The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.",
"type": "string"
},
"verbs": {
"description": "verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)",
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"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)\".",
"type": "string"
}
}
},"io.k8s.apimachinery.pkg.apis.meta.v1.Duration": {
"description": "Duration is a wrapper around time.Duration which supports correct marshaling to YAML and JSON. In particular, it marshals into strings, which can be used as map keys in json.",
"type": "string"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.Initializers_v2": {
"description": "Initializers tracks the progress of initialization.",
"type": "object",
"required": [
"pending"
],
"properties": {
"pending": {
"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.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Initializer_v2"
},
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"result": {
"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.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference_v2": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"type": "object",
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"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.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.Initializer_v2": {
"description": "Initializer is information about an initializer that has not yet completed.",
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"description": "name of the process that is responsible for initializing this object.",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.Status_v2": {
"description": "Status is a return value for calls that don't return other objects.",
"type": "object",
"properties": {
"apiVersion": {
"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",
"type": "string"
},
"code": {
"description": "Suggested HTTP return code for this status, 0 if not set.",
"type": "integer",
"format": "int32"
},
"details": {
"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.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails_v2"
},
"kind": {
"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",
"type": "string"
},
"message": {
"description": "A human-readable description of the status of this operation.",
"type": "string"
},
"metadata": {
"description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta_v2"
},
"reason": {
"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.",
"type": "string"
},
"status": {
"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",
"type": "string"
}
},
"x-kubernetes-group-version-kind": [
{
"group": "",
"kind": "Status",
"version": "v1"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails_v2": {
"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.",
"type": "object",
"properties": {
"causes": {
"description": "The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause_v2"
}
},
"group": {
"description": "The group attribute of the resource associated with the status StatusReason.",
"type": "string"
},
"kind": {
"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",
"type": "string"
},
"name": {
"description": "The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).",
"type": "string"
},
"retryAfterSeconds": {
"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.",
"type": "integer",
"format": "int32"
},
"uid": {
"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",
"type": "string"
}
}
},
"io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause_v2": {
"description": "StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.",
"type": "object",
"properties": {
"field": {
"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\"",
"type": "string"
},
"message": {
"description": "A human-readable description of the cause of the error. This field may be presented as-is to a reader.",
"type": "string"
},
"reason": {
"description": "A machine-readable description of the cause of the error. If this value is empty there is no information available.",
"type": "string"
}
}
}
}
}
Raw
settings
KUBERNETES_BRANCH=master
CLIENT_VERSION=6.1.0
PACKAGE_NAME=io.kubernetes.client
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment