{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Document", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the object.", "readOnly": true, "format": "uuid" }, "collectionId": { "type": "string", "description": "Identifier for the associated collection.", "format": "uuid", "nullable": true }, "parentDocumentId": { "type": "string", "description": "Identifier for the document this is a child of, if any.", "format": "uuid", "nullable": true }, "title": { "type": "string", "description": "The title of the document.", "example": "Welcome to Acme Inc" }, "fullWidth": { "type": "boolean", "description": "Whether this document should be displayed in a full-width view." }, "icon": { "type": "string", "nullable": true, "description": "An emoji or icon associated with the document.", "example": "\ud83c\udf89" }, "color": { "type": "string", "nullable": true, "description": "The color of the document icon in hex format." }, "text": { "type": "string", "description": "The text content of the document, contains markdown formatting", "example": "\u2026" }, "data": { "type": "object", "nullable": true, "description": "The body of the document as a Prosemirror document, returned in place of text when requested." }, "url": { "type": "string", "description": "A URL path to access the document.", "readOnly": true }, "urlId": { "type": "string", "description": "A short unique ID that can be used to identify the document as an alternative to the UUID", "example": "hDYep1TPAM" }, "collaboratorIds": { "type": "array", "description": "Identifiers of users who have edited the document.", "items": { "type": "string", "format": "uuid" } }, "tasks": { "type": "object", "description": "Task completion counts for the document.", "properties": { "completed": { "type": "number" }, "total": { "type": "number" } } }, "templateId": { "type": "string", "description": "Unique identifier for the template this document was created from, if any", "format": "uuid" }, "revision": { "type": "number", "description": "A number that is auto incrementing with every revision of the document that is saved", "readOnly": true }, "createdAt": { "type": "string", "description": "The date and time that this object was created", "readOnly": true, "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedAt": { "type": "string", "description": "The date and time that this object was last changed", "readOnly": true, "format": "date-time" }, "updatedBy": { "$ref": "#/components/schemas/User" }, "publishedAt": { "type": "string", "nullable": true, "description": "The date and time that this object was published", "readOnly": true, "format": "date-time" }, "dataAttributes": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/DocumentDataAttribute" } }, "archivedAt": { "type": "string", "nullable": true, "description": "The date and time that this object was archived", "readOnly": true, "format": "date-time" }, "deletedAt": { "type": "string", "nullable": true, "description": "The date and time that this object was deleted", "readOnly": true, "format": "date-time" } } }