# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dex Alerts Alerts - Devices API
  version: 1.0.0
extends: openapi/controlup-alerts-devices-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: 4
- target: $.paths['/organizations/{orgId}/alert-configs/desktop/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a Devices alert configuration
      effect: read
      questions:
      - How is a specific Devices alert configured?
      - What threshold and severity does one of my device alerts use?
      instructions:
      - text: Show Devices alert {id} in organization {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      - text: Retrieve device alert config {id} for org {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/alert-configs/desktop/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Devices alert
      effect: destructive
      questions:
      - Can I remove a Devices alert I no longer need?
      - Is deleting a device alert configuration permanent?
      instructions:
      - text: Delete Devices alert {id} in organization {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      - text: Remove device alert {id} from org {orgId}.
        slots:
          id: path.id
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/alert-configs/desktop/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Devices alert
      effect: write
      questions:
      - Can I change the severity of an existing device alert?
      - Can I disable an existing Devices alert without deleting it?
      instructions:
      - text: Set severity of Devices alert {id} in org {orgId} to {severity}.
        slots:
          id: path.id
          orgId: path.orgId
          severity: requestBody.severity
      - text: Set enabled to {enabled} on existing device alert {id} in org {orgId}.
        slots:
          enabled: requestBody.enabled
          id: path.id
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/alert-configs/desktop'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Devices alert
      effect: write
      questions:
      - Can I set up a new alert when a device metric crosses a threshold several times?
      - What's required to create a new Devices alert?
      instructions:
      - text: Create a {severity} Devices alert named {name} in org {orgId} on metrics {metrics}.
        slots:
          severity: requestBody.severity
          name: requestBody.name
          orgId: path.orgId
          metrics: requestBody.metrics
      - text: Create a new device alert {name} that fires after {hitsNumber} hits in {hitsTimeWindowSeconds} seconds for org {orgId}.
        slots:
          name: requestBody.name
          hitsNumber: requestBody.hitsNumber
          hitsTimeWindowSeconds: requestBody.hitsTimeWindowSeconds
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'