# 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 Records Management Retention Events API
  version: 1.0.0
extends: openapi/microsoft-purview-retention-events-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['/security/triggers/retentionEvents'].get
  update:
    x-apievangelist-phrasing:
      intent: List retention events
      effect: read
      questions:
      - Which retention events have been triggered so far?
      - Can I filter retention events and expand their event type?
      instructions:
      - text: List all retention events.
      - text: Show the top {top} retention events matching {filter}.
        slots:
          top: query.$top
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/triggers/retentionEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a retention event
      effect: write
      questions:
      - How do I start event-based retention when something happens, like an employee leaving?
      - Can I set the date an event-based retention period starts?
      instructions:
      - text: Create retention event {name} of type {type}.
        slots:
          name: requestBody.displayName
          type: requestBody.retentionEventType
      - text: Trigger retention event {name} effective {date} for queries {queries}.
        slots:
          name: requestBody.displayName
          date: requestBody.eventTriggerDateTime
          queries: requestBody.eventQueries
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/triggers/retentionEvents/{retentionEventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a retention event
      effect: read
      questions:
      - What is the status of a retention event I triggered?
      - Can I see a retention event along with its event type?
      instructions:
      - text: Show me retention event {event}.
        slots:
          event: path.retentionEventId
      - text: Get retention event {event} expanding {expand}.
        slots:
          event: path.retentionEventId
          expand: query.$expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/triggers/retentionEvents/{retentionEventId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a retention event
      effect: destructive
      questions:
      - Can I delete a retention event that was triggered by mistake?
      - What is the way to remove a retention event?
      instructions:
      - text: Delete retention event {event}.
        slots:
          event: path.retentionEventId
      - text: Remove event {event}.
        slots:
          event: path.retentionEventId
      method: generated
      generated: '2026-10-01'