Acronis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for File Sync & Share Sync And Share Nodes API

22 actions 22 updates phrasing extends openapi/acronis-sync-and-share-nodes-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 22 · first 16 shown; the file carries all of them

$.info
$.paths['/sync_and_share_nodes'].post
$.paths['/sync_and_share_nodes/{node_uuid}'].get
$.paths['/sync_and_share_nodes/{node_uuid}'].put
$.paths['/sync_and_share_nodes/{node_uuid}'].delete
$.paths['/sync_and_share_nodes/{node_uuid}/contents'].get
$.paths['/sync_and_share_nodes/{node_uuid}/revisions'].get
$.paths['/sync_and_share_nodes/{node_uuid}/revisions/{revision_number}'].post
$.paths['/sync_and_share_nodes/{node_uuid}/download'].get
$.paths['/sync_and_share_nodes/{node_uuid}/upload'].post
$.paths['/sync_and_share_nodes/{node_uuid}/copy'].post
$.paths['/sync_and_share_nodes/{node_uuid}/move'].post
$.paths['/sync_and_share_nodes/{node_uuid}/links'].post
$.paths['/sync_and_share_nodes/{node_uuid}/links/{link_id}'].put
$.paths['/sync_and_share_nodes/{node_uuid}/members'].get
$.paths['/sync_and_share_nodes/{node_uuid}/members'].post

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 File Sync & Share Sync And Share Nodes API
  version: 1.0.0
extends: openapi/acronis-sync-and-share-nodes-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: 21
- target: $.paths['/sync_and_share_nodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Sync & Share folder
      effect: write
      questions:
      - How do I create a new folder in Sync & Share by name or path?
      - What happens if a folder with the same name but different capitalization already exists?
      instructions:
      - text: Create the Sync & Share folder {sync_and_share_node}.
        slots:
          sync_and_share_node: requestBody.sync_and_share_node
      - text: Make a new shared folder described by {sync_and_share_node}.
        slots:
          sync_and_share_node: requestBody.sync_and_share_node
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a file or folder
      effect: read
      questions:
      - How do I look up the metadata of a single file or folder?
      - Can I check who owns a shared file and when it was last changed?
      instructions:
      - text: Show details for file or folder {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      - text: Get the metadata of Sync & Share item {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or change a file or folder
      effect: write
      questions:
      - How do I rename a file or folder in Sync & Share?
      - Can I change a folder's properties after creating it?
      instructions:
      - text: Update file or folder {node_uuid} with {sync_and_share_node}.
        slots:
          node_uuid: path.node_uuid
          sync_and_share_node: requestBody.sync_and_share_node
      - text: Rename item {node_uuid} using {sync_and_share_node}.
        slots:
          node_uuid: path.node_uuid
          sync_and_share_node: requestBody.sync_and_share_node
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file or folder
      effect: destructive
      questions:
      - How do I delete a file or folder from Sync & Share?
      - Can I remove an entire shared folder in one call?
      instructions:
      - text: Delete file or folder {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      - text: Remove the Sync & Share item {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/contents'].get
  update:
    x-apievangelist-phrasing:
      intent: List what's inside a folder
      effect: read
      questions:
      - What files and subfolders are inside a given folder?
      - Can I page through a large folder's contents?
      instructions:
      - text: List the contents of folder {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      - text: Show page {page} of folder {node_uuid}'s contents, {per_page} per page.
        slots:
          page: query.page
          node_uuid: path.node_uuid
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/revisions'].get
  update:
    x-apievangelist-phrasing:
      intent: List revisions of a file or folder
      effect: read
      questions:
      - What earlier versions of a file are available?
      - How do I see the revision history of a shared folder?
      instructions:
      - text: List all revisions of {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      - text: Show the version history for file {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/revisions/{revision_number}'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an earlier file revision
      effect: write
      questions:
      - How do I roll a file back to a previous version?
      - Does restoring an old revision overwrite the history or add a new version?
      instructions:
      - text: Restore revision {revision_number} of file {node_uuid}.
        slots:
          revision_number: path.revision_number
          node_uuid: path.node_uuid
      - text: Roll file {node_uuid} back to version {revision_number}.
        slots:
          node_uuid: path.node_uuid
          revision_number: path.revision_number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file or folder
      effect: read
      questions:
      - How do I download a file from Sync & Share?
      - Can I download a whole folder at once, and in what format?
      instructions:
      - text: Download file {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      - text: Download folder {node_uuid} as a ZIP archive.
        slots:
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to a folder
      effect: write
      questions:
      - How do I upload a file into a Sync & Share folder?
      - What happens if I upload a file whose name already exists in the folder?
      - Can I send a checksum with an upload to verify it?
      instructions:
      - text: Upload {filename} ({size} bytes) into folder {node_uuid}.
        slots:
          filename: query.filename
          size: query.size
          node_uuid: path.node_uuid
      - text: Upload {filename} of size {size} to folder {node_uuid} with checksum {checksum}.
        slots:
          filename: query.filename
          size: query.size
          node_uuid: path.node_uuid
          checksum: query.checksum
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a file or folder
      effect: write
      questions:
      - How do I duplicate a file into another folder?
      - Can I copy a whole folder to a new location?
      instructions:
      - text: Copy {node_uuid} into folder {parent_uuid}.
        slots:
          node_uuid: path.node_uuid
          parent_uuid: requestBody.parent_uuid
      - text: Duplicate item {node_uuid} under {parent_uuid}.
        slots:
          node_uuid: path.node_uuid
          parent_uuid: requestBody.parent_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/move'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a file or folder
      effect: write
      questions:
      - How do I move a file to a different folder?
      - Can I relocate a folder without copying it?
      instructions:
      - text: Move {node_uuid} into folder {parent_uuid}.
        slots:
          node_uuid: path.node_uuid
          parent_uuid: requestBody.parent_uuid
      - text: Relocate item {node_uuid} to parent {parent_uuid}.
        slots:
          node_uuid: path.node_uuid
          parent_uuid: requestBody.parent_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shareable file link
      effect: write
      questions:
      - How do I create a link to share a file with someone?
      - Can I email a file link to several people at once?
      instructions:
      - text: Create a share link for file {node_uuid} with settings {link}.
        slots:
          node_uuid: path.node_uuid
          link: requestBody.link
      - text: Share file {node_uuid} by link and email it as defined in {link}.
        slots:
          node_uuid: path.node_uuid
          link: requestBody.link
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/links/{link_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing file link
      effect: write
      questions:
      - How do I change when a shared file link expires?
      - Can I make an existing link single-use or restrict who can open it?
      instructions:
      - text: Set link {link_id} on file {node_uuid} to expire after {ttl}.
        slots:
          link_id: path.link_id
          node_uuid: path.node_uuid
          ttl: requestBody.ttl
      - text: 'Make link {link_id} on file {node_uuid} single-use: {single_use}.'
        slots:
          link_id: path.link_id
          node_uuid: path.node_uuid
          single_use: requestBody.single_use
      - text: Restrict access to link {link_id} of {node_uuid} with {access_restriction}.
        slots:
          link_id: path.link_id
          node_uuid: path.node_uuid
          access_restriction: requestBody.access_restriction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List a folder's members
      effect: read
      questions:
      - Who has access to a shared folder?
      - Can I page through the member list of a big shared folder?
      instructions:
      - text: List members of folder {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      - text: Show page {page} of folder {node_uuid}'s members.
        slots:
          page: query.page
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a member to a folder
      effect: write
      questions:
      - How do I invite someone to a shared folder?
      - Can I give a new person access to a folder I own?
      instructions:
      - text: Add member {member} to folder {node_uuid}.
        slots:
          member: requestBody.member
          node_uuid: path.node_uuid
      - text: Invite {member} to collaborate on folder {node_uuid}.
        slots:
          member: requestBody.member
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/members'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove every member from a folder
      effect: destructive
      questions:
      - How do I stop sharing a folder with everyone at once?
      - Can I revoke all members' access to a folder in one step?
      instructions:
      - text: Remove all members from folder {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      - text: Unshare folder {node_uuid} from every member.
        slots:
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/members/{member_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one folder member's details
      effect: read
      questions:
      - What permissions does a particular member have on a folder?
      - How do I look up one collaborator on a shared folder?
      instructions:
      - text: Show member {member_id} of folder {node_uuid}.
        slots:
          member_id: path.member_id
          node_uuid: path.node_uuid
      - text: Get the access details of member {member_id} on {node_uuid}.
        slots:
          member_id: path.member_id
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/members/{member_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a folder member's access
      effect: write
      questions:
      - How do I change a collaborator's permissions on a folder?
      - Can I downgrade a member from editor to viewer?
      instructions:
      - text: Update member {member_id} on folder {node_uuid} with {member}.
        slots:
          member_id: path.member_id
          node_uuid: path.node_uuid
          member: requestBody.member
      - text: Change the access of member {member_id} in {node_uuid} to {member}.
        slots:
          member_id: path.member_id
          node_uuid: path.node_uuid
          member: requestBody.member
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/members/{member_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one member from a folder
      effect: destructive
      questions:
      - How do I remove one person from a shared folder?
      - Can I revoke a single collaborator's access without affecting others?
      instructions:
      - text: Remove member {member_id} from folder {node_uuid}.
        slots:
          member_id: path.member_id
          node_uuid: path.node_uuid
      - text: Revoke member {member_id}'s access to {node_uuid}.
        slots:
          member_id: path.member_id
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/sync_status'].post
  update:
    x-apievangelist-phrasing:
      intent: Start syncing a folder to desktop
      effect: write
      questions:
      - How do I start syncing a folder to my desktop client?
      - Can I turn on desktop sync for a shared folder through the API?
      instructions:
      - text: Start syncing folder {node_uuid} to the desktop client.
        slots:
          node_uuid: path.node_uuid
      - text: Turn on desktop sync for {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync_and_share_nodes/{node_uuid}/sync_status'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop syncing a folder to desktop
      effect: destructive
      questions:
      - How do I stop a folder syncing to the desktop client?
      - Can I turn off desktop sync without deleting the folder?
      instructions:
      - text: Stop syncing folder {node_uuid} to the desktop client.
        slots:
          node_uuid: path.node_uuid
      - text: Turn off desktop sync for {node_uuid}.
        slots:
          node_uuid: path.node_uuid
      method: generated
      generated: '2026-09-26'