Skip to main content

Module fields

Module fields 

Source
Expand description

The set of fields each list command can emit, and validation of --fields.

These tables are the single source of truth. schema publishes them as output_fields, and --fields validates against them, so the contract an agent reads is exactly the contract the CLI enforces.

A --fields request naming something outside the table is a usage error. Silently dropping it, as this once did, hands back {} per row with exit 0, which is indistinguishable from a successful query that found nothing.

Structs§

InvalidFields
A --fields request naming one or more unknown fields.

Constants§

CLIENTS_LIST
CLIENTS_SHOW
DEVICES_LIST
EVENTS_LIST
NETWORKS_LIST

Functions§

names
Field names of a table, in declaration order.
validate
Parse and validate a comma-separated --fields spec against a table.

Type Aliases§

Field
A field name paired with its JSON type, as published in unifi schema.