Struct Document 

pub struct Document {

    pub id: Option<String>,
    pub created_at: Option<DateTime<Utc>>,
    pub updated_at: Option<DateTime<Utc>>,
    pub archived_at: Option<DateTime<Utc>>,
    pub title: Option<String>,
    pub summary: Option<String>,
    pub icon: Option<String>,
    pub color: Option<String>,
    pub creator: Option<Box<User>>,
    pub updated_by: Option<Box<User>>,
    pub project: Option<Box<Project>>,
    pub initiative: Option<Box<Initiative>>,
    pub team: Option<Box<Team>>,
    pub issue: Option<Box<Issue>>,
    pub release: Option<Box<Release>>,
    pub cycle: Option<Box<Cycle>>,
    pub slug_id: Option<String>,
    pub last_applied_template: Option<Box<Template>>,
    pub hidden_at: Option<DateTime<Utc>>,
    pub trashed: Option<bool>,
    pub sort_order: Option<f64>,
    pub comments: Option<CommentConnection>,
    pub content: Option<String>,
    pub content_state: Option<String>,
    pub document_content_id: Option<String>,
    pub url: Option<String>,
}

A rich-text document that lives within a project, initiative, team, issue, release, or cycle. Documents support collaborative editing via ProseMirror/Yjs and store their content in a separate DocumentContent entity. Each document is associated with exactly one parent entity.

Fields

id: Option<String>

The unique identifier of the entity.

created_at: Option<DateTime<Utc>>

The time at which the entity was created.

updated_at: Option<DateTime<Utc>>

The last time at which the entity was meaningfully updated. This is the same as the creation time if the entity hasn’t been updated after creation.

archived_at: Option<DateTime<Utc>>

The time at which the entity was archived. Null if the entity has not been archived.

title: Option<String>

The title of the document. An empty string indicates an untitled document.

summary: Option<String>

Internal A one-sentence AI-generated summary of the document content. Null if no summary has been generated.

icon: Option<String>

The icon of the document, either a decorative icon type or an emoji string. Null if no icon has been set.

color: Option<String>

The hex color of the document icon. Null if no custom color has been set.

creator: Option<Box<User>>

The user who created the document. Null if the creator’s account has been deleted.

updated_by: Option<Box<User>>

The user who last updated the document. Null if the user’s account has been deleted.

project: Option<Box<Project>>

The project that the document is associated with. Null if the document belongs to a different parent entity type.

initiative: Option<Box<Initiative>>

The initiative that the document is associated with. Null if the document belongs to a different parent entity type.

team: Option<Box<Team>>

Internal The team that the document is associated with. Null if the document belongs to a different parent entity type.

issue: Option<Box<Issue>>

The issue that the document is associated with. Null if the document belongs to a different parent entity type.

release: Option<Box<Release>>

Internal The release that the document is associated with. Null if the document belongs to a different parent entity type.

cycle: Option<Box<Cycle>>

Internal The cycle that the document is associated with. Null if the document belongs to a different parent entity type.

slug_id: Option<String>

The document’s unique URL slug, used to construct human-readable URLs.

last_applied_template: Option<Box<Template>>

The last template that was applied to this document. Null if no template has been applied.

hidden_at: Option<DateTime<Utc>>

The time at which the document was hidden from the default view. Null if the document has not been hidden.

trashed: Option<bool>

A flag that indicates whether the document is in the trash bin. Trashed documents are archived and can be restored.

sort_order: Option<f64>

The sort order of the document in its parent entity’s resources list. This order is shared with other resource types such as external links.

comments: Option<CommentConnection>

Comments associated with the document.

content: Option<String>

The document’s content in markdown format.

content_state: Option<String>

Internal The document’s content as a base64-encoded Yjs state update.

document_content_id: Option<String>

The ID of the document content associated with the document.

url: Option<String>

The canonical url for the document.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Document

where Document: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GraphQLFields for Document

type FullType = Document

The full generated type this implementation validates against.

fn selection() -> String

Return the GraphQL field selection string for this type.

impl Serialize for Document

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.