# 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 Relationship API
  version: 1.0.0
extends: openapi/microsoft-azure-relationship-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['/atlas/v2/relationship'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a relationship between catalog entities
      effect: write
      questions:
      - How do I change an existing lineage or relationship between two data catalog entities?
      - Can I update the attributes on a relationship that already exists?
      instructions:
      - text: Update existing relationship {guid} with attributes {attributes}.
        slots:
          guid: requestBody.guid
          attributes: requestBody.attributes
      - text: Change the status of existing relationship {guid} to {status}.
        slots:
          guid: requestBody.guid
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/relationship'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a relationship between catalog entities
      effect: write
      questions:
      - How do I link two entities in the data catalog with a new relationship?
      - Can I create a typed relationship between a table and a column?
      instructions:
      - text: Create a {typeName} relationship between {end1} and {end2}.
        slots:
          typeName: requestBody.typeName
          end1: requestBody.end1
          end2: requestBody.end2
      - text: Link entities {end1} and {end2} with a new relationship labeled {label}.
        slots:
          end1: requestBody.end1
          end2: requestBody.end2
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/relationship/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a relationship by GUID
      effect: read
      questions:
      - How do I look up a relationship between entities using its GUID?
      - Can I get the full details of both ends when fetching a relationship?
      instructions:
      - text: Get relationship {guid}.
        slots:
          guid: path.guid
      - text: Show relationship {guid} with extended info set to {extendedInfo}.
        slots:
          guid: path.guid
          extendedInfo: query.extendedInfo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/atlas/v2/relationship/guid/{guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a relationship by GUID
      effect: destructive
      questions:
      - How do I remove a relationship between two catalog entities?
      - Can I unlink entities by deleting the relationship's GUID?
      instructions:
      - text: Delete relationship {guid}.
        slots:
          guid: path.guid
      - text: Unlink the entities joined by relationship {guid}.
        slots:
          guid: path.guid
      method: generated
      generated: '2026-09-26'