# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mx Technologies Notifications API
  version: 1.0.0
extends: openapi/mx-technologies-notifications-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['/users/{user_guid}/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's notifications
      effect: read
      questions:
      - What notifications has a user been sent, including ones on channels other than push?
      - Can I see notifications sent to a user within a date range?
      instructions:
      - text: List notifications for user {user}.
        slots:
          user: path.user_guid
      - text: Show user {user}'s notifications from {from_date} to {to_date}.
        slots:
          user: path.user_guid
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/notifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a push notification to a user
      effect: write
      questions:
      - How do I send a push message to a user in the mobile banking app?
      - Can API-created notifications go out by email or SMS, or only push?
      instructions:
      - text: Send user {user} a push notification titled {subject} saying {content}.
        slots:
          user: path.user_guid
          subject: query.subject
          content: query.content
      - text: Create a notification for user {user} with subject {subject} and body {content}.
        slots:
          user: path.user_guid
          subject: query.subject
          content: query.content
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_guid}/notifications/{notification_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one notification
      effect: read
      questions:
      - What did a specific notification to a user say?
      - Can I look up a single notification by its GUID?
      instructions:
      - text: Get notification {notification} for user {user}.
        slots:
          notification: path.notification_guid
          user: path.user_guid
      - text: Show the content of user {user}'s notification {notification}.
        slots:
          user: path.user_guid
          notification: path.notification_guid
      method: generated
      generated: '2026-09-26'