Documents API¶

Document list/create methods are organization-scoped on client.organizations(). Item methods are on client.documents().

Read¶

Document document = client.documents().get(documentId);

Required scope: documents:read.

Update¶

Document updated = client.documents().update(
    documentId,
    new UpdateDocumentRequest()
        .caption("Validated production procedure")
        .status(DocumentStatus.PUBLISHED)
        .tagNames(List.of("production", "runbook"))
);

Required scope: documents:write.

The update contract supports project scope, title, caption, HTML content, status, archive state, editor IDs, and tag names.

Comment¶

DynamicResource comment = client.documents().addComment(
    documentId,
    new CreateCommentRequest("<p>Reviewed and approved.</p>")
);

Required scope: document_comments:write.

Delete¶

client.documents().delete(documentId);

Required scope: documents:write. Delete is soft.