Documentation Index
Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
Use this file to discover all available pages before exploring further.
Services
RPC methods exposed by this API.
| Method | Request | Response | Description |
|---|
| CreateComment | CreateCommentRequest | CreateCommentResponse | Creates a comment on a resource. |
| ListComments | ListCommentsRequest | ListCommentsResponse | Retrieves comments using an optional filter. Commonly used to bulk-fetch comments for a set of resource IDs of a given entity type. |
| UpdateComment | UpdateCommentRequest | UpdateCommentResponse | Updates the body of an existing comment. |
| DeleteComment | DeleteCommentRequest | DeleteCommentResponse | Deletes a comment. |
Messages
Data models used across requests/responses.
A single comment attached to a resource.
| Field | Type | Label | Description |
|---|
| comment_id | string | | |
| resource_id | string | | The ID of the resource the comment is attached to (e.g. a canvas_cell_execution_id). |
| entity_type | CommentEntityType | | The kind of resource resource_id refers to. |
| created_date | google.protobuf.Timestamp | | |
| modified_date | google.protobuf.Timestamp | | |
| created_by_user_id | string | | |
| created_by_user_name | string | | |
| body | CommentBodyElement | repeated | The rich-text body of the comment. |
CommentBodyElement
A single element of a comment body. Either plain text or a user mention.
| Field | Type | Label | Description |
|---|
| type | CommentBodyElementType | | |
| text | string | | Only set when type is TEXT. |
| user_mention | CommentUserMention | | Only set when type is USER_MENTION. |
| Field | Type | Label | Description |
|---|
| user_id | string | | |
| user_email | string | | |
CommentService_CreateComment.
| Field | Type | Label | Description |
|---|
| resource_id | string | | The ID of the resource to attach the comment to. |
| entity_type | CommentEntityType | | The kind of resource resource_id refers to. |
| body | CommentBodyElement | repeated | The rich-text body of the new comment. |
CommentService_CreateComment.
| Field | Type | Label | Description |
|---|
| comment | Comment | | |
CommentService_DeleteComment.
| Field | Type | Label | Description |
|---|
| comment_id | string | | |
CommentService_DeleteComment.
This message has no fields.
The request for a call to CommentService_ListComments. Commonly invoked
with a CEL filter of the form
entity_type == "CANVAS_CELL_EXECUTION" && resource_id in ["<uuid>", ...]
to bulk-fetch comments for a set of resources.
| Field | Type | Label | Description |
|---|
| page_size | uint32 | | The maximum number of comments to return. Defaults to 50, max 1000. |
| page_token | string | | A page token, received from a previous ListComments call. |
| filter | string | | A Common Expression Language (CEL) filter string. Available fields to filter by are comment_id, resource_id, entity_type, created_by_user_id, created_date, and modified_date. |
| order_by | string | | How to order the retrieved comments. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are created_date and modified_date. Defaults to created_date ascending (oldest-first). |
CommentService_ListComments.
| Field | Type | Label | Description |
|---|
| comments | Comment | repeated | |
| next_page_token | string | | |
CommentService_UpdateComment.
| Field | Type | Label | Description |
|---|
| comment | Comment | | |
| update_mask | string | | Comma-separated list of fields to update. Only body is supported. |
CommentService_UpdateComment.
| Field | Type | Label | Description |
|---|
| comment | Comment | | |
Enums
Allowed constant values used in message fields.
CommentBodyElementType
| Name | Number | Description |
|---|
| COMMENT_BODY_ELEMENT_TYPE_UNSPECIFIED | 0 | |
| COMMENT_BODY_ELEMENT_TYPE_TEXT | 1 | |
| COMMENT_BODY_ELEMENT_TYPE_USER_MENTION | 2 | |
| Name | Number | Description |
|---|
| COMMENT_ENTITY_TYPE_UNSPECIFIED | 0 | |
| COMMENT_ENTITY_TYPE_CANVAS_CELL_EXECUTION | 1 | |
