> ## Documentation Index
> Fetch the complete documentation index at: https://www.ravion.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get resource change summary

> Get resource change summary across pipeline runs.

Returns the change summary for a specific terraform resource showing how it
changed across pipeline runs. Optionally filter by run range using
fromRunId and toRunId.



## OpenAPI

````yaml https://api.ravion.com/openapi.yaml get /terraform-resources/{address}/change-summary
openapi: 3.0.0
info:
  title: Ravion
  version: 0.0.0
servers:
  - url: https://api.ravion.com
security:
  - BearerAuth: []
tags:
  - name: Projects
  - name: Environments
  - name: Pipelines
  - name: PipelineRuns
  - name: TerraformResources
  - name: TerraformExecutionSummaries
  - name: PipelineStepExecutions
  - name: AwsCloudWatch
  - name: PipelineVersions
  - name: Organizations
  - name: Stacks
  - name: StackWorkspaces
  - name: Auth
  - name: OAuth
  - name: User
  - name: Health
  - name: Memberships
  - name: ServiceAccounts
  - name: AwsDefaultNetworks
  - name: AwsAccounts
  - name: ApiKeys
  - name: ExecutionEnvironments
  - name: ModuleDefinitions
  - name: ModuleVersions
  - name: ModuleInstances
  - name: DefaultValueDefinitions
  - name: DefaultValues
  - name: CodeSources
  - name: Github
  - name: Gitlab
  - name: Git
  - name: Values
  - name: Deployments
  - name: DeploymentResources
  - name: InfrastructureEvents
  - name: WebSocket
  - name: Describe
paths:
  /terraform-resources/{address}/change-summary:
    get:
      tags:
        - TerraformResources
      summary: Get resource change summary
      description: >-
        Get resource change summary across pipeline runs.


        Returns the change summary for a specific terraform resource showing how
        it

        changed across pipeline runs. Optionally filter by run range using

        fromRunId and toRunId.
      operationId: TerraformResourceGetResourceChangeSummary
      parameters:
        - description: Resource address to get change summary for (required)
          in: path
          name: address
          required: true
          schema:
            type: string
        - description: Pipeline ID to get changelog from (required)
          in: query
          name: pipelineId
          required: true
          schema:
            nullable: true
            type: string
        - description: Filter to runs starting from this run ID (optional)
          in: query
          name: fromRunId
          schema:
            nullable: true
            type: string
        - description: Filter to runs up to this run ID (optional)
          in: query
          name: toRunId
          schema:
            nullable: true
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    allOf:
                      - $ref: '#/components/schemas/TerraformResource.ChangeSummary'
                    nullable: true
                    type: object
                required:
                  - data
                type: object
          description: The request has succeeded.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: The request is invalid or malformed.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: You are not authenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: You do not have permission to access this resource.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: Client error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: Server error
components:
  schemas:
    TerraformResource.ChangeSummary:
      additionalProperties: false
      description: Resource change summary response showing changes across pipeline runs.
      properties:
        address:
          description: Full resource address, e.g., "module.vpc.aws_subnet.public[0]"
          type: string
        fromRun:
          allOf:
            - $ref: '#/components/schemas/TerraformResource.ChangeSummaryRun'
          description: First run in the range
        indexKey:
          description: >-
            Index key for indexed resources, e.g., "0" or "us-east-1a"
            (stringified)
          type: string
        moduleAddress:
          description: Module address, e.g., "module.vpc" or null for root module
          type: string
        pipelineId:
          description: Pipeline ID this summary belongs to
          type: string
        provider:
          description: Provider name, e.g., "registry.terraform.io/hashicorp/aws"
          type: string
        resourceName:
          description: Resource name, e.g., "public"
          type: string
        resourceType:
          description: Resource type, e.g., "aws_subnet"
          type: string
        runsInRange:
          description: Number of runs in the range
          format: int32
          type: integer
        toRun:
          allOf:
            - $ref: '#/components/schemas/TerraformResource.ChangeSummaryRun'
          description: Last run in the range
      required:
        - address
        - pipelineId
        - resourceType
        - resourceName
        - provider
        - fromRun
        - toRun
        - runsInRange
      type: object
    Errors.UserFacingErrorData:
      additionalProperties: false
      description: |-
        User-facing error presentation data.
        This is what the API returns to the frontend after formatting ErrorData
        using CEL templates from the error registry.

        Used for both:
        - Error fields on domain models (e.g., PipelineRun.error)
        - API error response bodies (HTTP 4xx/5xx responses)
      properties:
        action:
          allOf:
            - $ref: '#/components/schemas/Errors.Action'
          description: Optional action to help resolve the error
        code:
          description: Full error code, e.g., "Ravion:Pipeline:NOT_FOUND"
          type: string
        description:
          description: Additional description with more details
          type: string
        details:
          description: Structured details rendered as user-facing sections.
          items:
            $ref: '#/components/schemas/Errors.UserFacingErrorDetailSection'
          type: array
        isInternal:
          description: >-
            Indicates whether this error is internal (only set when
            ShowInternal=true).

            This allows SUPERADMINs to identify internal errors while viewing
            full details.
          type: boolean
        message:
          description: Main error message (required)
          type: string
        metadata:
          additionalProperties: {}
          description: >-
            Error params/metadata. Stripped for internal errors unless
            superadmin.
          type: object
        requestId:
          description: Request ID for correlating errors with server logs.
          type: string
      required:
        - code
        - message
      type: object
    TerraformResource.ChangeSummaryRun:
      additionalProperties: false
      description: Metadata about a run for fromRun/toRun fields.
      properties:
        changeType:
          allOf:
            - $ref: '#/components/schemas/TerraformResource.ChangeType'
          description: The type of change for this resource in this run
        description:
          description: Description of the pipeline run
          type: string
        id:
          description: Pipeline run ID
          type: string
        startedAt:
          allOf:
            - $ref: '#/components/schemas/UtcDateTime'
          description: When the pipeline run started
      required:
        - id
        - changeType
      type: object
    Errors.Action:
      additionalProperties: false
      description: Action to help user resolve the error
      properties:
        label:
          description: Button/link label text
          type: string
        url:
          description: URL to navigate to for resolution
          type: string
      required:
        - label
        - url
      type: object
    Errors.UserFacingErrorDetailSection:
      additionalProperties: false
      description: Structured user-facing error detail section.
      properties:
        items:
          description: List of detail values for this section.
          items:
            type: string
          type: array
        object:
          additionalProperties: {}
          description: Structured detail payload for object rendering.
          type: object
        render:
          description: Rendering hint for clients. Valid values are list or object.
          type: string
        title:
          description: Detail section title shown in the UI.
          type: string
      required:
        - title
        - render
      type: object
    TerraformResource.ChangeType:
      description: |-
        Enum for terraform resource change types.
        Maps to the actions array from terraform show -json output.
      enum:
        - CREATE
        - UPDATE
        - DELETE
        - REPLACE
        - IMPORT
        - READ
        - NO_OP
      type: string
    UtcDateTime:
      description: UTC RFC3339 timestamp with a required Z suffix
      format: date-time
      pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?Z$
      type: string
      x-go-type: apitypes.UTCDateTime
      x-go-type-import:
        name: apitypes
        path: ravion/api-go/pkg/apitypes
  securitySchemes:
    BearerAuth:
      scheme: Bearer
      type: http

````