Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Data Quality Data Profiling API

3 actions 3 updates phrasing extends openapi/microsoft-purview-data-profiling-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 3

$.info
$.paths['/dataquality/profiling/{assetId}'].get
$.paths['/dataquality/profiling/{assetId}'].post

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 Data Quality Data Profiling API
  version: 1.0.0
extends: openapi/microsoft-purview-data-profiling-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: 2
- target: $.paths['/dataquality/profiling/{assetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get profiling results for a data asset
      effect: read
      questions:
      - What did the last data profiling run find for an asset?
      - Where do I see column statistics from profiling a data asset?
      instructions:
      - text: Show the data profiling results for asset {asset}.
        slots:
          asset: path.assetId
      - text: Get profiling output for data asset {asset}.
        slots:
          asset: path.assetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dataquality/profiling/{assetId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start profiling a data asset
      effect: write
      questions:
      - How do I kick off data profiling on a table?
      - Can I profile only certain columns or use a sample of rows?
      instructions:
      - text: Run data profiling on asset {asset}.
        slots:
          asset: path.assetId
      - text: Profile columns {columns} of asset {asset} with a sample size of {sample}.
        slots:
          columns: requestBody.columns
          asset: path.assetId
          sample: requestBody.sampleSize
      method: generated
      generated: '2026-10-01'