rancher v2.15.1

DynamicSchema.spec.collectionFields.[key]

16 fields
DynamicSchema.spec.collectionFields.[key] fields and descriptions
Field / TypeDescription
create
boolean

Create indicates that this field should be excluded when creating a new object of this schema through the Norman API. If a value is provided for this field in a create request, it will be filtered out and ignored. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be created in the Norman API.

object

Default is the default value for the field.

description
string

Description is the description of this field.

dynamicField
boolean

DynamicField indicates this field should be removed from a schema when embedding another schema into it.

invalidChars
string

InvalidChars defines a value for the "pattern" attribute with the disallowed characters for this field in a CRD derived from this schema. It is also used to validate the value of the string representation of this field in the Norman API. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be created in the Norman API.

max
integer

Max defines the "maximum" attribute for this field in a CRD derived from this schema. It is also used to validate maximum value of this field in the Norman API. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be created in the Norman API.

  • format: int64
maxLength
integer

MaxLength defines the "maxLength" attribute for this field in a CRD derived from this schema. It is also used to validate the length of the string representation of this field in the Norman API. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be created in the Norman API.

  • format: int64
min
integer

Min defines the "minimum" attribute for this field in a CRD derived from this schema. It is also used to validate minimum value of this field in the Norman API. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be created in the Norman API.

  • format: int64
minLength
integer

MinLength defines the "minLength" attribute for this field in a CRD derived from this schema. It is also used to validate the length of the string representation of this field in the Norman API. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be created in the Norman API.

  • format: int64
nullable
boolean

Nullable indicates that a field in a CRD derived from this schema will be nullable. It also indicates whether the field can take a null value in a valid object of this schema in the Norman API. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be created in the Norman API.

string[]

Options defines the "enum" attribute with valid values for this field in a CRD derived from this schema. It is also used to validate the value of the string representation of this field in the Norman API. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be created in the Norman API.

required
boolean

Required indicates that a field in a CRD derived from this schema will be required. It also indicates that this field is required when creating a new object of this schema through the Norman API. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be created in the Norman API.

type
string

Type is the type of the field. Possible types are "string", "password", "boolean", "int", "array[string]" or another schema name.

unique
boolean

Unique has no effect.

update
boolean

Update indicates that this field should remain unchanged when updating an object of this schema through the Norman API. If a value is provided for this field in an update request, it will be filtered out and ignored. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be updated in the Norman API.

validChars
string

ValidChars defines a value for the "pattern" attribute with the allowed characters for this field in a CRD derived from this schema. It is also used to validate the value of the string representation of this field in the Norman API. No Norman stores are defined for DynamicSchemas, so no resources of this schema can be created in the Norman API.