js-bao-wss-client / UpdateDocumentData
Interface: UpdateDocumentData
Data for updating document metadata.
All keys are optional and use replace semantics: a missing key leaves the server-side field unchanged, an explicit null clears it. To round-trip a value unchanged, simply omit the key.
Properties
metadata?
optionalmetadata?:unknown
Opaque JSON-serializable metadata blob (≤ 4 KB serialized UTF-8). Pass null to clear. The server does not introspect the value — it round-trips whatever you set. Note: JSON.stringify silently drops top-level undefined from the request body, so you must pass null explicitly to clear (passing undefined is interpreted as "leave unchanged").
thumbnailBlobId?
optionalthumbnailBlobId?:string|null
Reference to a Blob whose documentId is this document. Pass null to clear. Server validates that the blob exists and belongs to the same document; rejects mismatches with a 400 (BLOB_DOC_MISMATCH).
title?
optionaltitle?:string
The new display title for the document.