# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gitea Notification API
  version: 1.0.0
extends: openapi/gitea-notification-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: 7
- target: $.paths['/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my notification threads
      effect: read
      questions:
      - What notifications do I have across all my repositories?
      - Can I list only pinned notifications, or only ones about pull requests?
      instructions:
      - text: List my notifications with status {status_types}.
        slots:
          status_types: query.status-types
      - text: Show my {subject_type} notifications since {since}.
        slots:
          subject_type: query.subject-type
          since: query.since
      - text: List all my notifications, including read ones.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark all my notifications read, pinned or unread
      effect: write
      questions:
      - How do I mark every notification in my inbox as read at once?
      - Can I bulk-mark notifications older than a certain time?
      instructions:
      - text: Mark every notification in my inbox, across all repos, as read.
      - text: Set all my notifications up to {last_read_at} to {to_status}.
        slots:
          last_read_at: query.last_read_at
          to_status: query.to-status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/new'].get
  update:
    x-apievangelist-phrasing:
      intent: Check for unread notifications
      effect: read
      questions:
      - Do I have any unread notifications right now?
      - How many new notifications are waiting for me?
      instructions:
      - text: Check whether I have unread notifications.
      - text: Tell me the count of my new notifications.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/threads/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification thread
      effect: read
      questions:
      - What is a specific notification about?
      - Can I open a single notification thread by its ID?
      instructions:
      - text: Show notification thread {id}.
        slots:
          id: path.id
      - text: Get the details of notification {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/threads/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark one notification thread read
      effect: write
      questions:
      - How do I mark a single notification as read?
      - Can I pin one notification thread instead of marking it read?
      instructions:
      - text: Mark notification thread {id} as read.
        slots:
          id: path.id
      - text: Set notification {id} to status {to_status}.
        slots:
          id: path.id
          to_status: query.to-status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my notifications for one repository
      effect: read
      questions:
      - What notifications do I have for a specific repository?
      - Can I see only the unread issue notifications in one repo?
      instructions:
      - text: List my notifications for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show my {subject_type} notifications in {owner}/{repo} with status {status_types}.
        slots:
          subject_type: query.subject-type
          owner: path.owner
          repo: path.repo
          status_types: query.status-types
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/notifications'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a repository's notifications read
      effect: write
      questions:
      - How do I clear all notifications for just one repository?
      - Can I mark a single repo's notifications as pinned or unread?
      instructions:
      - text: Clear the notification inbox for repository {owner}/{repo} only.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Set notifications in {owner}/{repo} up to {last_read_at} to {to_status}.
        slots:
          owner: path.owner
          repo: path.repo
          last_read_at: query.last_read_at
          to_status: query.to-status
      method: generated
      generated: '2026-09-26'