Skip to main content
Version: 0.6.x (Current)

Comments

A Comment is a text message attached to a Terraform run. Comments are used by team members to discuss plan results, flag issues, or record decisions during the run lifecycle.

Available Queries

QueryDescription
comments(runId: ID!, filter: CommentFilter)List all comments on a run
comment(id: ID!)Fetch a single comment by ID

Example

query RunComments($runId: ID!) {
comments(runId: $runId) {
id
body
}
}

Fields

FieldTypeDescription
idID!Comment identifier
bodyString!Comment text content
runEventIdIDAssociated run event, if any

Filter Fields

FieldComparison Type
bodyStringComparisonExp
  • Runs — The run this comment belongs to