# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Remediation Agent API
  version: 1.0.0
extends: openapi/harness-remediation-agent-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/remediation/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether AI remediation is on for a project
      effect: read
      questions:
      - Is AI remediation enabled for my infrastructure-as-code project?
      - Which remediation pipeline is attached to a project right now?
      instructions:
      - text: Check the AI remediation setting for project {project} in org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Show the remediation config of {org}/{project}.
        slots:
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/remediation/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn on AI remediation for a project
      effect: write
      questions:
      - How do I enable AI remediation for every workspace in a project?
      - Can I attach or swap the pipeline used for remediation when enabling it?
      instructions:
      - text: Enable AI remediation for project {project} in org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Turn on remediation in {org}/{project} using pipeline {pipeline}.
        slots:
          org: path.org
          project: path.project
          pipeline: requestBody.pipeline_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iacm/api/orgs/{org}/projects/{project}/remediation/config'].delete
  update:
    x-apievangelist-phrasing:
      intent: Turn off AI remediation for a project
      effect: destructive
      questions:
      - How do I stop AI remediation from running on a project's workspaces?
      - Can project-level remediation be switched off without touching workspaces?
      instructions:
      - text: Disable AI remediation for project {project} in org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Switch off project remediation in {org}/{project}.
        slots:
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/remediation-agent/diff-occurrences'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare a validation scan against the original
      effect: read
      questions:
      - Did the remediation agent's validation run actually remove the vulnerabilities from the original scan?
      - Can I diff a validation execution against an original scan for true positives only?
      instructions:
      - text: Diff occurrences of scan {scan} against validation execution {validation}.
        slots:
          scan: query.scanId
          validation: query.validationExecutionId
      - text: Compare scan {scan} with validation run {validation} excluding unreachable findings set to {unreachable}.
        slots:
          scan: query.scanId
          validation: query.validationExecutionId
          unreachable: query.excludeUnreachable
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sto/api/v2/remediation-agent/occurrences-in-scope'].get
  update:
    x-apievangelist-phrasing:
      intent: List occurrences in scope for remediation
      effect: read
      questions:
      - Which issue occurrences in a scan will the remediation agent try to fix?
      - Can I limit the remediation scope to true-positive triage verdicts?
      instructions:
      - text: List remediation-scope occurrences for scan {scan}.
        slots:
          scan: query.scanId
      - text: Show in-scope occurrences for scan {scan} on target {target} with issue type {type}.
        slots:
          scan: query.scanId
          target: query.targetId
          type: query.issueTypes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sto/api/v2/remediation-agent/results/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a remediation agent run's results
      effect: write
      questions:
      - How are per-occurrence results from a remediation agent run recorded?
      - Can I store pull request details alongside remediation results for a scan?
      instructions:
      - text: Save remediation results for original scan {scan}.
        slots:
          scan: requestBody.originalScanId
      - text: Persist remediation run for scan {scan} with pull request metadata {pr}.
        slots:
          scan: requestBody.originalScanId
          pr: requestBody.pullRequestMetadata
      method: generated
      generated: '2026-10-01'