Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentFieldSchema

Package version

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

Hierarchy

  • DocumentFieldSchema

Index

Properties

Optional description

description: undefined | string

Field description.

Optional example

example: undefined | string

Example field content.

Optional items

Field type schema of each array element.

Optional properties

properties: undefined | {}

Named sub-fields of the object field.

type

Semantic data type of the field value.

Generated using TypeDoc