# 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 Purview Share Client Received Share API
  version: 1.0.0
extends: openapi/microsoft-azure-receivedshare-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: 5
- target: $.paths['/receivedShares/{receivedShareId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a received data share
      effect: read
      questions:
      - What are the details of a data share someone sent me?
      - Can I look up a received share by its ID?
      instructions:
      - text: Get received share {id}.
        slots:
          id: path.receivedShareId
      - text: Show the details of the share I received with ID {id}.
        slots:
          id: path.receivedShareId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/receivedShares/{receivedShareId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a received data share
      effect: write
      questions:
      - How do I accept or change a data share I have received?
      - Can I attach a received share to a target by updating it?
      instructions:
      - text: Update received share {id} of kind {kind}.
        slots:
          id: path.receivedShareId
          kind: requestBody.shareKind
      - text: Save changes to received share {id}.
        slots:
          id: path.receivedShareId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/receivedShares/{receivedShareId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a received data share
      effect: destructive
      questions:
      - How do I delete a data share I received and no longer want?
      - Can I remove a received share by ID?
      instructions:
      - text: Delete received share {id}.
        slots:
          id: path.receivedShareId
      - text: Remove the share I received with ID {id}.
        slots:
          id: path.receivedShareId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/receivedShares/attached'].get
  update:
    x-apievangelist-phrasing:
      intent: List received shares attached to a resource
      effect: read
      questions:
      - Which received shares are attached to a given target resource?
      - Can I sort or filter the received shares attached to one resource?
      instructions:
      - text: List received shares attached to {ref}.
        slots:
          ref: query.referenceName
      - text: Show attached received shares for {ref} ordered by {order}.
        slots:
          ref: query.referenceName
          order: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/receivedShares/detached'].get
  update:
    x-apievangelist-phrasing:
      intent: List detached received shares
      effect: read
      questions:
      - Which shares have I received but not attached to anything yet?
      - Can I filter received shares that are still detached?
      instructions:
      - text: List my detached received shares.
      - text: Show detached received shares matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'