Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Scanning Scans API

5 actions 5 updates phrasing extends openapi/microsoft-purview-scans-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 5

$.info

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

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

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

$.paths['/scan/datasources/{dataSourceName}/scans'].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 Scans API
  version: 1.0.0
extends: openapi/microsoft-purview-scans-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: 4
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan definition
      effect: read
      questions:
      - How is a particular scan of a data source configured?
      - Which rule set does one scan use?
      instructions:
      - text: Show me scan {scan} on data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Get the configuration of scan {scan} for {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a scan
      effect: write
      questions:
      - How do I set up a new scan for a registered data source?
      - Can I overwrite an existing scan's settings?
      instructions:
      - text: Create scan {scan} of kind {kind} on data source {source}.
        slots:
          scan: path.scanName
          kind: requestBody.kind
          source: path.dataSourceName
      - text: Replace scan {scan} on {source} with properties {props}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
          props: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans/{scanName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan
      effect: destructive
      questions:
      - Can I delete a scan from a data source?
      - What is the way to remove a scan definition?
      instructions:
      - text: Delete scan {scan} from data source {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      - text: Remove the {scan} scan on {source}.
        slots:
          scan: path.scanName
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}/scans'].get
  update:
    x-apievangelist-phrasing:
      intent: List scans on a data source
      effect: read
      questions:
      - What scans are configured for a given data source?
      - Which scans exist under one registered source?
      instructions:
      - text: List the scans on data source {source}.
        slots:
          source: path.dataSourceName
      - text: Show every scan defined for {source}.
        slots:
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'