Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Metadata Policies Metadata Policy API

4 actions 4 updates phrasing extends openapi/microsoft-purview-metadata-policy-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 4

$.info

$.paths['/metadataPolicies/{policyId}'].get

$.paths['/metadataPolicies/{policyId}'].put

$.paths['/metadataPolicies'].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 Metadata Policies Metadata Policy API
  version: 1.0.0
extends: openapi/microsoft-purview-metadata-policy-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: 3
- target: $.paths['/metadataPolicies/{policyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a metadata policy
      effect: read
      questions:
      - Who has which role on a collection according to its metadata policy?
      - Can I read one metadata policy by its ID?
      instructions:
      - text: Show me metadata policy {policy}.
        slots:
          policy: path.policyId
      - text: Get the role assignments in policy {policy}.
        slots:
          policy: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/metadataPolicies/{policyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a metadata policy
      effect: write
      questions:
      - How do I change role assignments in a collection's metadata policy?
      - Can I replace the properties of a metadata policy?
      instructions:
      - text: Update metadata policy {policy} with properties {props}.
        slots:
          policy: path.policyId
          props: requestBody.properties
      - text: Replace policy {policy} at version {version}.
        slots:
          policy: path.policyId
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/metadataPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List metadata policies
      effect: read
      questions:
      - What metadata policies govern access across our Purview collections?
      - Can I get the metadata policy for just one collection?
      instructions:
      - text: List all metadata policies.
      - text: Get the metadata policy for collection {collection}.
        slots:
          collection: query.collectionName
      method: generated
      generated: '2026-10-01'