Compartilhar via


DocumentFieldSchema interface

Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.

Propriedades

description

Descrição do campo.

example

Conteúdo do campo de exemplo.

items

Esquema de tipo de campo de cada elemento de matriz.

properties

Subcampos nomeados do campo de objeto.

type

Tipo de dados semânticos do valor do campo.

Detalhes da propriedade

description

Descrição do campo.

description?: string

Valor da propriedade

string

example

Conteúdo do campo de exemplo.

example?: string

Valor da propriedade

string

items

Esquema de tipo de campo de cada elemento de matriz.

items?: DocumentFieldSchema

Valor da propriedade

properties

Subcampos nomeados do campo de objeto.

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

Valor da propriedade

{[propertyName: string]: DocumentFieldSchema}

type

Tipo de dados semânticos do valor do campo.

type: string

Valor da propriedade

string