# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Test Observer Notifications API
  version: 1.0.0
extends: openapi/canonical-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: 6
- target: $.paths['/v1/users/me/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Test Observer notifications
      effect: read
      questions:
      - What notifications do I have waiting in Test Observer?
      - Can I see only my unread notifications?
      instructions:
      - text: Show my notifications.
      - text: 'List my unread notifications only: {unread_only}, {limit} at a time.'
        slots:
          unread_only: query.unread_only
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/users/me/notifications/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count my notifications
      effect: read
      questions:
      - How many notifications do I have?
      - What's my unread notification count right now?
      instructions:
      - text: Count my notifications.
      - text: Tell me how many of my notifications are unread, unread only {unread_only}.
        slots:
          unread_only: query.unread_only
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/users/me/notifications/{notification_id}/dismiss'].post
  update:
    x-apievangelist-phrasing:
      intent: Dismiss one of my notifications
      effect: write
      questions:
      - How do I mark one of my own notifications as read?
      - Can I dismiss a notification from my inbox?
      instructions:
      - text: Mark my notification {notification_id} as read.
        slots:
          notification_id: path.notification_id
      - text: Dismiss notification {notification_id} from my own list.
        slots:
          notification_id: path.notification_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/users/{user_id}/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List another user's notifications
      effect: read
      questions:
      - Can I view the notifications of a specific Test Observer user?
      - How do I see only the unread notifications for another user?
      instructions:
      - text: List the notifications for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show unread notifications for user {user_id}, unread only {unread_only}.
        slots:
          user_id: path.user_id
          unread_only: query.unread_only
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/users/{user_id}/notifications/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a user's notifications
      effect: read
      questions:
      - How many notifications does a given user have?
      - What's the unread notification count for a particular user?
      instructions:
      - text: Count the notifications for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Get user {user_id}'s unread notification total, unread only {unread_only}.
        slots:
          user_id: path.user_id
          unread_only: query.unread_only
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/users/{user_id}/notifications/{notification_id}/dismiss'].post
  update:
    x-apievangelist-phrasing:
      intent: Dismiss a notification for a user
      effect: write
      questions:
      - Can I mark a notification as read on behalf of another user?
      - How do I clear a specific notification for a named user?
      instructions:
      - text: Mark notification {notification_id} as read for user {user_id}.
        slots:
          notification_id: path.notification_id
          user_id: path.user_id
      - text: Dismiss user {user_id}'s notification {notification_id}.
        slots:
          user_id: path.user_id
          notification_id: path.notification_id
      method: generated
      generated: '2026-09-26'