Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Scanning Data Sources API

5 actions 5 updates phrasing extends openapi/microsoft-purview-data-sources-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}'].get
$.paths['/scan/datasources/{dataSourceName}'].put
$.paths['/scan/datasources/{dataSourceName}'].delete
$.paths['/scan/datasources'].get

OpenAPI Overlay

Raw ↑ 
# 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 Data Sources API
  version: 1.0.0
extends: openapi/microsoft-purview-data-sources-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}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registered data source
      effect: read
      questions:
      - How is a specific data source registered in Purview?
      - Can I see the kind and properties of one data source by name?
      instructions:
      - text: Show me data source {source}.
        slots:
          source: path.dataSourceName
      - text: Get the registration details of data source {source}.
        slots:
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Register or replace a data source
      effect: write
      questions:
      - How do I register a new data source for Purview to scan?
      - Can I overwrite the registration of an existing data source?
      instructions:
      - text: Register data source {source} of kind {kind}.
        slots:
          source: path.dataSourceName
          kind: requestBody.kind
      - text: Replace the registration of data source {source} with properties {props}.
        slots:
          source: path.dataSourceName
          props: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources/{dataSourceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unregister a data source
      effect: destructive
      questions:
      - Can I remove a data source registration from Purview?
      - What is the way to stop tracking a data source entirely?
      instructions:
      - text: Delete data source {source}.
        slots:
          source: path.dataSourceName
      - text: Unregister the {source} data source.
        slots:
          source: path.dataSourceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/scan/datasources'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered data sources
      effect: read
      questions:
      - Which data sources are registered in our Purview data map?
      - What sources has Purview been set up to scan?
      instructions:
      - text: List all registered data sources.
      - text: List data sources using API version {version}.
        slots:
          version: query.api-version
      method: generated
      generated: '2026-10-01'