# 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 Data Products API
  version: 1.0.0
extends: openapi/microsoft-purview-data-products-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['/dataproducts'].get
  update:
    x-apievangelist-phrasing:
      intent: List data products
      effect: read
      questions:
      - What data products are published in our unified catalog?
      - Can I page through data products in smaller batches?
      instructions:
      - text: List all data products in the catalog.
      - text: Show data products {size} per page.
        slots:
          size: query.maxpagesize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dataproducts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data product
      effect: write
      questions:
      - How do I package data assets into a new data product?
      - Can I assign a new data product to a business domain?
      instructions:
      - text: Create a data product named {name} in business domain {domain}.
        slots:
          name: requestBody.name
          domain: requestBody.businessDomainId
      - text: Create data product {name} containing assets {assets}.
        slots:
          name: requestBody.name
          assets: requestBody.dataAssets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dataproducts/{dataProductId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data product
      effect: read
      questions:
      - Which data assets are included in a specific data product?
      - Who owns one particular data product?
      instructions:
      - text: Show me data product {product}.
        slots:
          product: path.dataProductId
      - text: Get the owners and assets of data product {product}.
        slots:
          product: path.dataProductId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dataproducts/{dataProductId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data product
      effect: destructive
      questions:
      - Can I retire a data product from the unified catalog?
      - Is it possible to delete a data product by its ID?
      instructions:
      - text: Delete data product {product}.
        slots:
          product: path.dataProductId
      - text: Remove data product {product} from the catalog.
        slots:
          product: path.dataProductId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dataproducts/{dataProductId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a data product
      effect: write
      questions:
      - How do I add assets to a data product that already exists?
      - Can I change the owners or status of an existing data product?
      instructions:
      - text: Set the data assets of existing data product {product} to {assets}.
        slots:
          product: path.dataProductId
          assets: requestBody.dataAssets
      - text: Change the status of data product {product} to {status}.
        slots:
          product: path.dataProductId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'