Acronis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Alert Manager Alerts API

7 actions 7 updates phrasing extends openapi/acronis-alerts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Acronis's API. It is a proposal applied on top of the contract, not a document Acronis publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/alerts'].get
$.paths['/alerts'].post
$.paths['/alerts'].delete
$.paths['/alerts/{id}'].get
$.paths['/alerts/{id}'].delete
$.paths['/alerts/{id}/false_positive'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Alert Manager Alerts API
  version: 1.0.0
extends: openapi/acronis-alerts-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: 6
- target: $.paths['/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List alerts
      effect: read
      questions:
      - How do I see all active alerts in my tenant?
      - Can I filter alerts by severity or by backup plan?
      - Which alerts were raised for a specific machine?
      instructions:
      - text: List alerts with severity {severity}.
        slots:
          severity: query.severity
      - text: List alerts for resource {resourceName}.
        slots:
          resourceName: query.resourceName
      - text: Show alerts from plan {planName} in category {category}.
        slots:
          planName: query.planName
          category: query.category
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Raise a new alert
      effect: write
      questions:
      - How do I create and activate a custom alert?
      - Can my integration raise its own alerts in the console?
      instructions:
      - text: Create and activate a new alert.
      - text: Raise an alert from my integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alerts'].delete
  update:
    x-apievangelist-phrasing:
      intent: Dismiss alerts matching a filter
      effect: destructive
      questions:
      - How do I dismiss every alert of a certain type at once?
      - What happens if I dismiss alerts without giving any filter?
      instructions:
      - text: Dismiss all alerts of type {type}.
        slots:
          type: query.type
      - text: Dismiss alerts with severity {severity} for resource {resourceId}.
        slots:
          severity: query.severity
          resourceId: query.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alerts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one alert
      effect: read
      questions:
      - How do I look up a single alert's details by ID?
      - Can I still read an alert after it was dismissed?
      instructions:
      - text: Show alert {id}.
        slots:
          id: path.id
      - text: Get alert {id} even if it was dismissed.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alerts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Dismiss a single alert
      effect: destructive
      questions:
      - How do I dismiss one specific alert?
      - Can I clear an individual alert without touching the others?
      instructions:
      - text: Dismiss alert {id}.
        slots:
          id: path.id
      - text: Clear only alert {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alerts/{id}/false_positive'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark an alert as a false positive
      effect: write
      questions:
      - How do I flag an alert as a false positive?
      - Can I undo a false-positive mark on an alert?
      instructions:
      - text: 'Mark alert {id} false positive: {falsePositive}.'
        slots:
          id: path.id
          falsePositive: requestBody.falsePositive
      - text: Set the false-positive flag on alert {id} to {falsePositive}.
        slots:
          id: path.id
          falsePositive: requestBody.falsePositive
      method: generated
      generated: '2026-09-26'