# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Trello Notifications API
  version: 1.0.0
extends: openapi/trello-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: 12
- target: $.paths['/members/{id}/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's notifications
      effect: read
      questions:
      - How do I list a person's Trello notifications?
      - Can I fetch only unread notifications, capped to a certain number?
      - Is it possible to get notifications since or before a given notification?
      instructions:
      - text: List notifications for member {id}.
        slots:
          id: path.id
      - text: Get up to {limit} notifications for member {id} with read filter {read_filter}.
        slots:
          limit: query.limit
          id: path.id
          read_filter: query.read_filter
      - text: Show member {id}'s notifications since {since}.
        slots:
          id: path.id
          since: query.since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single notification
      effect: read
      questions:
      - How do I fetch one notification by its id?
      - What details does a single notification contain?
      instructions:
      - text: Get notification {id}.
        slots:
          id: path.id
      - text: Show me the full notification {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a notification's unread flag
      effect: write
      questions:
      - Can I update a notification object to flip whether it is unread?
      - How do I use the main notification update to mark one as unread again?
      instructions:
      - text: Update notification {id} setting unread to {unread}.
        slots:
          id: path.id
          unread: query.unread
      - text: Mark notification {id} unread via the notification update with unread {unread}.
        slots:
          id: path.id
          unread: query.unread
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/all/read'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark all my notifications as read
      effect: write
      questions:
      - How do I clear all my Trello notifications at once?
      - Is there a single call to mark every notification read?
      instructions:
      - text: Mark all of my notifications as read.
      - text: Clear every unread notification on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}/{field}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one field of a notification
      effect: read
      questions:
      - Can I read just the type or date of a notification?
      - What's the lightest way to fetch a single notification property?
      instructions:
      - text: Get the {field} field of notification {id}.
        slots:
          field: path.field
          id: path.id
      - text: Read only {field} from notification {id}.
        slots:
          field: path.field
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}/unread'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a notification's read status
      effect: write
      questions:
      - Is there a dedicated unread endpoint to mark just one notification as read?
      - Can I set a single notification's read status using the unread sub-resource?
      instructions:
      - text: Set the unread sub-resource of notification {id} to {value}.
        slots:
          id: path.id
          value: query.value
      - text: Mark notification {id} as read by setting its unread value to {value}.
        slots:
          id: path.id
          value: query.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}/board'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the board a notification is about
      effect: read
      questions:
      - Which board did this notification come from?
      - Can I get board details straight from a notification?
      instructions:
      - text: Get the board for notification {id}.
        slots:
          id: path.id
      - text: Show fields {fields} of the board linked to notification {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}/card'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the card a notification is about
      effect: read
      questions:
      - Which card is this notification about?
      - How do I jump from a notification to its card?
      instructions:
      - text: Get the card for notification {id}.
        slots:
          id: path.id
      - text: Show fields {fields} of the card behind notification {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}/list'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the list a notification is on
      effect: read
      questions:
      - Which list does a notification relate to?
      - Can I find the list name for a card notification?
      instructions:
      - text: Get the list for notification {id}.
        slots:
          id: path.id
      - text: Show fields {fields} of the list tied to notification {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}/member'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the member a notification is about
      effect: read
      questions:
      - Who is the person a notification is about, as opposed to who triggered it?
      - Can I see which member was added or mentioned in a notification?
      instructions:
      - text: Get the member that notification {id} is about.
        slots:
          id: path.id
      - text: Show the subject member (not the creator) of notification {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}/memberCreator'].get
  update:
    x-apievangelist-phrasing:
      intent: Get who triggered a notification
      effect: read
      questions:
      - Who caused this notification to be sent?
      - Can I find the member who created a notification?
      instructions:
      - text: Get the member who created notification {id}.
        slots:
          id: path.id
      - text: Show fields {fields} for the creator of notification {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{id}/organization'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Workspace a notification belongs to
      effect: read
      questions:
      - Which Workspace is this notification associated with?
      - Can I look up the organization behind a notification?
      instructions:
      - text: Get the Workspace for notification {id}.
        slots:
          id: path.id
      - text: Show fields {fields} of the organization linked to notification {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'