Documents

Overwrite document body

Replaces the markdown body of one document owned by the authenticated user while preserving metadata.

put/api/v1/documents/{id}/body

Request

  • Base URL: https://mdflow.cz
  • URL: https://mdflow.cz/api/v1/documents/{id}/body
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Document UUID.

Request body

bodystring required

Markdown document body. UTF-8 encoded content must not exceed 512000 bytes.

confirmEmptyboolean

Must be true when body is an empty string. An empty body is otherwise refused with 400, so a client with a cleared or unloaded buffer cannot wipe a document silently.

Response

Updated document.

idstring uuid required
titlestring required
folder_idstring uuid required
is_publicboolean required
workspace_idstring uuid required

The workspace this document belongs to (via its folder).

path_stringstring required

Path segment names joined by " / ".

bodystring required

Markdown document body.

compounded_descriptionstring required

Labeled cascade of descriptions from the workspace down through each ancestor folder to this document's folder. Empty string when nothing in the chain has a description.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.