Microsoft Purview · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/microsoft-purview-data-quality-scores-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/scores'].get
$.paths['/dataquality/scores/{scoreId}'].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 Data Quality Data Quality Scores API
  version: 1.0.0
extends: openapi/microsoft-purview-data-quality-scores-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/scores'].get
  update:
    x-apievangelist-phrasing:
      intent: List data quality scores
      effect: read
      questions:
      - What are the data quality scores across our data assets?
      - Can I see quality scores for just one asset?
      instructions:
      - text: List data quality scores for asset {asset}.
        slots:
          asset: query.assetId
      - text: Show all data quality scores, {size} per page.
        slots:
          size: query.maxpagesize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dataquality/scores/{scoreId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single data quality score
      effect: read
      questions:
      - Where can I look up the details of one data quality score record?
      - What does a specific quality score entry contain?
      instructions:
      - text: Get data quality score {score}.
        slots:
          score: path.scoreId
      - text: Show the details of score record {score}.
        slots:
          score: path.scoreId
      method: generated
      generated: '2026-10-01'