Type_Property

struct

Represents an individual property field inside a top-level struct definition.

Property Type Description
deprecated Boolean

Indicates whether this field is deprecated. Defaults to false if omitted.

description String

Plain text description of the property field.

name String

Field name for this property (e.g., 'firstName', 'created_at').

nullable Boolean

Indicates whether this property value can be null. Defaults to false if omitted.

reference String

Target type name referenced by this property. Required when 'type' is set to 'object' (referenced struct), 'map' (value type), or 'array' (element type). Omit for primitive types.

type String

Data type of this property. Must be strictly one of: 'string', 'integer', 'number', 'boolean', 'object', 'map', 'array', or 'any'. When set to 'object', 'map', or 'array', the 'reference' property must also be set.

part of the Apioo-Project