# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Query Service Alert Subscriptions API
  version: 1.0.0
extends: openapi/adobe-suite-alert-subscriptions-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['/alert-subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List query alerts in a sandbox
      effect: read
      questions:
      - What query service alerts are set up in my sandbox?
      - Can I page and sort the list of alerts?
      instructions:
      - text: List all alerts in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show alerts in sandbox {sandbox} ordered by {orderby}, {pagesize} per page.
        slots:
          sandbox: header.x-sandbox-name
          orderby: query.orderby
          pagesize: query.pagesize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert-subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a query alert and subscribe users
      effect: write
      questions:
      - How do I get emailed when a scheduled query fails?
      - Can I subscribe several people to an alert when I create it?
      instructions:
      - text: Create a {alertType} alert on query {assetId} and subscribe {subscriptions}.
        slots:
          alertType: requestBody.alertType
          assetId: requestBody.assetId
          subscriptions: requestBody.subscriptions
      - text: Alert {subscriptions} whenever schedule {assetId} hits {alertType}.
        slots:
          subscriptions: requestBody.subscriptions
          assetId: requestBody.assetId
          alertType: requestBody.alertType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert-subscriptions/{assetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert subscriptions for a query or schedule
      effect: read
      questions:
      - Who is subscribed to alerts on a particular query?
      - Can I see every alert type configured for one schedule?
      instructions:
      - text: List alert subscriptions for query {assetId}.
        slots:
          assetId: path.assetId
      - text: Show all alerts and subscribers on schedule {assetId}.
        slots:
          assetId: path.assetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert-subscriptions/{assetId}/{alertType}'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribers for one alert type on a query
      effect: read
      questions:
      - Who gets notified when this query fails, specifically?
      - Can I narrow alert subscriptions to a single alert type like start or success?
      instructions:
      - text: Show subscribers to the {alertType} alert on query {assetId}.
        slots:
          alertType: path.alertType
          assetId: path.assetId
      - text: List who receives {alertType} notifications for schedule {assetId}.
        slots:
          alertType: path.alertType
          assetId: path.assetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert-subscriptions/{assetId}/{alertType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a query alert
      effect: destructive
      questions:
      - How do I remove an alert from a query entirely?
      - Can I delete just one alert type on a schedule and keep the others?
      instructions:
      - text: Delete the {alertType} alert on query {assetId}.
        slots:
          alertType: path.alertType
          assetId: path.assetId
      - text: Remove the {alertType} alert from schedule {assetId} for good.
        slots:
          alertType: path.alertType
          assetId: path.assetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert-subscriptions/{assetId}/{alertType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a query alert
      effect: write
      questions:
      - Can I pause an alert temporarily without deleting it?
      - What switches an alert back on after I disabled it?
      instructions:
      - text: Set the {alertType} alert on query {assetId} to {value}.
        slots:
          alertType: path.alertType
          assetId: path.assetId
          value: requestBody.value
      - text: Disable the {alertType} alert for schedule {assetId}.
        slots:
          alertType: path.alertType
          assetId: path.assetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert-subscriptions/user-subscriptions/{emailID}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the alerts a user is subscribed to
      effect: read
      questions:
      - Which alerts is a particular colleague subscribed to?
      - Can I see a user's alert subscriptions with their status and notification channels?
      instructions:
      - text: List the alerts {emailID} is subscribed to.
        slots:
          emailID: path.emailID
      - text: Show alert subscriptions for {emailID}, {pagesize} per page.
        slots:
          emailID: path.emailID
          pagesize: query.pagesize
      method: generated
      generated: '2026-09-26'