# 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 API
  version: 1.0.0
extends: openapi/microsoft-azure-scan-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['/datasources/{dataSourceName}/scans/{scanName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan on a data source
      effect: read
      questions:
      - How do I see the configuration of one scan on a Purview data source?
      - What kind of scan is set up for a given data source?
      instructions:
      - text: Show scan {scanName} on data source {dataSourceName}.
        slots:
          scanName: path.scanName
          dataSourceName: path.dataSourceName
      - text: Get the settings of scan {scanName} for source {dataSourceName}.
        slots:
          scanName: path.scanName
          dataSourceName: path.dataSourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/datasources/{dataSourceName}/scans/{scanName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a scan on a data source
      effect: write
      questions:
      - How do I set up a new scan on a registered data source?
      - Which scan kind do I have to pick when creating a scan?
      instructions:
      - text: Create scan {scanName} of kind {kind} on data source {dataSourceName}.
        slots:
          scanName: path.scanName
          kind: requestBody.kind
          dataSourceName: path.dataSourceName
      - text: Set up a new scan {scanName} for source {dataSourceName}.
        slots:
          scanName: path.scanName
          dataSourceName: path.dataSourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/datasources/{dataSourceName}/scans/{scanName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan from a data source
      effect: destructive
      questions:
      - How do I remove a scan associated with a data source?
      - Can I delete a scan without unregistering the data source?
      instructions:
      - text: Delete scan {scanName} from data source {dataSourceName}.
        slots:
          scanName: path.scanName
          dataSourceName: path.dataSourceName
      - text: Remove the {scanName} scan on source {dataSourceName}.
        slots:
          scanName: path.scanName
          dataSourceName: path.dataSourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/datasources/{dataSourceName}/scans'].get
  update:
    x-apievangelist-phrasing:
      intent: List scans on a data source
      effect: read
      questions:
      - Which scans are configured on my data source?
      - Can I list every scan defined for one registered source?
      instructions:
      - text: List all scans on data source {dataSourceName}.
        slots:
          dataSourceName: path.dataSourceName
      - text: Show the scans configured for source {dataSourceName}.
        slots:
          dataSourceName: path.dataSourceName
      method: generated
      generated: '2026-09-26'