DocumentFieldSchema interface
使用 JSON 架构样式语法描述字段语义架构。
属性
description | 字段说明。 |
example | 示例字段内容。 |
items | 每个数组元素的字段类型架构。 |
properties | 对象字段的命名子字段。 |
type | 字段值的语义数据类型。 |
属性详细信息
description
字段说明。
description?: string
属性值
string
example
示例字段内容。
example?: string
属性值
string
items
properties
对象字段的命名子字段。
properties?: {[propertyName: string]: DocumentFieldSchema}
属性值
{[propertyName: string]: DocumentFieldSchema}
type
字段值的语义数据类型。
type: string
属性值
string