API Evangelist conversational phrasing for Microsoft Purview Unified Catalog Business Domains API

# 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 Business Domains API
  version: 1.0.0
extends: openapi/microsoft-purview-business-domains-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: 5
- target: $.paths['/businessdomains'].get
  update:
    x-apievangelist-phrasing:
      intent: List business domains in the unified catalog
      effect: read
      questions:
      - What business domains are defined in our Purview unified catalog?
      - Can I page through business domains a fixed number at a time?
      instructions:
      - text: List all business domains in the unified catalog.
      - text: Show business domains {size} per page.
        slots:
          size: query.maxpagesize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessdomains'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a business domain
      effect: write
      questions:
      - How do I set up a new business domain in the unified catalog?
      - Can a new business domain sit under a parent domain?
      instructions:
      - text: Create a business domain called {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Add business domain {name} as a child of domain {parent}.
        slots:
          name: requestBody.name
          parent: requestBody.parentDomainId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessdomains/{businessDomainId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a business domain
      effect: read
      questions:
      - Who owns and stewards a specific business domain?
      - Where can I see one business domain's status and parent?
      instructions:
      - text: Show me business domain {domain}.
        slots:
          domain: path.businessDomainId
      - text: Look up the owners and stewards of domain {domain}.
        slots:
          domain: path.businessDomainId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessdomains/{businessDomainId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a business domain
      effect: destructive
      questions:
      - Can I remove a business domain we no longer need?
      - What is the way to retire a business domain from the catalog?
      instructions:
      - text: Delete business domain {domain}.
        slots:
          domain: path.businessDomainId
      - text: Remove domain {domain} from the unified catalog.
        slots:
          domain: path.businessDomainId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessdomains/{businessDomainId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a business domain
      effect: write
      questions:
      - How do I rename or re-describe an existing business domain?
      - Can I change the stewards of a business domain after it is created?
      instructions:
      - text: Rename business domain {domain} to {name}.
        slots:
          domain: path.businessDomainId
          name: requestBody.name
      - text: Set the stewards of existing domain {domain} to {stewards}.
        slots:
          domain: path.businessDomainId
          stewards: requestBody.stewards
      - text: Change the status of business domain {domain} to {status}.
        slots:
          domain: path.businessDomainId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'