# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Vault Manager Sync API
  version: 1.0.0
extends: openapi/acronis-sync-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: 19
- target: $.paths['/sync/archives'].get
  update:
    x-apievangelist-phrasing:
      intent: Get archive sync state for an agent
      effect: read
      questions:
      - How do I find which archives an agent still needs to sync to the Vault Manager?
      - Can I fetch only archives changed after a given update sequence number?
      instructions:
      - text: Fetch archive sync info for agent {agentId}, {limit} at a time.
        slots:
          agentId: query.agentId
          limit: query.limit
      - text: Show archive sync records with source USN greater than {sourceUsnGt}, limit {limit}.
        slots:
          sourceUsnGt: query.sourceUsnGt
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/archives'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync a batch of archives to the vault database
      effect: write
      questions:
      - Can I add and remove many archive records in one sync call?
      - What does full resync mode do when syncing archives?
      instructions:
      - text: 'Sync this batch of archives: add {add} and delete {delete}.'
        slots:
          add: requestBody.add
          delete: requestBody.delete
      - text: Run a full archive resync with {add}, marking it as the last batch.
        slots:
          add: requestBody.add
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/backups'].get
  update:
    x-apievangelist-phrasing:
      intent: Get backup sync state for an agent
      effect: read
      questions:
      - Which backups has an agent synced, and which changed since my last USN?
      - Can I page backup sync records in USN order?
      instructions:
      - text: Fetch backup sync info for agent {agentId}, limit {limit}.
        slots:
          agentId: query.agentId
          limit: query.limit
      - text: List backup sync records newer than USN {sourceUsnGt}, {limit} per page.
        slots:
          sourceUsnGt: query.sourceUsnGt
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/backups'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync a batch of backups to the vault database
      effect: write
      questions:
      - How do I push new, patched and deleted backup records in one sync batch?
      - Can a backup sync batch be scoped to one vault and archive?
      instructions:
      - text: 'Sync backups for archive {archive_id} in vault {vault_id}: add {add}.'
        slots:
          archive_id: requestBody.archive_id
          vault_id: requestBody.vault_id
          add: requestBody.add
      - text: Patch backup records {patch} and delete {delete} in the sync store.
        slots:
          patch: requestBody.patch
          delete: requestBody.delete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults'].get
  update:
    x-apievangelist-phrasing:
      intent: Get vault sync state
      effect: read
      questions:
      - Which vaults does a managing agent have registered in the Vault Manager?
      - Can I list vault sync records changed since a given USN?
      instructions:
      - text: Fetch vault sync info for managing agent {managingAgentId}.
        slots:
          managingAgentId: query.managingAgentId
      - text: List vaults with source USN above {sourceUsnGt}.
        slots:
          sourceUsnGt: query.sourceUsnGt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a batch of vaults
      effect: write
      questions:
      - Can I register several vaults with the Vault Manager in one request?
      - Is there a bulk call for adding vaults during sync?
      instructions:
      - text: Add this batch of vaults to the Vault Manager.
      - text: Bulk-register the new vaults in one sync call.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Register or update a single vault
      effect: write
      questions:
      - How do I register one vault or update its configuration?
      - Can I set a vault's status and bound agents when registering it?
      instructions:
      - text: Register vault {vaultID} with configuration {config}.
        slots:
          vaultID: path.vaultID
          config: requestBody.config
      - text: Update vault {vaultID} status to {status}.
        slots:
          vaultID: path.vaultID
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Mark a vault as deleted
      effect: destructive
      questions:
      - How do I remove a vault from the Vault Manager without destroying its data?
      - Can I soft-delete a vault for just one tenant?
      instructions:
      - text: Soft-delete vault {vaultID}.
        slots:
          vaultID: path.vaultID
      - text: Mark vault {vaultID} as deleted for tenant {tenantID}.
        slots:
          vaultID: path.vaultID
          tenantID: query.tenantID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}/agents'].post
  update:
    x-apievangelist-phrasing:
      intent: Bind agents to a vault
      effect: write
      questions:
      - How do I attach backup agents to a vault?
      - Can several agents be bound to the same vault?
      instructions:
      - text: Bind agents {agent_ids} to vault {vaultID}.
        slots:
          agent_ids: requestBody.agent_ids
          vaultID: path.vaultID
      - text: Give agents {agent_ids} access to vault {vaultID}.
        slots:
          agent_ids: requestBody.agent_ids
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}/index_catalog_status'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a vault's index catalog status
      effect: write
      questions:
      - How do I record the result of cataloging a vault's index?
      - Can the vault's catalog indexing outcome be updated after it runs?
      instructions:
      - text: Set the index catalog result for vault {vaultID} to {catalog_index_result}.
        slots:
          vaultID: path.vaultID
          catalog_index_result: requestBody.catalog_index_result
      - text: Update vault {vaultID}'s catalog status.
        slots:
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}/stats'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a vault's storage statistics
      effect: write
      questions:
      - How do I update a vault's free space and backup counts?
      - Can I report deduplication and immutable storage size for a vault?
      instructions:
      - text: 'Update vault {vaultID} stats: {backup_count} backups and {free_space} free space.'
        slots:
          vaultID: path.vaultID
          backup_count: requestBody.backup_count
          free_space: requestBody.free_space
      - text: Set vault {vaultID}'s occupied size to {occupied_data_size}.
        slots:
          vaultID: path.vaultID
          occupied_data_size: requestBody.occupied_data_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}/archives/{archiveID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add an archive record to a vault
      effect: write
      questions:
      - How do I register a new backup archive inside a vault?
      - What fields are required when adding an archive, like format and file name?
      instructions:
      - text: Add archive {archiveID} named {name} to vault {vaultID} with file {file_name}, format {format}, created {created}.
        slots:
          archiveID: path.archiveID
          name: requestBody.name
          vaultID: path.vaultID
          file_name: requestBody.file_name
          format: requestBody.format
          created: requestBody.created
      - text: Create archive record {archiveID} in vault {vaultID}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}/archives/{archiveID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Mark an archive as deleted
      effect: destructive
      questions:
      - How do I mark an archive in a vault as deleted in the Vault Manager?
      - Can I record when an archive was last seen while soft-deleting it?
      instructions:
      - text: Soft-delete archive {archiveID} in vault {vaultID}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Mark archive {archiveID} of vault {vaultID} deleted, last seen at {last_seen_at}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
          last_seen_at: query.last_seen_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}/archives/{archiveID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing archive record
      effect: write
      questions:
      - How do I change the size or display name of an archive already in a vault?
      - Can I flag an existing archive as containing malware or forensic data?
      instructions:
      - text: Update archive {archiveID} in vault {vaultID} to size {size}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
          size: requestBody.size
      - text: Rename existing archive {archiveID} in vault {vaultID} to display name {display_name}.
        slots:
          archiveID: path.archiveID
          vaultID: path.vaultID
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a backup to a vault archive
      effect: write
      questions:
      - How do I record a new backup point inside an archive?
      - What backup type must I specify when adding a backup to an archive?
      instructions:
      - text: Add backup {backupID} of type {type} to archive {archiveID} in vault {vaultID}.
        slots:
          backupID: path.backupID
          type: requestBody.type
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Register new backup {backupID} under archive {archiveID}, vault {vaultID}, created {created}.
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
          created: requestBody.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Mark a backup as deleted
      effect: destructive
      questions:
      - How do I mark a single backup in an archive as deleted?
      - Can a backup soft-delete be tagged with a change tag?
      instructions:
      - text: Soft-delete backup {backupID} in archive {archiveID}, vault {vaultID}.
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      - text: Mark backup {backupID} of archive {archiveID} in {vaultID} deleted with change tag {changeTag}.
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
          changeTag: query.changeTag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/vaults/{vaultID}/archives/{archiveID}/backups/{backupID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing backup record
      effect: write
      questions:
      - How do I update a backup's malware scan result after it is stored?
      - Can I change the validation status of an existing backup?
      instructions:
      - text: Update backup {backupID} in archive {archiveID}, vault {vaultID}, setting malware result {malware_assessment_result}.
        slots:
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
          malware_assessment_result: requestBody.malware_assessment_result
      - text: Set validation status {validation_status} on existing backup {backupID} of archive {archiveID} in {vaultID}.
        slots:
          validation_status: requestBody.validation_status
          backupID: path.backupID
          archiveID: path.archiveID
          vaultID: path.vaultID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/agents/{agentID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent from vault sync
      effect: destructive
      questions:
      - How do I remove an agent's record from the Vault Manager sync service?
      - Can I drop a decommissioned agent from vault sync?
      instructions:
      - text: Delete agent {agentID} from the sync service.
        slots:
          agentID: path.agentID
      - text: Remove sync agent {agentID}.
        slots:
          agentID: path.agentID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync/storage_nodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an on-premises storage node
      effect: write
      questions:
      - How do I register a storage node in an on-premises deployment?
      - Can I attach vaults when registering a new storage node?
      instructions:
      - text: Register a storage node with configuration {config}.
        slots:
          config: requestBody.config
      - text: Add storage node {config} with vaults {vaults}.
        slots:
          config: requestBody.config
          vaults: requestBody.vaults
      method: generated
      generated: '2026-09-26'