Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Scanning Scan Result API

4 actions 4 updates phrasing extends openapi/microsoft-purview-scan-result-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Microsoft Purview's API. It is a proposal applied on top of the contract, not a document Microsoft Purview publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}'].put

$.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}/:cancel'].post

$.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/runs'].get

OpenAPI Overlay

# 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 Scan Result API
  version: 1.0.0
extends: openapi/microsoft-purview-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['/scan/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Run a scan on a data source
      effect: write
      questions:
      - How do I start a scan of a data source right now?
      - Can I choose a full or incremental scan level?
      instructions:
      - text: Run scan {scan} on data source {source} as run {run}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
          run: path.runId
      - text: Start run {run} of scan {scan} on {source} at level {level}.
        slots:
          run: path.runId
          scan: path.scanName
          source: path.dataSourceName
          level: query.scanLevel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/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 is taking too long?
      - Can I cancel one scan run while it is in progress?
      instructions:
      - text: Cancel run {run} of scan {scan} on data source {source}.
        slots:
          run: path.runId
          scan: path.scanName
          source: path.dataSourceName
      - text: Stop scan run {run} for {scan} on {source}.
        slots:
          run: path.runId
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a scan's run history
      effect: read
      questions:
      - When did a scan last run and did it succeed?
      - Where can I see past runs of a scan?
      instructions:
      - text: List the run history of scan {scan} on data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Show past runs for {scan} on {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'