$idstring Required

Must be at least 1 characters long

Must be at most 64 characters long

$schemaconst Required

Specific value: "https://schema.yext.com/config/liveindex/spec/v1"

schemastring Required

The schema of the documents in the index.

Must match regular expression: ^https://schema.yext.com/schemas/

sourceLabelstring Required

Defines the source documents that should be indexed.

fieldIndexesarray of object

The indexes that should be created on fields from the schema.

Each item of this array must be:

Type: object

string Required

inputTransform

A transformation applied to each incoming document.

Type: object

The following properties are required:

  • jsonpatch
Type: object

The following properties are required:

  • jmespath

array

Each item of this array must be:

Type: object

string