Acronis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Resource Policy Management API

29 actions 29 updates phrasing extends openapi/acronis-policy-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 29 · first 16 shown; the file carries all of them

$.info
$.paths['/policy_management/v4/policies'].get
$.paths['/policy_management/v4/policies'].post
$.paths['/policy_management/v4/policies'].delete
$.paths['/policy_management/v4/policies/favorite'].patch
$.paths['/policy_management/v4/policies/{policy_id}'].get
$.paths['/policy_management/v4/policies/{policy_id}'].delete
$.paths['/policy_management/v4/policies/{policy_id}'].patch
$.paths['/policy_management/v4/drafts'].post
$.paths['/policy_management/v4/drafts/{draft_id}'].get
$.paths['/policy_management/v4/drafts/{draft_id}'].delete
$.paths['/policy_management/v4/drafts/{draft_id}/state'].put
$.paths['/policy_management/v4/drafts/{draft_id}/name'].put
$.paths['/policy_management/v4/drafts/{draft_id}/context'].put
$.paths['/policy_management/v4/drafts/{draft_id}/enabled_policies'].put
$.paths['/policy_management/v4/drafts/{draft_id}/disabled_applications_context'].put

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 Policy Management API
  version: 1.0.0
extends: openapi/acronis-policy-management-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 28
- target: $.paths['/policy_management/v4/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List protection policies
      effect: read
      questions:
      - How do I list all the protection policies in a tenant?
      - Can I find only enabled policies of a certain type?
      - Which policies would apply to a Windows machine?
      instructions:
      - text: List policies for tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      - text: Show enabled policies of type {types}.
        slots:
          types: query.types
      - text: Search policies matching {search} and include their settings.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a protection policy
      effect: write
      questions:
      - How do I create a new protection policy?
      - Can I import an exported policy into a different tenant?
      instructions:
      - text: Create a policy from {subject}.
        slots:
          subject: requestBody.subject
      - text: Import policy {subject} into tenant {override_tenant_id} as a new one.
        slots:
          subject: requestBody.subject
          override_tenant_id: requestBody.override_tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/policies'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several policies at once
      effect: destructive
      questions:
      - Can I bulk-delete policies by ID?
      - Is there a way to delete every policy in a tenant?
      instructions:
      - text: Delete policies {policy_id}.
        slots:
          policy_id: query.policy_id
      - text: Remove all policies in tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/policies/favorite'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reorder favorite policies
      effect: write
      questions:
      - Can I change the order of my favorite policies?
      - Where do I update favorite properties for several policies at once?
      instructions:
      - text: Reorder my favorite policies.
      - text: Update the favorite order and properties of my policies.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/policies/{policy_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single policy
      effect: read
      questions:
      - How do I view a policy's settings by its ID?
      - Can I see where a single policy is applied?
      instructions:
      - text: Show policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Get policy {policy_id} with settings and applied context.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/policies/{policy_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one policy
      effect: destructive
      questions:
      - How do I delete a single protection policy?
      - Can I remove one policy by its ID?
      instructions:
      - text: Delete policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Remove the policy with ID {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/policies/{policy_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a policy
      effect: write
      questions:
      - How do I change the settings of an existing policy?
      - Can I mark a policy as the default or a favorite?
      instructions:
      - text: Update policy {policy_id} with {subject}.
        slots:
          policy_id: path.policy_id
          subject: requestBody.subject
      - text: Set policy {policy_id} as the default policy.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/drafts'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a policy draft
      effect: write
      questions:
      - How do I start a draft so I can edit a policy composite before committing it?
      - Can I open a draft for a brand-new policy rather than editing an existing one?
      instructions:
      - text: Open a new policy draft from {new}.
        slots:
          new: requestBody.new
      - text: Start a draft to edit the existing policy described in {edit}.
        slots:
          edit: requestBody.edit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a policy draft
      effect: read
      questions:
      - What does my uncommitted policy draft currently contain?
      - Can I review a draft's policies before committing it?
      instructions:
      - text: Show policy draft {draft_id}.
        slots:
          draft_id: path.draft_id
      - text: Get the current contents of draft {draft_id} before I commit it.
        slots:
          draft_id: path.draft_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Discard a policy draft
      effect: destructive
      questions:
      - How do I throw away a policy draft without saving any of its changes?
      - Is there a way to delete an abandoned draft outright?
      instructions:
      - text: Delete policy draft {draft_id}.
        slots:
          draft_id: path.draft_id
      - text: Discard draft {draft_id} and all its unsaved edits.
        slots:
          draft_id: path.draft_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/state'].put
  update:
    x-apievangelist-phrasing:
      intent: Commit or cancel a policy draft
      effect: write
      questions:
      - How do I commit a policy draft so its changes take effect?
      - Can I save a draft as a template or as a temporary policy when committing it?
      - What happens to conflicting applications when I commit a draft?
      instructions:
      - text: Set draft {draft_id} state to {value}.
        slots:
          draft_id: path.draft_id
          value: requestBody.value
      - text: Commit draft {draft_id} as a template.
        slots:
          draft_id: path.draft_id
      - text: Commit draft {draft_id} as a temporary policy that expires after {ttl} seconds.
        slots:
          draft_id: path.draft_id
          ttl: requestBody.ttl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/name'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a policy draft
      effect: write
      questions:
      - How do I change the name of the whole draft composite?
      - Can I set the draft's name before I commit it?
      instructions:
      - text: Rename draft {draft_id} to {value}.
        slots:
          draft_id: path.draft_id
          value: requestBody.value
      - text: Name the policy draft {draft_id} as {value}.
        slots:
          draft_id: path.draft_id
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/context'].put
  update:
    x-apievangelist-phrasing:
      intent: Set which resources a draft applies to
      effect: write
      questions:
      - How do I choose the machines a policy draft will be applied to?
      - Can changing a draft's resource selection affect other policies in it?
      instructions:
      - text: Set the resource context of draft {draft_id} to {value}.
        slots:
          draft_id: path.draft_id
          value: requestBody.value
      - text: Target draft {draft_id} at the resources in {value}.
        slots:
          draft_id: path.draft_id
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/enabled_policies'].put
  update:
    x-apievangelist-phrasing:
      intent: Choose which policies are enabled in a draft
      effect: write
      questions:
      - How do I switch on a set of sub-policies inside a draft at once?
      - Can I replace the list of enabled policies in a draft composite?
      instructions:
      - text: Enable policies {items} in draft {draft_id}.
        slots:
          draft_id: path.draft_id
          items: requestBody.items
      - text: Replace the enabled policy list of draft {draft_id} with {items}.
        slots:
          draft_id: path.draft_id
          items: requestBody.items
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/disabled_applications_context'].put
  update:
    x-apievangelist-phrasing:
      intent: Set resources where a draft's policy is disabled
      effect: write
      questions:
      - How do I exclude certain resources from a policy draft's applications?
      - Can I mark resources where the draft's policy should stay disabled?
      instructions:
      - text: Disable draft {draft_id}'s applications on resources {value}.
        slots:
          draft_id: path.draft_id
          value: requestBody.value
      - text: Set the disabled-applications context of draft {draft_id} to {value}.
        slots:
          draft_id: path.draft_id
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a policy to a draft composite
      effect: write
      questions:
      - How do I add a new sub-policy into a draft composite?
      - Does adding a policy to a draft change linked downstream policies?
      instructions:
      - text: Add a policy of type {type} to draft {draft_id}.
        slots:
          draft_id: path.draft_id
          type: requestBody.type
      - text: Add an enabled {type} policy from origin {origin} to draft {draft_id}.
        slots:
          draft_id: path.draft_id
          type: requestBody.type
          origin: requestBody.origin
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/policies/{policy_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a policy from a draft
      effect: destructive
      questions:
      - How do I take one sub-policy out of a draft composite?
      - Can I drop a policy from a draft without touching the live policy?
      instructions:
      - text: Remove policy {policy_id} from draft {draft_id}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
      - text: Drop sub-policy {policy_id} out of draft {draft_id}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/policies/{policy_id}/enabled'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a policy in a draft
      effect: write
      questions:
      - How do I turn off one sub-policy inside a draft?
      - Can I re-enable a single policy within a draft composite?
      instructions:
      - text: Set enabled to {value} for policy {policy_id} in draft {draft_id}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
          value: requestBody.value
      - text: Disable sub-policy {policy_id} in draft {draft_id}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/policies/{policy_id}/name'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a policy inside a draft
      effect: write
      questions:
      - How do I rename one sub-policy within a draft composite?
      - Can I give a single drafted policy its own name?
      instructions:
      - text: Rename policy {policy_id} in draft {draft_id} to {value}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
          value: requestBody.value
      - text: Call sub-policy {policy_id} of draft {draft_id} {value}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/policies/{policy_id}/type'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a drafted policy's type
      effect: write
      questions:
      - How do I change the type of a sub-policy in a draft?
      - Can I switch a drafted policy to a different policy scope?
      instructions:
      - text: Change the type of policy {policy_id} in draft {draft_id} to {value}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
          value: requestBody.value
      - text: Set drafted policy {policy_id} in {draft_id} to type {value}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/policies/{policy_id}/comment'].put
  update:
    x-apievangelist-phrasing:
      intent: Comment on a policy in a draft
      effect: write
      questions:
      - How do I add a note to one sub-policy in a draft?
      - Can I replace the comment on a drafted policy?
      instructions:
      - text: Set the comment on policy {policy_id} in draft {draft_id} to {value}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
          value: requestBody.value
      - text: Annotate drafted policy {policy_id} in {draft_id} with {value}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/drafts/{draft_id}/policies/{policy_id}/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Patch a drafted policy's settings
      effect: write
      questions:
      - How do I change the settings of a sub-policy while it is still in a draft?
      - Can I send only some settings fields when patching a drafted policy?
      instructions:
      - text: Patch the settings of policy {policy_id} in draft {draft_id} with {patch}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
          patch: requestBody.patch
      - text: Apply settings changes {patch} to drafted policy {policy_id} in {draft_id}.
        slots:
          draft_id: path.draft_id
          policy_id: path.policy_id
          patch: requestBody.patch
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policy_management/v4/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List where policies are applied
      effect: read
      questions:
      - Which machines is a given policy applied to?
      - Can I find policy applications that have deployment errors?
      - What policies are applied to a specific agent?
      instructions:
      - text: List applications of policy {policy_id}.
        slots:
          policy_id: query.policy_id
      - text: Show policy applications on agent {agent_id}.
        slots:
          agent_id: query.agent_id
      - text: Find policy applications in deployment state {deployment_state}.
        slots:
          deployment_state: query.deployment_state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a policy to resources
      effect: write
      questions:
      - How do I apply a protection policy to a set of machines?
      - Can I skip the precheck when applying a policy?
      instructions:
      - text: Apply policy {policy_id} to {context}.
        slots:
          policy_id: requestBody.policy_id
          context: requestBody.context
      - text: Apply policy {policy_id} and disable it automatically on conflict.
        slots:
          policy_id: requestBody.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/applications'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a policy from resources
      effect: destructive
      questions:
      - How do I remove a policy from the machines it protects?
      - Can I revoke every policy applied to one resource?
      instructions:
      - text: Revoke policy {policy_id} from all its resources.
        slots:
          policy_id: query.policy_id
      - text: Revoke all policy applications on resource {context_id}.
        slots:
          context_id: query.context_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/applications/issues/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get issue statistics for policy applications
      effect: read
      questions:
      - How many issues are my policy applications reporting, by type?
      - Can I see issue counts for one policy's applications?
      instructions:
      - text: Show issue statistics for policy {policy_id}.
        slots:
          policy_id: query.policy_id
      - text: Get application issue stats for resource {context_id}.
        slots:
          context_id: query.context_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/applications/run'].put
  update:
    x-apievangelist-phrasing:
      intent: Run a policy now
      effect: write
      questions:
      - How do I run a backup policy immediately instead of waiting for its schedule?
      - Can I run a policy on only some of the resources it is applied to?
      instructions:
      - text: Run policy {policy_id} now with state {state}.
        slots:
          policy_id: requestBody.policy_id
          state: requestBody.state
      - text: Start policy {policy_id} on resources {context_ids} with state {state}.
        slots:
          policy_id: requestBody.policy_id
          context_ids: requestBody.context_ids
          state: requestBody.state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/policy_management/v4/policy_statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: Get application statuses grouped by policy
      effect: read
      questions:
      - What is the execution status of each policy across my machines?
      - Can I include policies that aren't applied anywhere in the status list?
      instructions:
      - text: Show application statuses grouped by policy for tenant {tenant_id}.
        slots:
          tenant_id: query.tenant_id
      - text: List policy statuses with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'