# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Novu Messages API
  version: 1.0.0
extends: openapi/novu-messages-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: 3
- target: $.paths['/v1/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List sent messages
      effect: read
      questions:
      - How do I see the messages Novu has sent in this environment?
      - Can I filter messages by channel or by subscriber?
      - Which messages were generated by a particular transactionId?
      instructions:
      - text: List messages sent to subscriber {subscriberId}.
        slots:
          subscriberId: query.subscriberId
      - text: Show all {channel} messages.
        slots:
          channel: query.channel
      - text: List the messages from transaction {transactionId}.
        slots:
          transactionId: query.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/messages/{messageId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a message
      effect: destructive
      questions:
      - How do I delete a single message by its id?
      - Can a deleted message be restored?
      instructions:
      - text: Delete message {messageId}.
        slots:
          messageId: path.messageId
      - text: Permanently remove the single message {messageId}.
        slots:
          messageId: path.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/messages/transaction/{transactionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all messages from a trigger
      effect: destructive
      questions:
      - How do I delete every message produced by one triggered event?
      - Can I delete only the email messages for a transaction and keep the rest?
      instructions:
      - text: Delete all messages for transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Delete the {channel} messages from transaction {transactionId}.
        slots:
          channel: query.channel
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'