Skip to main content
Schemaobject

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

JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

Source
specs/apis__apiextensions.k8s.io__v1_openapi.json
Revision
9a79c3bd90f7
Active snapshot
2a9112600697
$ref string
optional
$schema string
optional
allOf array
optional
anyOf array
optional
default
optional

default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.

definitions object
optional
dependencies object
optional
description string
optional
enum array
optional
exclusiveMaximum boolean
optional
exclusiveMinimum boolean
optional
format string
optional

format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: - bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - c…

id string
optional
maxItems integer (int64)
optional
maxLength integer (int64)
optional
maxProperties integer (int64)
optional
maximum number (double)
optional
minItems integer (int64)
optional
minLength integer (int64)
optional
minProperties integer (int64)
optional
minimum number (double)
optional
multipleOf number (double)
optional
nullable boolean
optional
oneOf array
optional
pattern string
optional
patternProperties object
optional
properties object
optional
required array
optional
title string
optional
type string
optional
uniqueItems boolean
optional
x-kubernetes-embedded-resource boolean
optional

x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).

x-kubernetes-int-or-string boolean
optional

x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: 1) anyOf: - type: integer - type: string 2) allOf: - anyOf: - type: integer - type: string - ... zero or more

x-kubernetes-list-map-keys array
optional

x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). The properties specified must either be required or have a default value, to ensure those properties are present for all list items.

x-kubernetes-list-type string
optional

x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: 1) `atomic`: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...). 2) `set`: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type `ato…

x-kubernetes-map-type string
optional

x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: 1) `granular`: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2) `atomic`: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.

x-kubernetes-preserve-unknown-fields boolean
optional

x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.

x-kubernetes-validations array
optional

x-kubernetes-validations describes a list of validation rules written in the CEL expression language.