# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ThousandEyes Alert Rules API
  version: 1.0.0
extends: openapi/thousandeyes-alert-rules-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: 5
- target: $.paths['/alerts/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert rules
      effect: read
      questions:
      - What alert rules exist in my ThousandEyes account?
      - Which alert rules are the defaults applied to each test type?
      instructions:
      - text: List all alert rules.
      - text: Show alert rules in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alerts/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert rule
      effect: write
      questions:
      - How do I alert when packet loss crosses a threshold?
      - Can a new alert rule require several agents to violate before it fires?
      instructions:
      - text: Create alert rule {ruleName} of type {alertType} with expression {expression}.
        slots:
          ruleName: requestBody.ruleName
          alertType: requestBody.alertType
          expression: requestBody.expression
      - text: Create a {severity} alert rule named {ruleName} for tests {testIds}.
        slots:
          severity: requestBody.severity
          ruleName: requestBody.ruleName
          testIds: requestBody.testIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alerts/rules/{ruleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alert rule
      effect: read
      questions:
      - What conditions does one alert rule check?
      - Which tests is a specific alert rule attached to?
      instructions:
      - text: Show alert rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Get the expression and notifications of alert rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alerts/rules/{ruleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an alert rule
      effect: write
      questions:
      - How do I change the threshold of an existing alert rule?
      - Can I add notifications to an alert rule I already have?
      instructions:
      - text: Change the expression of alert rule {ruleId} to {expression}.
        slots:
          ruleId: path.ruleId
          expression: requestBody.expression
      - text: Set the severity of alert rule {ruleId} to {severity}.
        slots:
          ruleId: path.ruleId
          severity: requestBody.severity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alerts/rules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert rule
      effect: destructive
      questions:
      - How do I delete an alert rule that is linked to tests?
      - What permissions are needed to remove an alert rule?
      instructions:
      - text: Delete alert rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Remove alert rule {ruleId} from account group {aid}.
        slots:
          ruleId: path.ruleId
          aid: query.aid
      method: generated
      generated: '2026-09-26'