Interface FKFieldConfig

Parsed x-fk configuration describing a foreign-key field.

interface FKFieldConfig {
    prefetch: boolean;
    resource: string;
    value?: string;
}

Properties

prefetch: boolean

Load options eagerly instead of on field open.

resource: string

Target resource name (must exist as a collection in the spec).

value?: string

Target property used as the wire value (defaults to the target's primary key).