Package version:

Interface DocumentFieldSchema

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

Hierarchy

  • DocumentFieldSchema

Properties

description? example? items? properties? type

Properties

Optional description

description?: string

Field description.

Optional example

example?: string

Example field content.

Optional items

items?: DocumentFieldSchema

Field type schema of each array element.

Optional properties

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

Named sub-fields of the object field.

Type declaration

type

type: string

Semantic data type of the field value.

Settings

Member Visibility

Theme

Generated using TypeDoc