Interface EditDocumentAction<TDocumentType, TDataset, TProjectId>`Beta`

Represents an action to edit an existing document using patches. Requires the full document handle and an array of patch operations.

interface EditDocumentAction<
    TDocumentType extends string = string,
    TDataset extends string = string,
    TProjectId extends string = string,
> {
    dataset?: TDataset;
    documentId: string;
    documentType: TDocumentType;
    patches?: PatchOperations[];
    perspective?: ReleasePerspective | ClientPerspective;
    projectId?: TProjectId;
    type: "document.edit";
}

Type Parameters

TDocumentType extends string = string
TDataset extends string = string
TProjectId extends string = string

Hierarchy (View Summary)

DocumentHandle<TDocumentType, TDataset, TProjectId>
- EditDocumentAction

Index

Properties

dataset? documentId documentType patches? perspective? projectId? type

Properties

`Optional` `Beta`dataset

dataset?: TDataset

`Beta`documentId

documentId: string

`Beta`documentType

documentType: TDocumentType

`Optional` `Beta`patches

patches?: PatchOperations[]

`Optional` `Beta`perspective

perspective?: ReleasePerspective | ClientPerspective

`Optional` `Beta`projectId

projectId?: TProjectId

`Beta`type

type: "document.edit"