# 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 Lineage API
  version: 1.0.0
extends: openapi/microsoft-purview-lineage-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['/api/atlas/v2/lineage/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lineage for an entity
      effect: read
      questions:
      - Where does the data in a given asset come from and where does it flow?
      - Can I limit how many hops of lineage are returned?
      instructions:
      - text: Get {direction} lineage for entity {guid}.
        slots:
          direction: query.direction
          guid: path.guid
      - text: Show lineage of asset {guid} in direction {direction} to depth {depth}.
        slots:
          guid: path.guid
          direction: query.direction
          depth: query.depth
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/lineage/{guid}/next'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through lineage for an entity
      effect: read
      questions:
      - How do I fetch the next page of lineage when an asset has many neighbours?
      - Can lineage results be paged with offset and limit?
      instructions:
      - text: Get the next page of {direction} lineage for entity {guid} from offset {offset}.
        slots:
          direction: query.direction
          guid: path.guid
          offset: query.offset
      - text: Fetch {limit} more lineage nodes for {guid} going {direction}.
        slots:
          limit: query.limit
          guid: path.guid
          direction: query.direction
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/lineage/uniqueAttribute/type/{typeName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lineage by type and unique attribute
      effect: read
      questions:
      - Can I look up lineage using an asset's type and qualified name instead of its GUID?
      - Which call returns lineage when I only know the entity type and unique attribute?
      instructions:
      - text: Get {direction} lineage for the {type} entity identified by unique attribute.
        slots:
          direction: query.direction
          type: path.typeName
      - text: Show lineage for type {type} in direction {direction} to depth {depth}.
        slots:
          type: path.typeName
          direction: query.direction
          depth: query.depth
      method: generated
      generated: '2026-10-01'