JSON-SCHEMA-TO-MARKDOWN-TOOL
Example Output:
Simple Schema
https://example.com/arrays.schema.json
A representation of a person, company, organization, or place
http://json-schema.org/draft-07/schema#
properties
fruits
| type | items.type |
|---|---|
| array | string |
vegetables
| type | items.$ref |
|---|---|
| array | #/definitions/veggie |
definitions
veggie
| type | required | properties.veggieName.type | properties.veggieName.description | properties.veggieLike.type | properties.veggieLike.description |
|---|---|---|---|---|---|
| object | veggieName;veggieLike | string | The name of the vegetable. | boolean | Do I like this vegetable? |
Simple Schema 2
http://json-schema.org/draft-06/schema#
properties
billing_address
| $ref |
|---|
/definitions/address
shipping_address
| allOf |
|---|
allOf
| $ref | properties.type.enum | required |
|---|---|---|
| #/definitions/address | ||
| residential;business | type |
definitions
address
| type | properties.street_address.type | properties.city.type | properties.state.type | required |
|---|---|---|---|---|
| object | string | string | string | street_address;city;state |
Kubernetes v1.9.9-standalone/nodelist.json
NodeList is the whole list of all Nodes which have been registered with master.
properties
items
| items.x-kubernetes-group-version-kind | items.description | items.properties.status.description | items.properties.status.properties.capacity.additionalProperties.oneOf | items.properties.status.properties.capacity.type | items.properties.status.properties.capacity.description | items.properties.status.properties.addresses.items.required | items.properties.status.properties.addresses.items.description | items.properties.status.properties.addresses.items.properties.type.type | items.properties.status.properties.addresses.items.properties.type.description | items.properties.status.properties.addresses.items.properties.address.type | items.properties.status.properties.addresses.items.properties.address.description | items.properties.status.properties.addresses.x-kubernetes-patch-merge-key | items.properties.status.properties.addresses.type | items.properties.status.properties.addresses.description | items.properties.status.properties.addresses.x-kubernetes-patch-strategy | items.properties.status.properties.images.items.required | items.properties.status.properties.images.items.description | items.properties.status.properties.images.items.properties.sizeBytes.type | items.properties.status.properties.images.items.properties.sizeBytes.description | items.properties.status.properties.images.items.properties.sizeBytes.format | items.properties.status.properties.images.items.properties.names.items.type | items.properties.status.properties.images.items.properties.names.type | items.properties.status.properties.images.items.properties.names.description | items.properties.status.properties.images.type | items.properties.status.properties.images.description | items.properties.status.properties.nodeInfo.required | items.properties.status.properties.nodeInfo.description | items.properties.status.properties.nodeInfo.properties.kernelVersion.type | items.properties.status.properties.nodeInfo.properties.kernelVersion.description | items.properties.status.properties.nodeInfo.properties.kubeletVersion.type | items.properties.status.properties.nodeInfo.properties.kubeletVersion.description | items.properties.status.properties.nodeInfo.properties.containerRuntimeVersion.type | items.properties.status.properties.nodeInfo.properties.containerRuntimeVersion.description | items.properties.status.properties.nodeInfo.properties.machineID.type | items.properties.status.properties.nodeInfo.properties.machineID.description | items.properties.status.properties.nodeInfo.properties.kubeProxyVersion.type | items.properties.status.properties.nodeInfo.properties.kubeProxyVersion.description | items.properties.status.properties.nodeInfo.properties.bootID.type | items.properties.status.properties.nodeInfo.properties.bootID.description | items.properties.status.properties.nodeInfo.properties.osImage.type | items.properties.status.properties.nodeInfo.properties.osImage.description | items.properties.status.properties.nodeInfo.properties.architecture.type | items.properties.status.properties.nodeInfo.properties.architecture.description | items.properties.status.properties.nodeInfo.properties.systemUUID.type | items.properties.status.properties.nodeInfo.properties.systemUUID.description | items.properties.status.properties.nodeInfo.properties.operatingSystem.type | items.properties.status.properties.nodeInfo.properties.operatingSystem.description | items.properties.status.properties.volumesAttached.items.required | items.properties.status.properties.volumesAttached.items.description | items.properties.status.properties.volumesAttached.items.properties.devicePath.type | items.properties.status.properties.volumesAttached.items.properties.devicePath.description | items.properties.status.properties.volumesAttached.items.properties.name.type | items.properties.status.properties.volumesAttached.items.properties.name.description | items.properties.status.properties.volumesAttached.type | items.properties.status.properties.volumesAttached.description | items.properties.status.properties.allocatable.additionalProperties.oneOf | items.properties.status.properties.allocatable.type | items.properties.status.properties.allocatable.description | items.properties.status.properties.volumesInUse.items.type | items.properties.status.properties.volumesInUse.type | items.properties.status.properties.volumesInUse.description | items.properties.status.properties.daemonEndpoints.description | items.properties.status.properties.daemonEndpoints.properties.kubeletEndpoint.required | items.properties.status.properties.daemonEndpoints.properties.kubeletEndpoint.description | items.properties.status.properties.daemonEndpoints.properties.kubeletEndpoint.properties.Port.type | items.properties.status.properties.daemonEndpoints.properties.kubeletEndpoint.properties.Port.description | items.properties.status.properties.daemonEndpoints.properties.kubeletEndpoint.properties.Port.format | items.properties.status.properties.phase.type | items.properties.status.properties.phase.description | items.properties.status.properties.conditions.items.required | items.properties.status.properties.conditions.items.description | items.properties.status.properties.conditions.items.properties.status.type | items.properties.status.properties.conditions.items.properties.status.description | items.properties.status.properties.conditions.items.properties.lastTransitionTime.type | items.properties.status.properties.conditions.items.properties.lastTransitionTime.format | items.properties.status.properties.conditions.items.properties.lastHeartbeatTime.type | items.properties.status.properties.conditions.items.properties.lastHeartbeatTime.format | items.properties.status.properties.conditions.items.properties.reason.type | items.properties.status.properties.conditions.items.properties.reason.description | items.properties.status.properties.conditions.items.properties.message.type | items.properties.status.properties.conditions.items.properties.message.description | items.properties.status.properties.conditions.items.properties.type.type | items.properties.status.properties.conditions.items.properties.type.description | items.properties.status.properties.conditions.x-kubernetes-patch-merge-key | items.properties.status.properties.conditions.type | items.properties.status.properties.conditions.description | items.properties.status.properties.conditions.x-kubernetes-patch-strategy | items.properties.kind.type | items.properties.kind.description | items.properties.spec.description | items.properties.spec.properties.unschedulable.type | items.properties.spec.properties.unschedulable.description | items.properties.spec.properties.configSource.x-kubernetes-group-version-kind | items.properties.spec.properties.configSource.description | items.properties.spec.properties.configSource.properties.kind.type | items.properties.spec.properties.configSource.properties.kind.description | items.properties.spec.properties.configSource.properties.configMapRef.description | items.properties.spec.properties.configSource.properties.configMapRef.properties.kind.type | items.properties.spec.properties.configSource.properties.configMapRef.properties.kind.description | items.properties.spec.properties.configSource.properties.configMapRef.properties.name.type | items.properties.spec.properties.configSource.properties.configMapRef.properties.name.description | items.properties.spec.properties.configSource.properties.configMapRef.properties.namespace.type | items.properties.spec.properties.configSource.properties.configMapRef.properties.namespace.description | items.properties.spec.properties.configSource.properties.configMapRef.properties.apiVersion.type | items.properties.spec.properties.configSource.properties.configMapRef.properties.apiVersion.description | items.properties.spec.properties.configSource.properties.configMapRef.properties.fieldPath.type | items.properties.spec.properties.configSource.properties.configMapRef.properties.fieldPath.description | items.properties.spec.properties.configSource.properties.configMapRef.properties.resourceVersion.type | items.properties.spec.properties.configSource.properties.configMapRef.properties.resourceVersion.description | items.properties.spec.properties.configSource.properties.configMapRef.properties.uid.type | items.properties.spec.properties.configSource.properties.configMapRef.properties.uid.description | items.properties.spec.properties.configSource.properties.apiVersion.type | items.properties.spec.properties.configSource.properties.apiVersion.description | items.properties.spec.properties.taints.items.required | items.properties.spec.properties.taints.items.description | items.properties.spec.properties.taints.items.properties.key.type | items.properties.spec.properties.taints.items.properties.key.description | items.properties.spec.properties.taints.items.properties.timeAdded.type | items.properties.spec.properties.taints.items.properties.timeAdded.format | items.properties.spec.properties.taints.items.properties.effect.type | items.properties.spec.properties.taints.items.properties.effect.description | items.properties.spec.properties.taints.items.properties.value.type | items.properties.spec.properties.taints.items.properties.value.description | items.properties.spec.properties.taints.type | items.properties.spec.properties.taints.description | items.properties.spec.properties.podCIDR.type | items.properties.spec.properties.podCIDR.description | items.properties.spec.properties.providerID.type | items.properties.spec.properties.providerID.description | items.properties.spec.properties.externalID.type | items.properties.spec.properties.externalID.description | items.properties.apiVersion.type | items.properties.apiVersion.description | items.properties.metadata.description | items.properties.metadata.properties.ownerReferences.items.required | items.properties.metadata.properties.ownerReferences.items.description | items.properties.metadata.properties.ownerReferences.items.properties.kind.type | items.properties.metadata.properties.ownerReferences.items.properties.kind.description | items.properties.metadata.properties.ownerReferences.items.properties.uid.type | items.properties.metadata.properties.ownerReferences.items.properties.uid.description | items.properties.metadata.properties.ownerReferences.items.properties.apiVersion.type | items.properties.metadata.properties.ownerReferences.items.properties.apiVersion.description | items.properties.metadata.properties.ownerReferences.items.properties.controller.type | items.properties.metadata.properties.ownerReferences.items.properties.controller.description | items.properties.metadata.properties.ownerReferences.items.properties.blockOwnerDeletion.type | items.properties.metadata.properties.ownerReferences.items.properties.blockOwnerDeletion.description | items.properties.metadata.properties.ownerReferences.items.properties.name.type | items.properties.metadata.properties.ownerReferences.items.properties.name.description | items.properties.metadata.properties.ownerReferences.x-kubernetes-patch-merge-key | items.properties.metadata.properties.ownerReferences.type | items.properties.metadata.properties.ownerReferences.description | items.properties.metadata.properties.ownerReferences.x-kubernetes-patch-strategy | items.properties.metadata.properties.uid.type | items.properties.metadata.properties.uid.description | items.properties.metadata.properties.deletionTimestamp.type | items.properties.metadata.properties.deletionTimestamp.format | items.properties.metadata.properties.clusterName.type | items.properties.metadata.properties.clusterName.description | items.properties.metadata.properties.deletionGracePeriodSeconds.type | items.properties.metadata.properties.deletionGracePeriodSeconds.description | items.properties.metadata.properties.deletionGracePeriodSeconds.format | items.properties.metadata.properties.labels.additionalProperties.type | items.properties.metadata.properties.labels.type | items.properties.metadata.properties.labels.description | items.properties.metadata.properties.namespace.type | items.properties.metadata.properties.namespace.description | items.properties.metadata.properties.finalizers.items.type | items.properties.metadata.properties.finalizers.type | items.properties.metadata.properties.finalizers.description | items.properties.metadata.properties.finalizers.x-kubernetes-patch-strategy | items.properties.metadata.properties.generation.type | items.properties.metadata.properties.generation.description | items.properties.metadata.properties.generation.format | items.properties.metadata.properties.initializers.required | items.properties.metadata.properties.initializers.description | items.properties.metadata.properties.initializers.properties.result.x-kubernetes-group-version-kind | items.properties.metadata.properties.initializers.properties.result.description | items.properties.metadata.properties.initializers.properties.result.properties.status.type | items.properties.metadata.properties.initializers.properties.result.properties.status.description | items.properties.metadata.properties.initializers.properties.result.properties.kind.type | items.properties.metadata.properties.initializers.properties.result.properties.kind.description | items.properties.metadata.properties.initializers.properties.result.properties.code.type | items.properties.metadata.properties.initializers.properties.result.properties.code.description | items.properties.metadata.properties.initializers.properties.result.properties.code.format | items.properties.metadata.properties.initializers.properties.result.properties.apiVersion.type | items.properties.metadata.properties.initializers.properties.result.properties.apiVersion.description | items.properties.metadata.properties.initializers.properties.result.properties.reason.type | items.properties.metadata.properties.initializers.properties.result.properties.reason.description | items.properties.metadata.properties.initializers.properties.result.properties.details.description | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.kind.type | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.kind.description | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.group.type | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.group.description | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.name.type | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.name.description | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.retryAfterSeconds.type | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.retryAfterSeconds.description | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.retryAfterSeconds.format | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.causes.items.description | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.causes.items.properties.field.type | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.causes.items.properties.field.description | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.causes.items.properties.message.type | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.causes.items.properties.message.description | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.causes.items.properties.reason.type | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.causes.items.properties.reason.description | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.causes.type | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.causes.description | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.uid.type | items.properties.metadata.properties.initializers.properties.result.properties.details.properties.uid.description | items.properties.metadata.properties.initializers.properties.result.properties.message.type | items.properties.metadata.properties.initializers.properties.result.properties.message.description | items.properties.metadata.properties.initializers.properties.result.properties.metadata.description | items.properties.metadata.properties.initializers.properties.result.properties.metadata.properties.continue.type | items.properties.metadata.properties.initializers.properties.result.properties.metadata.properties.continue.description | items.properties.metadata.properties.initializers.properties.result.properties.metadata.properties.selfLink.type | items.properties.metadata.properties.initializers.properties.result.properties.metadata.properties.selfLink.description | items.properties.metadata.properties.initializers.properties.result.properties.metadata.properties.resourceVersion.type | items.properties.metadata.properties.initializers.properties.result.properties.metadata.properties.resourceVersion.description | items.properties.metadata.properties.initializers.properties.pending.items.required | items.properties.metadata.properties.initializers.properties.pending.items.description | items.properties.metadata.properties.initializers.properties.pending.items.properties.name.type | items.properties.metadata.properties.initializers.properties.pending.items.properties.name.description | items.properties.metadata.properties.initializers.properties.pending.x-kubernetes-patch-merge-key | items.properties.metadata.properties.initializers.properties.pending.type | items.properties.metadata.properties.initializers.properties.pending.description | items.properties.metadata.properties.initializers.properties.pending.x-kubernetes-patch-strategy | items.properties.metadata.properties.resourceVersion.type | items.properties.metadata.properties.resourceVersion.description | items.properties.metadata.properties.generateName.type | items.properties.metadata.properties.generateName.description | items.properties.metadata.properties.creationTimestamp.type | items.properties.metadata.properties.creationTimestamp.format | items.properties.metadata.properties.annotations.additionalProperties.type | items.properties.metadata.properties.annotations.type | items.properties.metadata.properties.annotations.description | items.properties.metadata.properties.selfLink.type | items.properties.metadata.properties.selfLink.description | items.properties.metadata.properties.name.type | items.properties.metadata.properties.name.description | type | description |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). | NodeStatus is information about the current status of a node. | 2 | object | Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | type;address | NodeAddress contains information for the node's address. | string | Node address type, one of Hostname, ExternalIP or InternalIP. | string | The node address. | type | array;null | List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses | merge | names | Describe a container image | integer | The size of the image in bytes. | int64 | string;null | array | Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"] | array;null | List of container images on this node | machineID;systemUUID;bootID;kernelVersion;osImage;containerRuntimeVersion;kubeletVersion;kubeProxyVersion;operatingSystem;architecture | NodeSystemInfo is a set of ids/uuids to uniquely identify the node. | string | Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). | string | Kubelet Version reported by the node. | string | ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0). | string | MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html | string | KubeProxy Version reported by the node. | string | Boot ID reported by the node. | string | OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). | string | The Architecture reported by the node | string | SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html | string | The Operating System reported by the node | name;devicePath | AttachedVolume describes a volume attached to a node | string | DevicePath represents the device path where the volume should be available | string | Name of the attached volume | array;null | List of volumes that are attached to the node. | 2 | object | Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. | string;null | array;null | List of attachable volumes in use (mounted) by the node. | NodeDaemonEndpoints lists ports opened by daemons running on the Node. | Port | DaemonEndpoint contains information about a single Daemon endpoint. | integer | Port number of the given endpoint. | int32 | string;null | NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated. | type;status | NodeCondition contains condition information for a node. | string | Status of the condition, one of True, False, Unknown. | string;null | date-time | string;null | date-time | string;null | (brief) reason for the condition's last transition. | string;null | Human readable message indicating details about last transition. | string | Type of node condition. | type | array;null | Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition | merge | string;null | 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 | NodeSpec describes the attributes that a node is created with. | boolean | Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration | 1 | NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. | string;null | 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 | ObjectReference contains enough information to let you inspect or modify the referred object. | string;null | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | string;null | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | string;null | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | string;null | API version of the referent. | string;null | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. | string;null | Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency | string;null | UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids | string;null | 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 | key;effect | The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. | string | Required. The taint key to be applied to a node. | string;null | date-time | string | Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. | string;null | Required. The taint value corresponding to the taint key. | array;null | If specified, the node's taints. | string;null | PodCIDR represents the pod IP range assigned to the node. | string;null | ID of the node assigned by the cloud provider in the format: :// | string;null | External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated. | string;null | 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 | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. | apiVersion;kind;name;uid | 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. | string | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds | string | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | string | API version of the referent. | boolean | If true, this reference points to the managing controller. | boolean | 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. | string | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names | uid | array;null | 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. | merge | string;null | 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.Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids | string;null | date-time | string;null | 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. | integer | 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. | int64 | string;null | object | 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 | string;null | 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.Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces | string;null | array;null | 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. | merge | integer | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | int64 | pending | Initializers tracks the progress of initialization. | 1 | Status is a return value for calls that don't return other objects. | string;null | Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status | string;null | 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 | integer | Suggested HTTP return code for this status, 0 if not set. | int32 | string;null | 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 | string;null | 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. | 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. | string;null | 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 | string;null | The group attribute of the resource associated with the status StatusReason. | string;null | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | integer | 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. | int32 | StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered. | string;null | 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.Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items" | string;null | A human-readable description of the cause of the error. This field may be presented as-is to a reader. | string;null | A machine-readable description of the cause of the error. If this value is empty there is no information available. | array;null | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. | string;null | UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids | string;null | A human-readable description of the status of this operation. | ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. | string;null | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response. | string;null | selfLink is a URL representing this object. Populated by the system. Read-only. | string;null | 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 | name | Initializer is information about an initializer that has not yet completed. | string | name of the process that is responsible for initializing this object. | name | array | 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. | merge | string;null | 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.Populated 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 | string;null | 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.If 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).Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency | string;null | date-time | string;null | object | 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 | string;null | SelfLink is a URL representing this object. Populated by the system. Read-only. | string;null | 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 | array;null | List of nodes |
items.x-kubernetes-group-version-kind
| kind | version | group |
|---|---|---|
| Node | v1 |
items.properties.status.properties.capacity.additionalProperties.oneOf
| type |
|---|
string;null integer
items.properties.status.properties.allocatable.additionalProperties.oneOf
| type |
|---|
string;null integer
items.properties.spec.properties.configSource.x-kubernetes-group-version-kind
| kind | version | group |
|---|---|---|
| NodeConfigSource | v1 |
items.properties.metadata.properties.initializers.properties.result.x-kubernetes-group-version-kind
| kind | version | group |
|---|---|---|
| Status | v1 |
kind
| type | description |
|---|---|
| string;null | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
apiVersion
| type | description |
|---|---|
| string;null | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources |
metadata
| description | properties.continue.type | properties.continue.description | properties.selfLink.type | properties.selfLink.description | properties.resourceVersion.type | properties.resourceVersion.description |
|---|---|---|---|---|---|---|
| ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. | string;null | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response. | string;null | selfLink is a URL representing this object. Populated by the system. Read-only. | string;null | 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 |
definitions
Contributing
- Clone the repo and run
npm install. - Create a new feature branch:
git checkout -b feature/your-feature-branch-name. - Write a test in the
__tests__folder for your feature. - Write the code to get the test passing, running
npm run test. - Push your branch up and submit a pull request.
Note: I have configured a launch.json for vscode that should allow for playing around with anything in index.ts and hitting f5 to debug.
Publishing
- npm version patch
- npm publish