# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Compliance Stats API
  version: 1.0.0
extends: openapi/harness-compliancestats-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: 4
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-stats/evaluation-breakdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize compliance results by severity
      effect: read
      questions:
      - How many compliance findings do we have at each severity level?
      - Can I scope the compliance overview to certain standards and a date range?
      instructions:
      - text: Show the compliance results overview by severity for org {org} project {project}.
        slots:
          org: path.org
          project: path.project
      - text: Break down compliance results by severity for standards {standards} since {start_time}.
        slots:
          standards: requestBody.standards
          start_time: query.start_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-stats/checks'].post
  update:
    x-apievangelist-phrasing:
      intent: Get compliance stats per check
      effect: read
      questions:
      - Which individual compliance checks fail most often?
      - Can I page and sort compliance results check by check?
      instructions:
      - text: List compliance result stats per check for org {org} project {project}.
        slots:
          org: path.org
          project: path.project
      - text: Show per-check compliance results with status {status} sorted by {sort}.
        slots:
          status: requestBody.status
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-stats/evaluation-breakdown/artifacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Break down compliance results by artifact
      effect: read
      questions:
      - Which artifact types account for our compliance evaluations?
      - How do compliance results split across artifacts for a given scan type?
      instructions:
      - text: Break down compliance evaluations by artifact type for org {org} project {project}.
        slots:
          org: path.org
          project: path.project
      - text: Show the artifact breakdown of compliance results for scan types {scan_types}.
        slots:
          scan_types: requestBody.scan_types
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-stats/evaluation-trend'].post
  update:
    x-apievangelist-phrasing:
      intent: Show compliance evaluation trends over time
      effect: read
      questions:
      - Is our compliance posture improving over the last few weeks?
      - Can I set the aggregation window for the compliance trend line?
      instructions:
      - text: Show compliance evaluation trends for org {org} project {project}.
        slots:
          org: path.org
          project: path.project
      - text: Plot compliance evaluations from {start_time} to {end_time} in windows of {aggregation_period} ms.
        slots:
          start_time: query.start_time
          end_time: query.end_time
          aggregation_period: query.aggregation_period
      method: generated
      generated: '2026-09-26'