# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity Exposure Email notifier API
  version: 1.0.0
extends: openapi/tenable-email-notifier-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: 7
- target: $.paths['/api/email-notifiers'].get
  update:
    x-apievangelist-phrasing:
      intent: List email alert notifiers
      effect: read
      questions:
      - Who receives email alerts from Identity Exposure?
      - Can I list all configured email notifiers?
      instructions:
      - text: List email notifiers.
      - text: Show every email alert recipient configured.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-notifiers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email notifier
      effect: write
      questions:
      - How do I set up email alerts for a new recipient?
      - Can I add an email notifier for deviances or attacks?
      instructions:
      - text: Create a new email notifier.
      - text: Add an email alert recipient.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-notifiers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email notifier
      effect: read
      questions:
      - What thresholds and directories does one email notifier cover?
      - How do I view a single email notifier's settings?
      instructions:
      - text: Get email notifier {id}.
        slots:
          id: path.id
      - text: Show settings of email notifier {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-notifiers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email notifier
      effect: destructive
      questions:
      - How do I stop sending email alerts to someone?
      - Can I remove an email notifier?
      instructions:
      - text: Delete email notifier {id}.
        slots:
          id: path.id
      - text: Stop email alerts from notifier {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-notifiers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an email notifier
      effect: write
      questions:
      - Can I change the address an email notifier sends to?
      - How do I raise the criticity threshold on email alerts?
      instructions:
      - text: Change email notifier {id} to send to {address}.
        slots:
          id: path.id
          address: requestBody.address
      - text: Set criticity threshold {criticityThreshold} on email notifier {id}.
        slots:
          criticityThreshold: requestBody.criticityThreshold
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-notifiers/test-message/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a test email for a saved notifier
      effect: write
      questions:
      - How do I check that an existing email notifier actually delivers?
      - Can I trigger a test message from a saved notifier?
      instructions:
      - text: Send a test email from saved notifier {id}.
        slots:
          id: path.id
      - text: Trigger a test message on email notifier {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-notifiers/test-message'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test email before saving
      effect: write
      questions:
      - Can I test email alert settings before creating the notifier?
      - Will a test email reach an address with a given threshold and input type?
      instructions:
      - text: Send a test email to {address} for directories {directories} at threshold {criticityThreshold}, input {inputType}.
        slots:
          address: requestBody.address
          directories: requestBody.directories
          criticityThreshold: requestBody.criticityThreshold
          inputType: requestBody.inputType
      - text: Try unsaved email alert settings by mailing {address}.
        slots:
          address: requestBody.address
      method: generated
      generated: '2026-10-01'