Acronis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Account Management Reports API

7 actions 7 updates phrasing extends openapi/acronis-reports-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['/reports'].post

$.paths['/reports/{report_id}'].get

$.paths['/reports/{report_id}'].put

$.paths['/reports/{report_id}'].delete

$.paths['/reports/{report_id}/stored'].get

$.paths['/reports/{report_id}/stored/{stored_report_id}'].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 Account Management Reports API
  version: 1.0.0
extends: openapi/acronis-reports-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['/reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a usage report
      effect: write
      questions:
      - How do I set up a scheduled usage report that emails recipients?
      - Can I generate a one-time usage report for a specific date?
      instructions:
      - text: Create a usage report with parameters {parameters}, schedule {schedule}, sent to {recipients} via {result_action}.
        slots:
          parameters: requestBody.parameters
          schedule: requestBody.schedule
          recipients: requestBody.recipients
          result_action: requestBody.result_action
      - text: Schedule a usage report {parameters} on {schedule} emailed to {recipients}, action {result_action}.
        slots:
          parameters: requestBody.parameters
          schedule: requestBody.schedule
          recipients: requestBody.recipients
          result_action: requestBody.result_action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/{report_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a usage report's configuration
      effect: read
      questions:
      - How do I see how a usage report is configured?
      - Who receives a particular usage report?
      instructions:
      - text: Show usage report {report_id}.
        slots:
          report_id: path.report_id
      - text: Get the schedule and recipients of report {report_id}.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/{report_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a scheduled usage report
      effect: write
      questions:
      - How do I change the recipients of a scheduled report?
      - Can I edit a one-time report, or only scheduled ones?
      instructions:
      - text: Change recipients of report {report_id} to {recipients}.
        slots:
          report_id: path.report_id
          recipients: requestBody.recipients
      - text: Update the schedule of report {report_id} to {schedule}.
        slots:
          report_id: path.report_id
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/{report_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a usage report
      effect: destructive
      questions:
      - How do I delete a usage report I no longer need?
      - What version do I pass when deleting a report?
      instructions:
      - text: Delete report {report_id} at version {version}.
        slots:
          report_id: path.report_id
          version: query.version
      - text: Remove usage report {report_id}, version {version}.
        slots:
          report_id: path.report_id
          version: query.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/{report_id}/stored'].get
  update:
    x-apievangelist-phrasing:
      intent: List generated copies of a report
      effect: read
      questions:
      - Which past runs of a usage report are stored?
      - How do I find previously generated outputs of a report?
      instructions:
      - text: List stored outputs of report {report_id}.
        slots:
          report_id: path.report_id
      - text: Show every generated run of usage report {report_id}.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/{report_id}/stored/{stored_report_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a generated report
      effect: read
      questions:
      - How do I download the data of a report that already ran?
      - Can I fetch one stored report file?
      instructions:
      - text: Download stored report {stored_report_id} of report {report_id}.
        slots:
          stored_report_id: path.stored_report_id
          report_id: path.report_id
      - text: Get the data file {stored_report_id} for usage report {report_id}.
        slots:
          stored_report_id: path.stored_report_id
          report_id: path.report_id
      method: generated
      generated: '2026-09-26'