# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity REST Alerts API
  version: 1.0.0
extends: openapi/cohesity-alerts-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: 12
- target: $.paths['/public/alertCategories'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert categories
      effect: read
      questions:
      - What categories do Cohesity cluster alerts fall into?
      - Which alert categories can I filter on?
      instructions:
      - text: List the alert categories on the cluster.
      - text: Show me every alert category available.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alertNotificationRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert notification rules
      effect: read
      questions:
      - Who gets notified when an alert fires on my cluster?
      - Can I see all the rules that route alerts to email or webhooks?
      instructions:
      - text: List all alert notification rules.
      - text: Show the delivery targets configured in my notification rules.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alertNotificationRules'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an alert notification rule
      effect: write
      questions:
      - How do I change the email addresses on an existing notification rule?
      - Can I edit the webhook targets of a rule I already created?
      instructions:
      - text: Update the delivery targets on my existing alert notification rule.
      - text: Edit an existing notification rule to change who receives its alerts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alertNotificationRules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert notification rule
      effect: write
      questions:
      - How do I get emailed when critical alerts happen?
      - Can I send alerts of certain severities to a webhook?
      instructions:
      - text: Create a notification rule named {ruleName} emailing {emailDeliveryTargets}.
        slots:
          ruleName: requestBody.ruleName
          emailDeliveryTargets: requestBody.emailDeliveryTargets
      - text: Add rule {ruleName} sending {severities} alerts to webhook {webHookDeliveryTargets}.
        slots:
          ruleName: requestBody.ruleName
          severities: requestBody.severities
          webHookDeliveryTargets: requestBody.webHookDeliveryTargets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alertNotificationRules/{ruleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert notification rule
      effect: destructive
      questions:
      - How do I stop a notification rule from sending alerts?
      - Can I remove an alert rule by its id?
      instructions:
      - text: Delete alert notification rule {ruleId}.
        slots:
          ruleId: path.ruleId
      - text: Remove notification rule {ruleId}.
        slots:
          ruleId: path.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alertResolutions'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert resolutions
      effect: read
      questions:
      - Which alert resolutions have been recorded on my cluster?
      - Can I find the resolutions applied to a specific alert?
      instructions:
      - text: List up to {maxResolutions} alert resolutions.
        slots:
          maxResolutions: query.maxResolutions
      - text: Show up to {maxResolutions} resolutions for alerts {alertIdList}.
        slots:
          maxResolutions: query.maxResolutions
          alertIdList: query.alertIdList
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alertResolutions'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve alerts with a new resolution
      effect: write
      questions:
      - How do I mark a batch of alerts as resolved with a note?
      - Can I record what fixed an alert?
      instructions:
      - text: Resolve alerts {alertIdList} with note {resolutionDetails}.
        slots:
          alertIdList: requestBody.alertIdList
          resolutionDetails: requestBody.resolutionDetails
      - text: Create a new resolution for alerts {alertIdList}.
        slots:
          alertIdList: requestBody.alertIdList
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alertResolutions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alert resolution
      effect: read
      questions:
      - What did a particular alert resolution say?
      - Where can I view one resolution by its id?
      instructions:
      - text: Show alert resolution {id}.
        slots:
          id: path.id
      - text: Get the details of resolution {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alertResolutions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Apply an existing resolution to more alerts
      effect: write
      questions:
      - Can I reuse a resolution I already wrote for other alerts?
      - How do I mark additional alerts resolved under an existing resolution?
      instructions:
      - text: Apply resolution {id} to alerts {alertIdList}.
        slots:
          id: path.id
          alertIdList: requestBody.alertIdList
      - text: Add alerts {alertIdList} to existing resolution {id}.
        slots:
          alertIdList: requestBody.alertIdList
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alertTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered alert types
      effect: read
      questions:
      - What kinds of alerts can the cluster raise?
      - Can I list registered alert types within certain categories?
      instructions:
      - text: List registered alert types.
      - text: Show alert types in categories {alertCategoryList}.
        slots:
          alertCategoryList: requestBody.alertCategoryList
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List cluster alerts
      effect: read
      questions:
      - Which critical alerts are open on my Cohesity cluster?
      - Can I filter alerts by severity, state, or date range?
      - What alerts fired in the last day?
      instructions:
      - text: List up to {maxAlerts} alerts.
        slots:
          maxAlerts: query.maxAlerts
      - text: Show up to {maxAlerts} alerts with severity {alertSeverityList}.
        slots:
          maxAlerts: query.maxAlerts
          alertSeverityList: query.alertSeverityList
      - text: List up to {maxAlerts} alerts raised since {startDateUsecs}.
        slots:
          maxAlerts: query.maxAlerts
          startDateUsecs: query.startDateUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/alerts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one alert
      effect: read
      questions:
      - What are the full details of a specific alert?
      - Where can I look up an alert by its id?
      instructions:
      - text: Show alert {id}.
        slots:
          id: path.id
      - text: Get the details of alert {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'