SchemaOptions

When enabled, the generated JSON schema will include enumerations for fields that have defined choice lists (such as drop-downs or picklists). This provides consumers of the schema with the set of valid values for each field, supporting validation and UI generation in external systems.

When enabled, the generated JSON schema will include descriptions for each field, section, and table, based on their configured documentation in Grooper. These descriptions appear in the schema's description properties and can be used for documentation, tooltips, or code generation in external systems.

When enabled, the generated JSON schema will include extended information about each field.

The following extended properties may be included:

• x-computedValue: For computed fields, this property contains the formula used to calculate the field's value.
• x-expectedValue: For non-computed fields with an expected value formula, this property contains that formula.
• x-isValidIf: If the field has a conditional validation formula, this property contains that formula.
• x-isRequiredIf: If the field has a conditional required formula, this property contains that formula.
• x-readOnly: If the field is marked as read-only, this property will be set to true.
• x-valueDelimiter: For array fields, this property contains the delimiter used to separate values.
• x-validationNotes: This property contains any validation notes or constraints defined for the field.
• x-typeName: This property contains the .NET type name of the field's storage type.

When enabled, the generated JSON schema will define reusable types for fields, sections, and tables in the schema's definitions (or $defs) block. Data elements that share the same structure will reference these type definitions using $ref, reducing duplication and improving schema maintainability.

If true, each field, section, and table in the generated JSON schema will include its unique identifier (ID) as defined in Grooper. The guid ID will be included in a custom property (e.g., x-grooper-id) within the schema definition for each element.

If true, each field, section, and table in the generated JSON schema will include its .NET type name as defined in Grooper.

If true, fields that are marked as hidden in Grooper will be included in the generated JSON schema.

If true, fields that are marked as computed (calculated) in Grooper will be included in the generated JSON schema.