# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Lineage API
  version: 1.0.0
extends: openapi/microsoft-azure-lineage-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/lineage/{guid}/next'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through lineage of an entity
      effect: read
      questions:
      - Can I get the next page of upstream or downstream lineage for a data asset?
      - Is lineage paging controlled by offset and limit?
      instructions:
      - text: Get the next page of {direction} lineage for entity {guid}.
        slots:
          direction: query.direction
          guid: path.guid
      - text: Page lineage for entity {guid} in direction {direction} starting at offset {offset}.
        slots:
          guid: path.guid
          direction: query.direction
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/lineage/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the lineage graph of an entity by GUID
      effect: read
      questions:
      - What does the lineage graph look like for a data asset in Purview?
      - Can I control how many hops and how wide the lineage graph goes?
      instructions:
      - text: Get the lineage graph for entity {guid} in direction {direction}.
        slots:
          guid: path.guid
          direction: query.direction
      - text: Show {direction} lineage for entity {guid} up to {depth} hops.
        slots:
          direction: query.direction
          guid: path.guid
          depth: query.depth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lineage/{guid}/next/'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through lineage including derived lineage
      effect: read
      questions:
      - Can I page lineage for an entity and include derived lineage in the results?
      - Is there a lineage paging call that supports the getDerivedLineage flag?
      instructions:
      - text: Get the next page of {direction} lineage for entity {guid} with derived lineage {getDerivedLineage}.
        slots:
          direction: query.direction
          guid: path.guid
          getDerivedLineage: query.getDerivedLineage
      - text: Page derived lineage for entity {guid} in direction {direction}, limit {limit}.
        slots:
          guid: path.guid
          direction: query.direction
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/lineage/uniqueAttribute/type/{typeName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lineage of an entity by type and unique attribute
      effect: read
      questions:
      - Can I fetch lineage for an entity when I only know its type and qualified name?
      - Which call returns lineage by unique attribute instead of GUID?
      instructions:
      - text: Get {direction} lineage for the {typeName} entity with qualified name {qualifiedName}.
        slots:
          direction: query.direction
          typeName: path.typeName
          qualifiedName: query.attr:qualifiedName
      - text: Show lineage for type {typeName} identified by unique attribute {qualifiedName}, direction {direction}.
        slots:
          typeName: path.typeName
          qualifiedName: query.attr:qualifiedName
          direction: query.direction
      method: generated
      generated: '2026-09-26'