Acronis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Account Management Clients API

6 actions 6 updates phrasing extends openapi/acronis-clients-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 6

$.info
$.paths['/clients'].get
$.paths['/clients'].post
$.paths['/clients/{client_id}'].get
$.paths['/clients/{client_id}'].put
$.paths['/clients/{client_id}'].delete

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 Account Management Clients API
  version: 1.0.0
extends: openapi/acronis-clients-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['/clients'].get
  update:
    x-apievangelist-phrasing:
      intent: List API clients
      effect: read
      questions:
      - Which API clients exist for my tenant?
      - Can I include deleted API clients in the list?
      instructions:
      - text: List API clients {uuids}.
        slots:
          uuids: query.uuids
      - text: List API clients with origin {origin_id}.
        slots:
          origin_id: query.origin_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API client
      effect: write
      questions:
      - How do I create API client credentials for a tenant?
      - Which token endpoint auth methods can a new client use?
      instructions:
      - text: Create a {type} API client in tenant {tenant_id} using {token_endpoint_auth_method}.
        slots:
          type: requestBody.type
          tenant_id: requestBody.tenant_id
          token_endpoint_auth_method: requestBody.token_endpoint_auth_method
      - text: Register an API client for tenant {tenant_id}, type {type}, auth {token_endpoint_auth_method}, redirects {redirect_uris}.
        slots:
          tenant_id: requestBody.tenant_id
          type: requestBody.type
          token_endpoint_auth_method: requestBody.token_endpoint_auth_method
          redirect_uris: requestBody.redirect_uris
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/{client_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API client
      effect: read
      questions:
      - How do I look up one API client by ID?
      - What redirect URIs are set on a client?
      instructions:
      - text: Show API client {client_id}.
        slots:
          client_id: path.client_id
      - text: Get details of client {client_id}.
        slots:
          client_id: path.client_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/{client_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an API client
      effect: write
      questions:
      - How do I disable an API client?
      - Can I change an API client's redirect URIs?
      instructions:
      - text: Set API client {client_id} status to {status}.
        slots:
          client_id: path.client_id
          status: requestBody.status
      - text: Update redirect URIs of client {client_id} to {redirect_uris}.
        slots:
          client_id: path.client_id
          redirect_uris: requestBody.redirect_uris
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/{client_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API client
      effect: destructive
      questions:
      - How do I delete API client credentials?
      - Can I revoke an integration's client entirely?
      instructions:
      - text: Delete API client {client_id}.
        slots:
          client_id: path.client_id
      - text: Remove client {client_id}.
        slots:
          client_id: path.client_id
      method: generated
      generated: '2026-09-26'