Skip to main content

GetQueryJsonSchemaOptions

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:19

Options for getQueryJsonSchema.

Properties​

allowFieldValueSource?​

optional allowFieldValueSource?: boolean

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:43

true = allow valueSource: 'field' for all fields; false = never. Default: derived from each field's valueSources.

combinators?​

optional combinators?: FlexibleOptionListProp<FullCombinator>

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:47

Combinators. Default defaultCombinators.

descriptions?​

optional descriptions?: boolean

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:51

Add field labels as descriptions. Default true.

includeIds?​

optional includeIds?: boolean

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:38

Include id/path props. Default false (LLM output shouldn't invent ids).

includeNot?​

optional includeNot?: boolean

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:45

Include not on groups. Default true.

includeSchemaDeclaration?​

optional includeSchemaDeclaration?: boolean

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:53

Emit $schema (draft-07). Default false.

listsAsArrays?​

optional listsAsArrays?: boolean

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:58

List values (between/in/multiselect) as arrays (true, default) or comma-separated strings (false). Should match formatQuery's listsAsArrays.

maxDepth?​

optional maxDepth?: number | "ref"

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:36

Group recursion. 'ref' (default) = recursive $ref. Number = max nested group depth below root, fully inlined (no $ref/$defs) for providers w/o recursion support.

mode?​

optional mode?: "full" | "loose"

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:26

'full' = per-field operator/value constraints (anyOf per field/operator class); 'loose' = field/operator enums only (smaller; for large fields). Default 'full'.

operators?​

optional operators?: FlexibleOptionListProp<FullOperator<string>>

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:49

Fallback operators for fields w/o operators. Default defaultOperators.

queryType?​

optional queryType?: "standard" | "ic"

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:21

'standard' = RuleGroupType; 'ic' = RuleGroupTypeIC. Default 'standard'.

strict?​

optional strict?: boolean

Defined in: packages/core/src/utils/getQueryJsonSchema.ts:31

Provider compat (e.g. OpenAI structured outputs): additionalProperties: false everywhere, all props required (optional ones nullable), root is an object. Default false.

caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.