Acronis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Resource and Policy Management Resource Management API

9 actions 9 updates phrasing extends openapi/acronis-resource-management-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 9

$.info
$.paths['/resource_management/v4/resources'].get
$.paths['/resource_management/v4/resources'].post
$.paths['/resource_management/v4/resources'].delete
$.paths['/resource_management/v4/resources/batch'].post
$.paths['/resource_management/v4/resources/count'].get
$.paths['/resource_management/v4/resources/{resource_internal_or_external_id}'].get
$.paths['/resource_management/v4/resources/{resource_internal_or_external_id}/attributes'].get
$.paths['/resource_management/v4/resource_statuses'].get

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 Resource and Policy Management Resource Management API
  version: 1.0.0
extends: openapi/acronis-resource-management-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: 8
- target: $.paths['/resource_management/v4/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List protected resources
      effect: read
      questions:
      - How do I list all the machines and workloads registered as resources?
      - Can I list only resources that have no protection policy applied?
      - Which resources are members of a specific group?
      instructions:
      - text: List resources in tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      - text: List resources of type {type} matching {search}.
        slots:
          type: query.type
          search: query.search
      - text: List resources applied to policy {applied_to_policy_id}.
        slots:
          applied_to_policy_id: query.applied_to_policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resource_management/v4/resources'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new resource
      effect: write
      questions:
      - How do I register a new resource or group for protection?
      - What fields are required to create a resource?
      instructions:
      - text: Create resource {name} of type {type} with CTI {cti} under groups {parent_group_ids}.
        slots:
          name: requestBody.name
          type: requestBody.type
          cti: requestBody.cti
          parent_group_ids: requestBody.parent_group_ids
      - text: Register {name} ({type}, CTI {cti}) in groups {parent_group_ids} for agent {agent_id}.
        slots:
          name: requestBody.name
          type: requestBody.type
          cti: requestBody.cti
          parent_group_ids: requestBody.parent_group_ids
          agent_id: requestBody.agent_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resource_management/v4/resources'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete resources
      effect: destructive
      questions:
      - How do I remove resources that an agent no longer reports?
      - Can I delete all resources carrying a certain tag?
      instructions:
      - text: Delete resource {resource_id}.
        slots:
          resource_id: query.resource_id
      - text: Delete all resources for agent {agent_id}.
        slots:
          agent_id: query.agent_id
      - text: Delete resources tagged {resource_tag}.
        slots:
          resource_tag: query.resource_tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resource_management/v4/resources/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit many resources from one agent
      effect: write
      questions:
      - Can an agent report many resources in a single batch request?
      - How do I bulk-upload resources discovered by one agent?
      instructions:
      - text: Submit this agent's discovered resources as one batch.
      - text: Bulk-register the resources collected by this agent.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resource_management/v4/resources/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count resources matching filters
      effect: read
      questions:
      - How many resources are registered in a tenant?
      - What number of resources have no policy applied yet?
      instructions:
      - text: Count resources in tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      - text: Count resources of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resource_management/v4/resources/{resource_internal_or_external_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one resource
      effect: read
      questions:
      - How do I look up a resource by its internal or external ID?
      - Can I see a resource's links and issues?
      instructions:
      - text: Show resource {resource_internal_or_external_id}.
        slots:
          resource_internal_or_external_id: path.resource_internal_or_external_id
      - text: Get resource {resource_internal_or_external_id} with its attributes.
        slots:
          resource_internal_or_external_id: path.resource_internal_or_external_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resource_management/v4/resources/{resource_internal_or_external_id}/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a resource's attributes
      effect: read
      questions:
      - What attributes are stored for a resource across all namespaces?
      - How do I read every attribute recorded on a machine resource?
      instructions:
      - text: List all attributes of resource {resource_internal_or_external_id}.
        slots:
          resource_internal_or_external_id: path.resource_internal_or_external_id
      - text: Show attribute namespaces and values for {resource_internal_or_external_id}.
        slots:
          resource_internal_or_external_id: path.resource_internal_or_external_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resource_management/v4/resource_statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: Check resources' protection status
      effect: read
      questions:
      - Which of my resources are protected and which are not?
      - Can I check protection status for resources in one group?
      instructions:
      - text: Show protection status for resources in tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      - text: Get protection status of resource {resource_id}.
        slots:
          resource_id: query.resource_id
      - text: Show protection status for members of group {parent_id}.
        slots:
          parent_id: query.parent_id
      method: generated
      generated: '2026-09-26'