Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Unified Catalog Critical Data Elements API

3 actions 3 updates phrasing extends openapi/microsoft-purview-critical-data-elements-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['/criticaldataelements'].get
$.paths['/criticaldataelements'].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 Unified Catalog Critical Data Elements API
  version: 1.0.0
extends: openapi/microsoft-purview-critical-data-elements-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['/criticaldataelements'].get
  update:
    x-apievangelist-phrasing:
      intent: List critical data elements
      effect: read
      questions:
      - Which critical data elements are tracked in our unified catalog?
      - Can I limit how many critical data elements come back per page?
      instructions:
      - text: List all critical data elements.
      - text: Show critical data elements {size} per page.
        slots:
          size: query.maxpagesize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/criticaldataelements'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a critical data element
      effect: write
      questions:
      - How do I mark a new critical data element in the unified catalog?
      - Can a critical data element belong to a business domain?
      instructions:
      - text: Create a critical data element named {name} in business domain {domain}.
        slots:
          name: requestBody.name
          domain: requestBody.businessDomainId
      - text: Define critical data element {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'