Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Executions API

11 actions 11 updates phrasing extends openapi/harness-executions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/iacm/api/orgs/{org}/projects/{project}/executions'].get
$.paths['/iacm/api/orgs/{org}/projects/{project}/executions'].post
$.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/{pipeline_stage_id}'].get
$.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/{pipeline_stage_id}/audit-event'].post
$.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes'].get
$.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes-all-stages'].get
$.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes-all-stages-by-modules'].get
$.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/dependency-graph'].get
$.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/resource-changes'].get
$.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/resource-changes-all-stages'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Executions API
  version: 1.0.0
extends: openapi/harness-executions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List infrastructure executions in a project
      effect: read
      questions:
      - Which IaCM executions ran in a project for a given workspace?
      - Can I filter infrastructure executions by status and time window?
      instructions:
      - text: List executions in org {org} project {project}.
        slots:
          org: path.org
          project: path.project
      - text: List executions for workspace {workspace} in project {project} with status {status}.
        slots:
          workspace: query.workspace
          project: path.project
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/executions'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a new infrastructure execution
      effect: write
      questions:
      - How do I register an execution for a workspace from a pipeline stage?
      - What identifiers are needed to create an IaCM execution?
      instructions:
      - text: Create an execution for workspace {workspace} from pipeline {pipeline} run {pipeline_execution_id} stage {pipeline_stage_id} in org {org} project {project}.
        slots:
          workspace: requestBody.workspace
          pipeline: requestBody.pipeline
          pipeline_execution_id: requestBody.pipeline_execution_id
          pipeline_stage_id: requestBody.pipeline_stage_id
          org: path.org
          project: path.project
      - text: Log pipeline run {pipeline_execution_id} stage {pipeline_stage_id} as an execution of workspace {workspace} for pipeline {pipeline}.
        slots:
          pipeline_execution_id: requestBody.pipeline_execution_id
          pipeline_stage_id: requestBody.pipeline_stage_id
          workspace: requestBody.workspace
          pipeline: requestBody.pipeline
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/{pipeline_stage_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show one infrastructure execution
      effect: read
      questions:
      - What happened in a specific pipeline stage's infrastructure execution?
      - How can I view a single execution by run ID and stage?
      instructions:
      - text: Show the execution for run {pipeline_execution_id} stage {pipeline_stage_id} in org {org} project {project}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          pipeline_stage_id: path.pipeline_stage_id
          org: path.org
          project: path.project
      - text: Get execution {pipeline_execution_id} stage {pipeline_stage_id}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          pipeline_stage_id: path.pipeline_stage_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/{pipeline_stage_id}/audit-event'].post
  update:
    x-apievangelist-phrasing:
      intent: Add audit data to an execution
      effect: write
      questions:
      - Can I attach audit information to an existing infrastructure execution?
      - How do I record an audit event against a pipeline stage execution?
      instructions:
      - text: Add audit data {audit} to execution {pipeline_execution_id} stage {pipeline_stage_id} in org {org} project {project}.
        slots:
          audit: requestBody.audit
          pipeline_execution_id: path.pipeline_execution_id
          pipeline_stage_id: path.pipeline_stage_id
          org: path.org
          project: path.project
      - text: Record an audit event on run {pipeline_execution_id} stage {pipeline_stage_id}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          pipeline_stage_id: path.pipeline_stage_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes'].get
  update:
    x-apievangelist-phrasing:
      intent: List cost changes for an execution stage
      effect: read
      questions:
      - How much will this Terraform plan change my infrastructure cost?
      - Can I see the cost difference between the latest plan and applied state for one stage?
      instructions:
      - text: List cost changes for execution {pipeline_execution_id} in org {org} project {project}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          org: path.org
          project: path.project
      - text: Show cost changes for execution {pipeline_execution_id} stage {pipeline_stage_id}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          pipeline_stage_id: query.pipeline_stage_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes-all-stages'].get
  update:
    x-apievangelist-phrasing:
      intent: List cost changes across all stages
      effect: read
      questions:
      - What's the total cost impact across every stage of a pipeline run?
      - Can I get cost changes for all stages of an execution at once?
      instructions:
      - text: List cost changes for all stages of execution {pipeline_execution_id} in org {org} project {project}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          org: path.org
          project: path.project
      - text: Summarize every stage's cost change for run {pipeline_execution_id}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/cost-changes-all-stages-by-modules'].get
  update:
    x-apievangelist-phrasing:
      intent: List cost changes per module across stages
      effect: read
      questions:
      - Which module is driving the cost increase in my execution?
      - Can I break down execution cost changes by module stack path?
      instructions:
      - text: Break down cost changes by module for execution {pipeline_execution_id} in org {org} project {project}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          org: path.org
          project: path.project
      - text: Show module cost changes for run {pipeline_execution_id} at stack path {stack_path}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          stack_path: query.stack_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/dependency-graph'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an execution's dependency graph
      effect: read
      questions:
      - How are the modules in my infrastructure execution dependent on each other?
      - Can I view the Terragrunt dependency graph for a specific path?
      instructions:
      - text: Get the dependency graph for execution {pipeline_execution_id} in org {org} project {project}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          org: path.org
          project: path.project
      - text: Show the dependency graph of run {pipeline_execution_id} for Terragrunt path {path_id}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          path_id: query.path_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/resource-changes'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource changes for an execution stage
      effect: read
      questions:
      - Which resources will be created, changed or destroyed by this plan?
      - Can I list resource changes without the state values included?
      instructions:
      - text: List resource changes for execution {pipeline_execution_id} in org {org} project {project}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          org: path.org
          project: path.project
      - text: Show resource changes for run {pipeline_execution_id} stage {pipeline_stage_id}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          pipeline_stage_id: query.pipeline_stage_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/executions/{pipeline_execution_id}/resource-changes-all-stages'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource changes across all stages
      effect: read
      questions:
      - What resources change across every stage of a pipeline run?
      - Can I get all stages' resource changes in one response?
      instructions:
      - text: List resource changes for all stages of execution {pipeline_execution_id} in org {org} project {project}.
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          org: path.org
          project: path.project
      - text: 'Show every stage''s resource changes for run {pipeline_execution_id}, excluding state: {exclude_state}.'
        slots:
          pipeline_execution_id: path.pipeline_execution_id
          exclude_state: query.exclude_state
      method: generated
      generated: '2026-09-26'