Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MOVEit Transfer REST Folder Content API

10 actions 10 updates phrasing extends openapi/progress-software-foldercontent-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Progress Software's API. It is a proposal applied on top of the contract, not a document Progress Software publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v1/folders/{folderId}/files/{fileId}'].get
$.paths['/api/v1/folders/{folderId}/files/{fileId}/download'].get
$.paths['/api/v1/folders/{parentId}/subfolders/{subfolderId}'].get
$.paths['/api/v1/folders/{parentId}/subfolders/{subfolderId}'].delete
$.paths['/api/v1/folders/{Id}/subfolders'].get
$.paths['/api/v1/folders/{Id}/subfolders'].post
$.paths['/api/v1/folders/{Id}/files'].get
$.paths['/api/v1/folders/{Id}/files'].post
$.paths['/api/v1/folders/{Id}/content'].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 MOVEit Transfer REST Folder Content API
  version: 1.0.0
extends: openapi/progress-software-foldercontent-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: 9
- target: $.paths['/api/v1/folders/{folderId}/files/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a file in a folder
      effect: read
      questions:
      - What are the details of a file stored in a folder?
      - Can I check a file's metadata without downloading it?
      instructions:
      - text: Show file {fileId} in folder {folderId}.
        slots:
          fileId: path.fileId
          folderId: path.folderId
      - text: Get metadata for file {fileId} from folder {folderId}.
        slots:
          fileId: path.fileId
          folderId: path.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{folderId}/files/{fileId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file from a folder
      effect: read
      questions:
      - How do I download a file from a folder?
      - Does the download include a SHA1 digest I can verify?
      instructions:
      - text: Download file {fileId} from folder {folderId}.
        slots:
          fileId: path.fileId
          folderId: path.folderId
      - text: Fetch the contents of file {fileId} in folder {folderId}.
        slots:
          fileId: path.fileId
          folderId: path.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{parentId}/subfolders/{subfolderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get subfolder details
      effect: read
      questions:
      - What are the details of a subfolder inside a parent folder?
      - Can I look up a subfolder through its parent?
      instructions:
      - text: Show subfolder {subfolderId} of folder {parentId}.
        slots:
          subfolderId: path.subfolderId
          parentId: path.parentId
      - text: Get details of subfolder {subfolderId} under {parentId}.
        slots:
          subfolderId: path.subfolderId
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{parentId}/subfolders/{subfolderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subfolder
      effect: destructive
      questions:
      - How do I delete a subfolder from its parent?
      - Can I remove a nested folder by addressing it via the parent?
      instructions:
      - text: Delete subfolder {subfolderId} from folder {parentId}.
        slots:
          subfolderId: path.subfolderId
          parentId: path.parentId
      - text: Remove nested folder {subfolderId} under {parentId}.
        slots:
          subfolderId: path.subfolderId
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/subfolders'].get
  update:
    x-apievangelist-phrasing:
      intent: List subfolders of a folder
      effect: read
      questions:
      - Which subfolders are inside a folder?
      - Can I search a folder's subfolders by name?
      instructions:
      - text: List subfolders of folder {Id}.
        slots:
          Id: path.Id
      - text: List subfolders named {name} in folder {Id}.
        slots:
          name: query.name
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/subfolders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subfolder
      effect: write
      questions:
      - How do I create a new folder inside an existing one?
      - Can a new subfolder inherit its parent's permissions?
      instructions:
      - text: Create subfolder {name} in folder {Id}.
        slots:
          name: requestBody.name
          Id: path.Id
      - text: Make a subfolder {name} under {Id} that inherits permissions.
        slots:
          name: requestBody.name
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files in a folder
      effect: read
      questions:
      - What files are in a folder?
      - Can I list only new files in a folder?
      instructions:
      - text: List files in folder {Id}.
        slots:
          Id: path.Id
      - text: List only new files in folder {Id}.
        slots:
          Id: path.Id
      - text: Find files named {name} in folder {Id}.
        slots:
          name: query.name
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file into a folder
      effect: write
      questions:
      - How do I upload a file to a MOVEit folder?
      - Do large uploads need chunked upload, and can I send a hash for integrity?
      instructions:
      - text: Upload {file} into folder {Id}.
        slots:
          file: requestBody.file
          Id: path.Id
      - text: Upload {file} to folder {Id} with comment {comments}.
        slots:
          file: requestBody.file
          Id: path.Id
          comments: requestBody.comments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/folders/{Id}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get all content of a folder
      effect: read
      questions:
      - Can I see a folder's files and subfolders together in one listing?
      - What does a folder contain overall?
      instructions:
      - text: Show everything in folder {Id}, files and subfolders.
        slots:
          Id: path.Id
      - text: Get folder {Id} content filtered by name {name}.
        slots:
          Id: path.Id
          name: query.name
      method: generated
      generated: '2026-10-01'