describe

fun QueryModelSchema.describe(budget: QueryBudget?, defaultListSize: Int?, timeZone: ZoneId = ZoneId.systemDefault()): QueryModelDescriptor

Describes how this model can be queried on one entry, derived from the same capability table and operator specs that admission reads, so the description and admission cannot disagree.

Parameters

budget

the entry's budget; null for an unbudgeted entry.

defaultListSize

the list size an entry applies when a list query sends none.

timeZone

the server's default time zone, used when a request names none.