Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Unified Catalog OKRs API

3 actions 3 updates phrasing extends openapi/microsoft-purview-okrs-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['/okrs'].get

$.paths['/okrs'].post

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 Unified Catalog OKRs API
  version: 1.0.0
extends: openapi/microsoft-purview-okrs-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['/okrs'].get
  update:
    x-apievangelist-phrasing:
      intent: List OKRs in the unified catalog
      effect: read
      questions:
      - What objectives and key results are tracked in our unified catalog?
      - Can I page through OKRs a few at a time?
      instructions:
      - text: List all OKRs.
      - text: Show OKRs {size} per page.
        slots:
          size: query.maxpagesize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/okrs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an objective or key result
      effect: write
      questions:
      - How do I add a new objective to a business domain?
      - Can I create a key result under an existing objective?
      instructions:
      - text: Create an objective named {name} in business domain {domain}.
        slots:
          name: requestBody.name
          domain: requestBody.businessDomainId
      - text: Add key result {name} under parent OKR {parent}.
        slots:
          name: requestBody.name
          parent: requestBody.parentOkrId
      method: generated
      generated: '2026-10-01'