Acronis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Event Manager Subscriptions API

3 actions 3 updates phrasing extends openapi/acronis-subscriptions-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 3

$.info

$.paths['/subscriptions'].post

$.paths['/subscriptions/offset'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Event Manager Subscriptions API
  version: 1.0.0
extends: openapi/acronis-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: 2
- target: $.paths['/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to platform events
      effect: write
      questions:
      - How do I subscribe to events on a topic for my tenant tree?
      - Can I filter an event subscription with a CEL expression?
      instructions:
      - text: Create subscription {subscription_id} to topic {topic_id} for event types {types} at tenant depth {tenant_depth}.
        slots:
          subscription_id: requestBody.subscription_id
          topic_id: requestBody.topic_id
          types: requestBody.types
          tenant_depth: requestBody.tenant_depth
      - text: Subscribe {subscription_id} to {topic_id} events {types} ({tenant_depth}) filtered by {cel}.
        slots:
          subscription_id: requestBody.subscription_id
          topic_id: requestBody.topic_id
          types: requestBody.types
          tenant_depth: requestBody.tenant_depth
          cel: requestBody.cel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/offset'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription's acknowledged offset
      effect: read
      questions:
      - How far has my event subscriber acknowledged events?
      - Can I check the current offset of an event subscription?
      instructions:
      - text: Get the offset for subscription {subscription_id}.
        slots:
          subscription_id: query.subscription_id
      - text: Show how many events {subscription_id} has acknowledged.
        slots:
          subscription_id: query.subscription_id
      method: generated
      generated: '2026-09-26'