"summary":"list or watch objects of kind Cluster",
"nickname":"listCluster",
"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":"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":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"v1beta1.Cluster",
"paramType":"body",
"name":"body",
"description":"",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.Cluster"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"*/*"
]
},
{
"type":"v1.Status",
"method":"DELETE",
"summary":"delete collection of Cluster",
"nickname":"deletecollectionCluster",
"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":"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.",
"required":false,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1.Status"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"*/*"
]
}
]
},
{
"path":"/apis/federation/v1beta1/watch/clusters",
"description":"API at /apis/federation/v1beta1",
"operations":[
{
"type":"v1.WatchEvent",
"method":"GET",
"summary":"watch individual changes to a list of Cluster",
"nickname":"watchClusterList",
"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":"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":"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 Cluster",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.Cluster"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"*/*"
]
},
{
"type":"v1beta1.Cluster",
"method":"PUT",
"summary":"replace the specified Cluster",
"nickname":"replaceCluster",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"v1beta1.Cluster",
"paramType":"body",
"name":"body",
"description":"",
"required":true,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"name",
"description":"name of the Cluster",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.Cluster"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"*/*"
]
},
{
"type":"v1beta1.Cluster",
"method":"PATCH",
"summary":"partially update the specified Cluster",
"nickname":"patchCluster",
"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 Cluster",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.Cluster"
}
],
"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 Cluster",
"nickname":"deleteCluster",
"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":"Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list.",
"summary":"watch changes to an object of kind Cluster",
"nickname":"watchCluster",
"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":"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.",
"summary":"replace status of the specified Cluster",
"nickname":"replaceClusterStatus",
"parameters":[
{
"type":"string",
"paramType":"query",
"name":"pretty",
"description":"If 'true', then the output is pretty printed.",
"required":false,
"allowMultiple":false
},
{
"type":"v1beta1.Cluster",
"paramType":"body",
"name":"body",
"description":"",
"required":true,
"allowMultiple":false
},
{
"type":"string",
"paramType":"path",
"name":"name",
"description":"name of the Cluster",
"required":true,
"allowMultiple":false
}
],
"responseMessages":[
{
"code":200,
"message":"OK",
"responseModel":"v1beta1.Cluster"
}
],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"*/*"
]
}
]
},
{
"path":"/apis/federation/v1beta1",
"description":"API at /apis/federation/v1beta1",
"operations":[
{
"type":"v1.APIResourceList",
"method":"GET",
"summary":"get available resources",
"nickname":"getAPIResources",
"parameters":[],
"produces":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
],
"consumes":[
"application/json",
"application/yaml",
"application/vnd.kubernetes.protobuf"
]
}
]
}
],
"models":{
"v1beta1.ClusterList":{
"id":"v1beta1.ClusterList",
"description":"A list of all the kubernetes clusters registered to the federation",
"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: http://releases.k8s.io/HEAD/docs/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources"
},
"metadata":{
"$ref":"v1.ListMeta",
"description":"Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds"
},
"items":{
"type":"array",
"items":{
"$ref":"v1beta1.Cluster"
},
"description":"List of Cluster objects."
}
}
},
"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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency"
}
}
},
"v1beta1.Cluster":{
"id":"v1beta1.Cluster",
"description":"Information about a registered cluster in a federated kubernetes setup. Clusters are not namespaced and have unique names in the federation.",
"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: http://releases.k8s.io/HEAD/docs/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources"
},
"metadata":{
"$ref":"v1.ObjectMeta",
"description":"Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata"
},
"spec":{
"$ref":"v1beta1.ClusterSpec",
"description":"Spec defines the behavior of the Cluster."
},
"status":{
"$ref":"v1beta1.ClusterStatus",
"description":"Status describes the current status of a Cluster"
}
}
},
"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: http://releases.k8s.io/HEAD/docs/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: http://releases.k8s.io/HEAD/docs/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: http://releases.k8s.io/HEAD/docs/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 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: http://releases.k8s.io/HEAD/docs/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."
},
"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: http://releases.k8s.io/HEAD/docs/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."
}
}
},
"v1beta1.ClusterSpec":{
"id":"v1beta1.ClusterSpec",
"description":"ClusterSpec describes the attributes of a kubernetes cluster.",
"required":[
"serverAddressByClientCIDRs"
],
"properties":{
"serverAddressByClientCIDRs":{
"type":"array",
"items":{
"$ref":"v1beta1.ServerAddressByClientCIDR"
},
"description":"A map of client CIDR to server address. 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."
},
"secretRef":{
"$ref":"v1.LocalObjectReference",
"description":"Name of the secret containing kubeconfig to access this cluster. The secret is read from the kubernetes cluster that is hosting federation control plane. Admin needs to ensure that the required secret exists. Secret should be in the same namespace where federation control plane is hosted and it should have kubeconfig in its data with key \"kubeconfig\". This will later be changed to a reference to secret in federation control plane when the federation control plane supports secrets. This can be left empty if the cluster allows insecure access."
}
}
},
"v1beta1.ServerAddressByClientCIDR":{
"id":"v1beta1.ServerAddressByClientCIDR",
"description":"ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.",
"required":[
"clientCIDR",
"serverAddress"
],
"properties":{
"clientCIDR":{
"type":"string",
"description":"The CIDR with which clients can match their IP to figure out the server address that they should use."
},
"serverAddress":{
"type":"string",
"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."
}
}
},
"v1.LocalObjectReference":{
"id":"v1.LocalObjectReference",
"description":"LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties":{
"name":{
"type":"string",
"description":"Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
}
}
},
"v1beta1.ClusterStatus":{
"id":"v1beta1.ClusterStatus",
"description":"ClusterStatus is information about the current status of a cluster updated by cluster controller periodically.",
"properties":{
"conditions":{
"type":"array",
"items":{
"$ref":"v1beta1.ClusterCondition"
},
"description":"Conditions is an array of current cluster conditions."
},
"zones":{
"type":"array",
"items":{
"type":"string"
},
"description":"Zones is the list of availability zones in which the nodes of the cluster exist, e.g. 'us-east1-a'. These will always be in the same region."
},
"region":{
"type":"string",
"description":"Region is the name of the region in which all of the nodes in the cluster exist. e.g. 'us-east1'."
}
}
},
"v1beta1.ClusterCondition":{
"id":"v1beta1.ClusterCondition",
"description":"ClusterCondition describes current state of a cluster.",
"required":[
"type",
"status"
],
"properties":{
"type":{
"type":"string",
"description":"Type of cluster condition, Complete or Failed."
},
"status":{
"type":"string",
"description":"Status of the condition, one of True, False, Unknown."
},
"lastProbeTime":{
"type":"string",
"description":"Last time the condition was checked."
},
"lastTransitionTime":{
"type":"string",
"description":"Last time the condition transit from one status to another."
},
"reason":{
"type":"string",
"description":"(brief) reason for the condition's last transition."
},
"message":{
"type":"string",
"description":"Human readable message indicating details about last transition."
}
}
},
"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: http://releases.k8s.io/HEAD/docs/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources"
},
"metadata":{
"$ref":"v1.ListMeta",
"description":"Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds"
},
"status":{
"type":"string",
"description":"Status of the operation. One of: \"Success\" or \"Failure\". More info: http://releases.k8s.io/HEAD/docs/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds"
},
"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."
}
}
},
"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\""
}
}
},
"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.",
"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: http://releases.k8s.io/HEAD/docs/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: http://releases.k8s.io/HEAD/docs/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":"Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list."
}
}
},
"v1.Preconditions":{
"id":"v1.Preconditions",
"description":"Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.",
"properties":{
"uid":{
"$ref":"types.UID",
"description":"Specifies the target UID."
}
}
},
"types.UID":{
"id":"types.UID",
"properties":{}
},
"v1.APIResourceList":{
"id":"v1.APIResourceList",
"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: http://releases.k8s.io/HEAD/docs/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: http://releases.k8s.io/HEAD/docs/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",
"namespaced",
"kind",
"verbs"
],
"properties":{
"name":{
"type":"string",
"description":"name is the name of the resource."
},
"namespaced":{
"type":"boolean",
"description":"namespaced indicates if a resource is namespaced or not."
},
"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)"
