# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Issue notification schemes API
  version: 1.0.0
extends: openapi/jira-issue-notification-schemes-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: 8
- target: $.paths['/rest/api/3/notificationscheme'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification schemes
      effect: read
      questions:
      - What notification schemes are set up in Jira?
      - Can I find the notification scheme a specific project uses?
      - Is there a way to list only the default notification scheme?
      instructions:
      - text: List all notification schemes.
      - text: Show the notification scheme used by project {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/notificationscheme'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification scheme
      effect: write
      questions:
      - How do I create a new notification scheme with its events and recipients?
      - How many notifications can I include when creating a scheme?
      instructions:
      - text: Create a notification scheme named {name}.
        slots:
          name: requestBody.name
      - text: Create notification scheme {name} described as {description} with events {notificationSchemeEvents}.
        slots:
          name: requestBody.name
          description: requestBody.description
          notificationSchemeEvents: requestBody.notificationSchemeEvents
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/notificationscheme/project'].get
  update:
    x-apievangelist-phrasing:
      intent: See which projects use which notification scheme
      effect: read
      questions:
      - Which projects are assigned to a particular notification scheme?
      - Can I map every project to its notification scheme?
      instructions:
      - text: List projects using notification scheme {notificationSchemeId}.
        slots:
          notificationSchemeId: query.notificationSchemeId
      - text: Show the project-to-notification-scheme mappings for all projects.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/notificationscheme/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification scheme's events
      effect: read
      questions:
      - Who gets notified for each event in a notification scheme?
      - Can I view one notification scheme with its recipients?
      instructions:
      - text: Get notification scheme {id}.
        slots:
          id: path.id
      - text: Show the events and recipients in notification scheme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/notificationscheme/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or describe a notification scheme
      effect: write
      questions:
      - Can I rename a notification scheme or change its description?
      - Does updating a notification scheme change its events?
      instructions:
      - text: Rename notification scheme {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the description of notification scheme {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/notificationscheme/{id}/notification'].put
  update:
    x-apievangelist-phrasing:
      intent: Add notifications to a scheme
      effect: write
      questions:
      - Can I add new event recipients to an existing notification scheme?
      - Is the EmailAddress notification type still supported when adding notifications?
      instructions:
      - text: Add notifications {notificationSchemeEvents} to scheme {id}.
        slots:
          notificationSchemeEvents: requestBody.notificationSchemeEvents
          id: path.id
      - text: Notify extra recipients on scheme {id} using events {notificationSchemeEvents}.
        slots:
          id: path.id
          notificationSchemeEvents: requestBody.notificationSchemeEvents
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/notificationscheme/{notificationSchemeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification scheme
      effect: destructive
      questions:
      - Can I delete a notification scheme I no longer need?
      - Who has permission to remove a notification scheme?
      instructions:
      - text: Delete notification scheme {notificationSchemeId}.
        slots:
          notificationSchemeId: path.notificationSchemeId
      - text: Remove the unused notification scheme {notificationSchemeId}.
        slots:
          notificationSchemeId: path.notificationSchemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one notification from a scheme
      effect: destructive
      questions:
      - Can I stop one recipient from being notified without deleting the whole scheme?
      - What does removing a single notification from a scheme do?
      instructions:
      - text: Remove notification {notificationId} from scheme {notificationSchemeId}.
        slots:
          notificationId: path.notificationId
          notificationSchemeId: path.notificationSchemeId
      - text: Delete recipient entry {notificationId} in notification scheme {notificationSchemeId}.
        slots:
          notificationId: path.notificationId
          notificationSchemeId: path.notificationSchemeId
      method: generated
      generated: '2026-09-26'