Skip to content

Interface: ResourcefulObjectType

Instance type for ResourcefulObjectType with validated properties. Represents complex object schemas with typed properties as defined in the OpenAPI 3.0 specification.

See

OpenAPI 3.0 Object Type

Extends

Properties

PropertyTypeDescriptionInherited from
additionalProperties?| boolean | ResourcefulDataTypeWhether additional properties beyond those defined are allowed, or direct data type for additional propertiesResourcefulObjectTypeOptions.additionalProperties
maxProperties?numberMaximum number of properties allowed in the objectResourcefulObjectTypeOptions.maxProperties
minProperties?numberMinimum number of properties required in the objectResourcefulObjectTypeOptions.minProperties
nullable?booleanWhether the value can be nullResourcefulObjectTypeOptions.nullable
properties{ [key: string]: | ResourcefulDataType | { oneOf: ResourcefulDataType[]; } | { allOf: ResourcefulDataType[]; } | { anyOf: ResourcefulDataType[]; } | { not: ResourcefulDataType[]; }; }Object properties definition supporting direct data types and composition patternsResourcefulObjectTypeOptions.properties
readOnly?booleanWhether the property is read-only (not included in create/update operations)ResourcefulObjectTypeOptions.readOnly
required?string[]Array of property names that are required for object validationResourcefulObjectTypeOptions.required
type"object"--
writeOnly?booleanWhether the property is write-only (not included in response serialization)ResourcefulObjectTypeOptions.writeOnly