# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Purview Scanning Triggers API
  version: 1.0.0
extends: openapi/microsoft-purview-triggers-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: 5
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan's schedule trigger
      effect: read
      questions:
      - When is a scan scheduled to run?
      - Can I see the recurrence trigger for a scan?
      instructions:
      - text: Show the trigger for scan {scan} on data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Get the schedule of {scan} on {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Schedule a scan with a trigger
      effect: write
      questions:
      - How do I schedule a scan to run on a recurrence?
      - Can I replace the existing schedule on a scan?
      instructions:
      - text: Create a trigger for scan {scan} on {source} with properties {props}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
          props: requestBody.properties
      - text: Replace the scan schedule for {scan} on data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan's schedule trigger
      effect: destructive
      questions:
      - Can I remove the recurring schedule from a scan?
      - What is the way to delete a scan trigger?
      instructions:
      - text: Delete the trigger on scan {scan} for data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Remove the schedule from {scan} on {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default/:enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a scan schedule
      effect: write
      questions:
      - How do I turn a paused scan schedule back on?
      - Can I resume scheduled scanning for a scan?
      instructions:
      - text: Enable the trigger for scan {scan} on data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Resume scheduled runs of {scan} on {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/triggers/default/:disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a scan schedule
      effect: write
      questions:
      - How do I pause scheduled scanning without deleting the schedule?
      - Can I temporarily stop a scan from running on its recurrence?
      instructions:
      - text: Disable the trigger for scan {scan} on data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Pause scheduled runs of {scan} on {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'