API Evangelist conversational phrasing for Microsoft Purview Records Management Retention Event Types API

# 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 Event Types API
  version: 1.0.0
extends: openapi/microsoft-purview-retention-event-types-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: 5
- target: $.paths['/security/triggerTypes/retentionEventTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List retention event types
      effect: read
      questions:
      - What retention event types are defined for event-based retention?
      - Can I filter retention event types by name?
      instructions:
      - text: List all retention event types.
      - text: Show the top {top} retention event types matching {filter}.
        slots:
          top: query.$top
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/triggerTypes/retentionEventTypes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a retention event type
      effect: write
      questions:
      - How do I define a new type of event that starts a retention period?
      - Can I describe a retention event type when creating it?
      instructions:
      - text: Create a retention event type named {name}.
        slots:
          name: requestBody.displayName
      - text: Add retention event type {name} described as {description}.
        slots:
          name: requestBody.displayName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/triggerTypes/retentionEventTypes/{retentionEventTypeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a retention event type
      effect: read
      questions:
      - Where can I see one retention event type's details?
      - Who created a specific retention event type?
      instructions:
      - text: Show me retention event type {type}.
        slots:
          type: path.retentionEventTypeId
      - text: Get the details of event type {type}.
        slots:
          type: path.retentionEventTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/triggerTypes/retentionEventTypes/{retentionEventTypeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a retention event type
      effect: destructive
      questions:
      - Can I remove a retention event type that is no longer used?
      - What is the way to delete an event type for retention?
      instructions:
      - text: Delete retention event type {type}.
        slots:
          type: path.retentionEventTypeId
      - text: Remove event type {type}.
        slots:
          type: path.retentionEventTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/security/triggerTypes/retentionEventTypes/{retentionEventTypeId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a retention event type
      effect: write
      questions:
      - How do I rename a retention event type?
      - Can I change the description of an existing retention event type?
      instructions:
      - text: Rename retention event type {type} to {name}.
        slots:
          type: path.retentionEventTypeId
          name: requestBody.displayName
      - text: Set the description of event type {type} to {description}.
        slots:
          type: path.retentionEventTypeId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'