Microsoft Purview · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Purview Relationship API

5 actions 5 updates phrasing extends openapi/microsoft-purview-relationship-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Purview's API. It is a proposal applied on top of the contract, not a document Microsoft Purview publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/atlas/v2/relationship'].put
$.paths['/api/atlas/v2/relationship'].post
$.paths['/api/atlas/v2/relationship/guid/{guid}'].get
$.paths['/api/atlas/v2/relationship/guid/{guid}'].delete

OpenAPI Overlay

Raw ↑ 
# 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 Relationship API
  version: 1.0.0
extends: openapi/microsoft-purview-relationship-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: 4
- target: $.paths['/api/atlas/v2/relationship'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a relationship between entities
      effect: write
      questions:
      - How do I change the attributes of an existing relationship between assets?
      - Can I modify a relationship's label or status?
      instructions:
      - text: Update relationship {guid} with attributes {attrs}.
        slots:
          guid: requestBody.guid
          attrs: requestBody.attributes
      - text: Change the status of existing relationship {guid} to {status}.
        slots:
          guid: requestBody.guid
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/relationship'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a relationship between entities
      effect: write
      questions:
      - How do I link two assets with a typed relationship?
      - Can I create a relationship by naming both ends?
      instructions:
      - text: Create a {type} relationship between {end1} and {end2}.
        slots:
          type: requestBody.typeName
          end1: requestBody.end1
          end2: requestBody.end2
      - text: Link entity {end1} to entity {end2}.
        slots:
          end1: requestBody.end1
          end2: requestBody.end2
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/relationship/guid/{guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a relationship
      effect: read
      questions:
      - What are the two ends of a given relationship?
      - Can I get extended info about the entities in a relationship?
      instructions:
      - text: Show me relationship {guid}.
        slots:
          guid: path.guid
      - text: Get relationship {guid} with extended info {extended}.
        slots:
          guid: path.guid
          extended: query.extendedInfo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/atlas/v2/relationship/guid/{guid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a relationship
      effect: destructive
      questions:
      - Can I remove the link between two assets?
      - What is the way to delete a relationship by 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-10-01'