Type Alias DocumentUpdatePayload

Payload for updating an existing document

type DocumentUpdatePayload = {
    content?: string;
    fields?: DocumentField[];
    path: string;
    sources?: DocumentSource[];
    variant?: string;
    version?: number;
}

Index

Properties

content? fields? path sources? variant? version?

Properties

`Optional`content

content?: string

Updated content

`Optional`fields

fields?: DocumentField[]

Updated fields metadata

path

path: string

Document path (including directory and filename)

`Optional`sources

sources?: DocumentSource[]

Updated sources metadata

`Optional`variant

variant?: string

Variant to update

`Optional`version

version?: number

Current version used for optimistic locking