# 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 Results API
  version: 1.0.0
extends: openapi/harness-complianceresults-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: 5
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-results/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List supply chain compliance results
      effect: read
      questions:
      - Which supply chain compliance checks failed in a project?
      - Can I filter compliance results by standard, severity or scan type?
      instructions:
      - text: List compliance results for project {project} in org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Show {severity} compliance results with status {status} in {org}/{project}.
        slots:
          severity: requestBody.severity
          status: requestBody.status
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-results/compliances'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarise compliance results per check
      effect: read
      questions:
      - How many artifacts pass or fail each compliance check?
      - Can I group compliance results by check within a time range?
      instructions:
      - text: Group compliance results by check for {org}/{project}.
        slots:
          org: path.org
          project: path.project
      - text: Summarise per-check compliance in {org}/{project} from {start} to {end}.
        slots:
          org: path.org
          project: path.project
          start: query.start_time
          end: query.end_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-results/compliances/{compliance}/artifacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List artifacts evaluated by one compliance check
      effect: read
      questions:
      - Which artifacts were evaluated against a particular compliance check?
      - For one compliance rule, can I see every affected artifact?
      instructions:
      - text: List artifacts evaluated by compliance check {compliance} in {org}/{project}.
        slots:
          compliance: path.compliance
          org: path.org
          project: path.project
      - text: Search artifacts under check {compliance} in {org}/{project} for {term}.
        slots:
          compliance: path.compliance
          org: path.org
          project: path.project
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-results'].post
  update:
    x-apievangelist-phrasing:
      intent: Save compliance scan results
      effect: write
      questions:
      - How do I record compliance results from a repository scan in a pipeline?
      - Can I attach compliance results to a specific pipeline execution?
      instructions:
      - text: 'Save these compliance results for repo {repo} in {org}/{project}: {results}.'
        slots:
          repo: requestBody.repo_url
          org: path.org
          project: path.project
          results: requestBody.results
      - text: Record compliance results {results} from execution {execution} in {org}/{project}.
        slots:
          results: requestBody.results
          execution: requestBody.pipeline_execution_identifier
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/artifact/{artifact}/compliance-results/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List compliance results for an artifact
      effect: read
      questions:
      - Is a specific artifact compliant, and which checks did it fail?
      - Can I filter one artifact's compliance results by standard?
      instructions:
      - text: Show compliance results for artifact {artifact} in {org}/{project}.
        slots:
          artifact: path.artifact
          org: path.org
          project: path.project
      - text: List failed checks for artifact {artifact} in {org}/{project} with status {status}.
        slots:
          artifact: path.artifact
          org: path.org
          project: path.project
          status: requestBody.status
      method: generated
      generated: '2026-09-26'