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.

Source

default=(default : JSON | Nil)

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.

Source

definitions

Source

definitions=(definitions : Hash(String, JSONSchemaProps) | Nil)

Source

dependencies

Source

dependencies=(dependencies : Hash(String, JSONSchemaPropsOrStringArray) | Nil)

Source

description

Source

description=(description : String | Nil)

Source

enum

Source

enum=(enum __arg0 : Array(JSON) | Nil)

Source

example

Source

example=(example : JSON | Nil)

Source

exclusive_maximum

Source

exclusive_maximum=(exclusive_maximum : Bool | Nil)

Source

exclusive_minimum

Source

exclusive_minimum=(exclusive_minimum : Bool | Nil)

Source

external_docs

Source

external_docs=(external_docs : ExternalDocumentation | Nil)

Source

format

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 - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.

Source

format=(format : String | Nil)

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 - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.

Source

id=(id : String | Nil)

Source

items

Source

items=(items : JSONSchemaPropsOrArray | Nil)

Source

max_items

Source

max_items=(max_items : Int64 | Nil)

Source

max_length

Source

max_length=(max_length : Int64 | Nil)

Source

max_properties

Source

max_properties=(max_properties : Int64 | Nil)

Source

maximum

Source

maximum=(maximum : Float64 | Nil)

Source

min_items

Source

min_items=(min_items : Int64 | Nil)

Source

min_length

Source

min_length=(min_length : Int64 | Nil)

Source

min_properties

Source

min_properties=(min_properties : Int64 | Nil)

Source

minimum

Source

minimum=(minimum : Float64 | Nil)

Source

multiple_of

Source

multiple_of=(multiple_of : Float64 | Nil)

Source

not

Source

not=(not : JSONSchemaProps | Nil)

Source

nullable

Source

nullable=(nullable : Bool | Nil)

Source

one_of

Source

one_of=(one_of : Array(JSONSchemaProps) | Nil)

Source

pattern

Source

pattern=(pattern : String | Nil)

Source

pattern_properties

Source

pattern_properties=(pattern_properties : Hash(String, JSONSchemaProps) | Nil)

Source

properties

Source

properties=(properties : Hash(String, JSONSchemaProps) | Nil)

Source

ref_ref

Source

ref_ref=(ref_ref : String | Nil)

Source

ref_schema

Source

ref_schema=(ref_schema : String | Nil)

Source

required

Source

required=(required : Array(String) | Nil)

Source

title

Source

title=(title : String | Nil)

Source

type

Source

type=(type : String | Nil)

Source

unique_items

Source

unique_items=(unique_items : Bool | Nil)

Source

x_kubernetes_embedded_resource

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).

Source

x_kubernetes_embedded_resource=(x_kubernetes_embedded_resource : Bool | Nil)

Source

x_kubernetes_int_or_string

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:

anyOf:

type: integer
type: string

allOf:

anyOf:
type: integer
type: string
... zero or more

Source

x_kubernetes_int_or_string=(x_kubernetes_int_or_string : Bool | Nil)

anyOf:

type: integer
type: string

allOf:

anyOf:
type: integer
type: string
... zero or more

Source

x_kubernetes_list_map_keys

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.

Source

x_kubernetes_list_map_keys=(x_kubernetes_list_map_keys : Array(String) | Nil)

Source

x_kubernetes_list_type

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:

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, ...).
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 atomic or an array with x-kubernetes-list-type atomic.
map: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.

Source

x_kubernetes_list_type=(x_kubernetes_list_type : String | Nil)

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:

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, ...).
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 atomic or an array with x-kubernetes-list-type atomic.
map: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.

Source

x_kubernetes_map_type

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:

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.
atomic: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.

Source

x_kubernetes_map_type=(x_kubernetes_map_type : String | Nil)

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:

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.
atomic: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.

Source

x_kubernetes_preserve_unknown_fields

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.

Source

x_kubernetes_preserve_unknown_fields=(x_kubernetes_preserve_unknown_fields : Bool | Nil)

Source

x_kubernetes_validations

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

Source

x_kubernetes_validations=(x_kubernetes_validations : Array(ValidationRule) | Nil)

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

Source

Macros

field(name, type = nil, **options, &block)

Helper macro for defining fields with automatic camelCase conversion

Source