# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness STO Data Frontend API
  version: 1.0.0
extends: openapi/harness-sto-data-frontend-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: 6
- target: $.paths['/sto/api/v2/sto-data-frontend/all-issues/filters'].post
  update:
    x-apievangelist-phrasing:
      intent: Get available issue filter values for scan targets
      effect: read
      questions:
      - Which severities, scanners and issue types can I filter on for a set of scan targets?
      - What filter options are available for security issues from one target's baseline?
      instructions:
      - text: Get the distinct filter values for issues from target variants {targetVariants}.
        slots:
          targetVariants: requestBody.targetVariants
      - text: List the severities and scanners available to filter issues in project {project}.
        slots:
          project: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/sto-data-frontend/all-issues/issues'].post
  update:
    x-apievangelist-phrasing:
      intent: List security issues for scan targets
      effect: read
      questions:
      - What security vulnerabilities were found for my scanned targets?
      - Can I list only critical issues from one scanner across targets?
      instructions:
      - text: List security issues for target variants {targetVariants}.
        slots:
          targetVariants: requestBody.targetVariants
      - text: Show issues with severity {severityCodes} from scan tools {scanTools}.
        slots:
          severityCodes: requestBody.severityCodes
          scanTools: requestBody.scanTools
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/sto-data-frontend/artifact-scan-summary'].post
  update:
    x-apievangelist-phrasing:
      intent: Count active security issues per scanner
      effect: read
      questions:
      - How many active security issues did each scanner find for my pipeline executions' artifacts?
      - Can I break down artifact vulnerability counts by scanner?
      instructions:
      - text: Break down active issue counts by scanner for artifacts {artifactFingerprints}.
        slots:
          artifactFingerprints: requestBody.artifactFingerprints
      - text: Show per-scanner security issue counts for target variants {targetVariants}.
        slots:
          targetVariants: requestBody.targetVariants
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/sto-data-frontend/artifact-summary'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize active security issues for artifacts
      effect: read
      questions:
      - What's the overall count of active security issues across the artifacts from my pipeline runs?
      - Can I get totals of open vulnerabilities for a set of artifact fingerprints?
      instructions:
      - text: Summarize the total active security issues for artifacts {artifactFingerprints}.
        slots:
          artifactFingerprints: requestBody.artifactFingerprints
      - text: Give artifact-level issue totals in project {project}.
        slots:
          project: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/sto-data-frontend/execution-summary/{executionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize security issues for one pipeline execution
      effect: read
      questions:
      - How many active security issues did a single pipeline execution produce?
      - Did a specific pipeline run introduce new vulnerabilities?
      instructions:
      - text: Show security issue counts for pipeline execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Summarize vulnerabilities found in execution {executionId} of project {project}.
        slots:
          executionId: path.executionId
          project: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sto/api/v2/sto-data-frontend/issue-counts'].post
  update:
    x-apievangelist-phrasing:
      intent: Count security issues across pipeline executions
      effect: read
      questions:
      - How many active security issues exist across several pipeline executions' targets?
      - Can I get issue counts per target variant without fetching the issues themselves?
      instructions:
      - text: Count active issues for target variants {targetVariants}.
        slots:
          targetVariants: requestBody.targetVariants
      - text: Give issue counts by target variant for org {org} project {project}.
        slots:
          org: query.orgId
          project: query.projectId
      method: generated
      generated: '2026-09-26'