# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure MicrosoftScanningClient Scan Result API
  version: 1.0.0
extends: openapi/microsoft-azure-scan-result-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: 3
- target: $.paths['/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Run a data source scan
      effect: write
      questions:
      - How do I trigger a Purview scan on a data source?
      - Can I choose a full or incremental scan level when running a scan?
      instructions:
      - text: Run scan {scanName} on data source {dataSourceName} as run {runId}.
        slots:
          scanName: path.scanName
          dataSourceName: path.dataSourceName
          runId: path.runId
      - text: Run scan {scanName} on {dataSourceName} with scan level {scanLevel} as run {runId}.
        slots:
          scanName: path.scanName
          dataSourceName: path.dataSourceName
          scanLevel: query.scanLevel
          runId: path.runId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}/:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running scan
      effect: destructive
      questions:
      - How do I stop a scan that's currently running?
      - Can I cancel one specific scan run?
      instructions:
      - text: Cancel run {runId} of scan {scanName} on {dataSourceName}.
        slots:
          runId: path.runId
          scanName: path.scanName
          dataSourceName: path.dataSourceName
      - text: Stop scan run {runId} for data source {dataSourceName}, scan {scanName}.
        slots:
          runId: path.runId
          dataSourceName: path.dataSourceName
          scanName: path.scanName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/datasources/{dataSourceName}/scans/{scanName}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a scan's run history
      effect: read
      questions:
      - When did my scan last run and did it succeed?
      - Where can I see past runs of a particular scan?
      instructions:
      - text: List the run history of scan {scanName} on {dataSourceName}.
        slots:
          scanName: path.scanName
          dataSourceName: path.dataSourceName
      - text: Show previous runs for scan {scanName} of data source {dataSourceName}.
        slots:
          scanName: path.scanName
          dataSourceName: path.dataSourceName
      method: generated
      generated: '2026-10-01'