API Evangelist conversational phrasing for MOVEit Transfer REST Folders API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for MOVEit Transfer REST Folders API
  version: 1.0.0
extends: openapi/progress-software-folders-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: 16
- target: $.paths['/api/v1/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List folders I can view
      effect: read
      questions:
      - Which MOVEit folders do I have access to?
      - Can I search the folders I can see by name or path?
      instructions:
      - text: List folders I can view named {name}.
        slots:
          name: query.name
      - text: List folders under path {path}, sorted by {sortField}.
        slots:
          path: query.path
          sortField: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get folder details
      effect: read
      questions:
      - What are the settings and size of a specific folder?
      - Can I skip file counts to get folder details faster?
      instructions:
      - text: Show details of folder {Id}.
        slots:
          Id: path.Id
      - text: Get folder {Id} details without file counts.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a folder
      effect: destructive
      questions:
      - How do I delete an entire folder?
      - Is a deleted folder recoverable?
      instructions:
      - text: Delete folder {Id}.
        slots:
          Id: path.Id
      - text: Remove the folder {Id} and its contents.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or describe a folder
      effect: write
      questions:
      - How can I rename a folder or change its description?
      - Can I turn access inheritance on or off for a folder?
      instructions:
      - text: Rename folder {Id} to {name}.
        slots:
          Id: path.Id
          name: requestBody.name
      - text: Set the description of folder {Id} to {description}.
        slots:
          Id: path.Id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/acls'].get
  update:
    x-apievangelist-phrasing:
      intent: List a folder's access controls
      effect: read
      questions:
      - Who has permissions on a particular folder?
      - Can I page through a folder's access control entries?
      instructions:
      - text: List access controls on folder {Id}.
        slots:
          Id: path.Id
      - text: Show page {page} of folder {Id}'s permission entries.
        slots:
          page: query.page
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/acls'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a folder access control entry
      effect: write
      questions:
      - Can I change permissions on a folder and override inherited behaviour?
      - What's the way to replace a group's access on a folder?
      instructions:
      - text: Change folder {Id} access for {type} {id} to {permissions}.
        slots:
          Id: path.Id
          type: requestBody.type
          id: requestBody.id
          permissions: requestBody.permissions
      - text: Update folder {Id} permissions using override behaviour {overrideBehaviourType}.
        slots:
          Id: path.Id
          overrideBehaviourType: requestBody.overrideBehaviourType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/acls'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant access to a folder
      effect: write
      questions:
      - How do I give a user or group access to a folder?
      - Can I send a notification message when granting folder access?
      instructions:
      - text: Grant {type} {id} permissions {permissions} on folder {Id}.
        slots:
          type: requestBody.type
          id: requestBody.id
          permissions: requestBody.permissions
          Id: path.Id
      - text: Add access to folder {Id} for user {id} and notify them with {notificationMessage}.
        slots:
          Id: path.Id
          id: requestBody.id
          notificationMessage: requestBody.notificationMessage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/acls'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke access to a folder
      effect: destructive
      questions:
      - How do I remove someone's access to a folder?
      - Can I revoke a group's folder permissions entirely?
      instructions:
      - text: Revoke {type} {id}'s access to folder {Id}.
        slots:
          type: requestBody.type
          id: requestBody.id
          Id: path.Id
      - text: Remove all permissions of user {id} on folder {Id}.
        slots:
          id: requestBody.id
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a folder into another folder
      effect: write
      questions:
      - Can I duplicate a folder into a different parent folder?
      - How do I copy a folder somewhere else?
      instructions:
      - text: Copy folder {Id} into folder {destinationFolderId}.
        slots:
          Id: path.Id
          destinationFolderId: requestBody.destinationFolderId
      - text: Make a copy of folder {Id} under {destinationFolderId}.
        slots:
          Id: path.Id
          destinationFolderId: requestBody.destinationFolderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/move'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a folder into another folder
      effect: write
      questions:
      - How do I relocate a folder under a new parent?
      - Can a folder be moved rather than copied?
      instructions:
      - text: Move folder {Id} into folder {destinationFolderId}.
        slots:
          Id: path.Id
          destinationFolderId: requestBody.destinationFolderId
      - text: Relocate folder {Id} under {destinationFolderId}.
        slots:
          Id: path.Id
          destinationFolderId: requestBody.destinationFolderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/filemasks'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set allowed file types for a folder
      effect: write
      questions:
      - Can I restrict a folder to only accept certain file extensions?
      - How do I block file types like .exe from being uploaded to a folder?
      instructions:
      - text: Set folder {Id} file masks to {masks} with rule {rule}.
        slots:
          Id: path.Id
          masks: requestBody.masks
          rule: requestBody.rule
      - text: Only allow {masks} files in folder {Id} and its subfolders.
        slots:
          masks: requestBody.masks
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/maintenance'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change folder cleanup and quota settings
      effect: write
      questions:
      - Can I set a quota on a folder?
      - How long are new files flagged as new, and can I change folder cleanup rules?
      instructions:
      - text: Set folder {Id} quota to {folderQuota}.
        slots:
          Id: path.Id
          folderQuota: requestBody.folderQuota
      - text: Show new files in folder {Id} for {displayNewFilesForDays} days.
        slots:
          Id: path.Id
          displayNewFilesForDays: requestBody.displayNewFilesForDays
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/miscellaneous'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change folder file handling options
      effect: write
      questions:
      - Can I stop files in a folder from being overwritten?
      - Is it possible to enforce unique filenames or turn on thumbnails for a folder?
      instructions:
      - text: Turn off file overwrite in folder {Id}.
        slots:
          Id: path.Id
      - text: Set enforce unique filenames to {enforceUniqueFilenames} for folder {Id}.
        slots:
          enforceUniqueFilenames: requestBody.enforceUniqueFilenames
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/notifications'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change folder upload notifications
      effect: write
      questions:
      - Can senders get a delivery receipt when files in a folder are downloaded?
      - How do I alert a sender if their file hasn't been downloaded?
      instructions:
      - text: Enable delivery receipts to senders for folder {Id}.
        slots:
          Id: path.Id
      - text: Set folder {Id} notification style to {notificationStyle}.
        slots:
          Id: path.Id
          notificationStyle: requestBody.notificationStyle
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/acls/{entryId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change one access entry on a folder
      effect: write
      questions:
      - Can I edit a single user's permissions entry on a folder?
      - How do I tweak one existing access control entry without replacing the others?
      instructions:
      - text: Set permissions {permissions} on entry {entryId} of folder {Id}.
        slots:
          permissions: requestBody.permissions
          entryId: path.entryId
          Id: path.Id
      - text: Update access entry {entryId} in folder {Id}.
        slots:
          entryId: path.entryId
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/characterRestrictions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set filename character restrictions
      effect: write
      questions:
      - Can I block certain characters in file and folder names?
      - How do illegal characters get replaced on upload?
      instructions:
      - text: Replace illegal characters in folder {Id} names with {replacementValue}.
        slots:
          Id: path.Id
          replacementValue: requestBody.replacementValue
      - text: Restrict folder {Id} names to the character set {charSet}.
        slots:
          Id: path.Id
          charSet: requestBody.charSet
      method: generated
      generated: '2026-10-01'