Schemaobject

io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

Source: specs/apis__apiextensions.k8s.io__v1_openapi.json
Revision: 9a79c3bd90f7
Active snapshot: 2a9112600697

categories array

optional

categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.

kind string

required

kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.

listKind string

optional

listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".

plural string

required

plural is the plural name of the resource to serve. The custom resources are served under `/apis/<group>/<version>/.../<plural>`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). Must be all lowercase.

shortNames array

optional

shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get <shortname>`. It must be all lowercase.

singular string

optional

singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.

Root JSON Schema

{"description":"CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition","properties":{"categories":{"description":"categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.","items":{"type":"string"},"type":"array","x-kubernetes-list-type":"atomic"},"kind":{"default":"","description":"kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.","type":"string"},"listKind":{"description":"listKind is the serialized kind of the list for this resource. Defaults to \"`kind`List\".","type":"string"},"plural":{"default":"","description":"plural is the plural name of the resource to serve. The custom resources are served under `/apis/\u003cgroup\u003e/\u003cversion\u003e/.../\u003cplural\u003e`. Must match the name of the CustomResourceDefinition (in the form `\u003cnames.plural\u003e.\u003cgroup\u003e`). Must be all lowercase.","type":"string"},"shortNames":{"description":"shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get \u003cshortname\u003e`. It must be all lowercase.","items":{"type":"string"},"type":"array","x-kubernetes-list-type":"atomic"},"singular":{"description":"singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.","type":"string"}},"required":["plural","kind"],"type":"object"}