Class FormDataDefinition

A JSON Schema definition that describes the form's data fields.

Hierarchy

  • FormDataDefinition

Constructors

constructor

Properties

additionalProperties? description? properties? required? title? type?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional description

description?: string

A description shown to form respondents.

Optional properties

properties?: {
    [key: string]: any;
}

A map of field names to their JSON Schema definitions.

Type declaration

  • [key: string]: any

Optional required

required?: string[]

List of field names that must be answered.

Optional title

title?: string

The title of the form schema.

Optional type

type?: FormDataDefinitionType

The root schema type.

Settings

Member Visibility

Theme

Generated using TypeDoc