roboto.domain.comments.record

Module Contents

CommentEntityType

class roboto.domain.comments.record.CommentEntityType#

Bases: roboto.compat.StrEnum

Enumeration of Roboto platform entities that support comments.

This enum defines the types of resources in the Roboto platform that can have comments attached to them. Each value corresponds to a specific domain entity type.

Attributes

CommentEntityType.Action

Action = 'action' #

Actions that can be executed on the platform.

CommentEntityType.Collection

Collection = 'collection' #

Collections of related datasets or resources.

CommentEntityType.Dataset

Dataset = 'dataset' #

Datasets containing uploaded data files.

CommentEntityType.File

File = 'file' #

Individual files within datasets.

CommentEntityType.Invocation

Invocation = 'invocation' #

Executions of actions with specific inputs.

CommentEntityType.Trigger

Trigger = 'trigger' #

Automated triggers for action execution.

CommentRecord

class roboto.domain.comments.record.CommentRecord(/, **data)#

Bases: pydantic.BaseModel

A wire-transmissible representation of a comment.

This model represents the complete data structure of a comment as stored and transmitted by the Roboto platform API. It includes all metadata about the comment including creation/modification timestamps, user mentions, and the associated entity information.

Parameters

data Any

Attributes

CommentRecord.comment_id

comment_id str #

Unique identifier for this comment.

CommentRecord.comment_text

comment_text str #

The text content of the comment, may include @mention syntax.

CommentRecord.created

created datetime.datetime #

Timestamp when the comment was created.

Stored as datetime.datetime in Python but serialized as ISO 8601 string in UTC when transmitted over the API.

CommentRecord.created_by

created_by str #

User ID of the comment author.

CommentRecord.entity_id

entity_id str #

Unique identifier of the entity this comment is attached to.

CommentRecord.entity_type

entity_type CommentEntityType #

Type of entity this comment is attached to.

CommentRecord.mentions

mentions list[str] = None #

List of user IDs mentioned in this comment using @mention syntax.

CommentRecord.modified

modified datetime.datetime #

Timestamp when the comment was last modified.

Stored as datetime.datetime in Python but serialized as ISO 8601 string in UTC when transmitted over the API.

CommentRecord.modified_by

modified_by str #

User ID of the user who last modified this comment.

CommentRecord.org_id

org_id str #

Organization ID that owns this comment (partition key).