openmixer — generated API reference
    Preparing search index...

    Interface OpenApiFieldSpec

    One field's declared travel, exactly as the REST reference already carries it.

    interface OpenApiFieldSpec {
        limit: { max: number; min: number; step: number; unit: string } | null;
        name: string;
        perInstance: boolean;
        values: readonly (string | number)[] | null;
        writable: boolean;
    }
    Index
    limit name perInstance values writable
    limit: { max: number; min: number; step: number; unit: string } | null
    name: string
    perInstance: boolean
    values: readonly (string | number)[] | null

    An enumerated field's legal values — declared as a mixed array because the wire enumerates by VALUE, not by type: /clock/force's rate enumerates numbers, /clock/ownership's role enumerates strings. The schema below reads the actual values to pick one JSON Schema type rather than assuming string.

    writable: boolean

    Settings
    Member Visibility

    On This Page
    Properties