# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Soda Cloud API v4 Scans API
  version: 1.0.0
extends: openapi/soda-data-scans-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: 3
- target: $.paths['/api/v1/scans/{scanId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scan status
      effect: read
      questions:
      - Is my data quality scan still running or has it finished?
      - What state is a scan in after I triggered it?
      instructions:
      - text: Check the status of scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Poll scan {scanId} until it completes.
        slots:
          scanId: path.scanId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/scans/{scanId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scan
      effect: destructive
      questions:
      - Can I cancel a scan that is pending or already submitted?
      - How do I stop a running scan?
      instructions:
      - text: Cancel scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Stop scan {scanId} before it runs.
        slots:
          scanId: path.scanId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/scans/{scanId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get scan logs
      effect: read
      questions:
      - Where can I read the logs of a finished scan to debug a failure?
      - What went wrong during a scan's execution?
      instructions:
      - text: Show the logs of scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Get page {page} of log lines for scan {scanId}.
        slots:
          page: query.page
          scanId: path.scanId
      method: generated
      generated: '2026-09-26'