Skip to content

Interface: ResourcefulObjectTypeOptions

Configuration options for ResourcefulObjectType instances. Defines complex object schemas with typed properties and validation rules. Supports advanced OpenAPI features like oneOf, allOf, anyOf, and not operators.

See

OpenAPI 3.0 Object Type

Extends

Extended by

Properties

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