DocumentFieldSchema interface

Description of the field semantic schema using a JSON Schema style syntax.

Properties

description	Field description.
example	Example field content.
items	Field type schema of each array element.
properties	Named sub-fields of the object field.
type	Semantic data type of the field value.

Field description.

description?: string

string

Example field content.

example?: string

string

Field type schema of each array element.

items?: DocumentFieldSchema

Named sub-fields of the object field.

properties?: {[propertyName: string]: DocumentFieldSchema}

{[propertyName: string]: DocumentFieldSchema}

Semantic data type of the field value.

type: string

string