# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Notification…
  version: 1.0.0
extends: openapi/atlassian-issue-notification-schemes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      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:
      - Which notification schemes are set up in Jira?
      - Can I list only the default notification scheme?
      instructions:
      - text: List all Jira notification schemes.
      - text: List the notification schemes used by project {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'
- 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 Jira notification scheme with its events?
      - How many notifications can a new scheme include in one request?
      instructions:
      - text: Create a notification scheme named {name}.
        slots:
          name: requestBody.name
      - text: Create notification scheme {name} with events {notificationSchemeEvents}.
        slots:
          name: requestBody.name
          notificationSchemeEvents: requestBody.notificationSchemeEvents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/notificationscheme/project'].get
  update:
    x-apievangelist-phrasing:
      intent: Find projects using notification schemes
      effect: read
      questions:
      - Which projects use a given notification scheme?
      - What notification scheme is a particular project assigned?
      instructions:
      - text: List projects that use notification scheme {notificationSchemeId}.
        slots:
          notificationSchemeId: query.notificationSchemeId
      - text: Show which notification scheme project {projectId} is mapped to.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/notificationscheme/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification scheme's events and recipients
      effect: read
      questions:
      - Who gets notified for each event in a notification scheme?
      - Can I see the events configured in one notification scheme?
      instructions:
      - text: Get notification scheme {id}.
        slots:
          id: path.id
      - text: Show events and recipients for notification scheme {id} expanded with {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/notificationscheme/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a notification scheme
      effect: write
      questions:
      - How do I rename a notification scheme?
      - Can I update a notification scheme's description only?
      instructions:
      - text: Rename notification scheme {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set notification scheme {id}'s description to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- 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 more event notifications to an existing 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: Extend notification scheme {id} with events {notificationSchemeEvents}.
        slots:
          id: path.id
          notificationSchemeEvents: requestBody.notificationSchemeEvents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/notificationscheme/{notificationSchemeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification scheme
      effect: destructive
      questions:
      - How do I remove a notification scheme we no longer need?
      - What permission does deleting a notification scheme require?
      instructions:
      - text: Delete notification scheme {notificationSchemeId}.
        slots:
          notificationSchemeId: path.notificationSchemeId
      - text: Permanently remove notification scheme {notificationSchemeId}.
        slots:
          notificationSchemeId: path.notificationSchemeId
      method: generated
      generated: '2026-10-01'
- 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 drop a single notification from a scheme without deleting the scheme?
      - Which IDs identify a notification inside a scheme?
      instructions:
      - text: Remove notification {notificationId} from scheme {notificationSchemeId}.
        slots:
          notificationId: path.notificationId
          notificationSchemeId: path.notificationSchemeId
      - text: Stop notification {notificationId} in notification scheme {notificationSchemeId}.
        slots:
          notificationId: path.notificationId
          notificationSchemeId: path.notificationSchemeId
      method: generated
      generated: '2026-10-01'