Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MOVEit Transfer REST Transfer Status API

2 actions 2 updates phrasing extends openapi/progress-software-transferstatus-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 2

$.info

$.paths['/api/v1/xferstatus'].get

OpenAPI Overlay

# 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 Transfer Status API
  version: 1.0.0
extends: openapi/progress-software-transferstatus-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: 1
- target: $.paths['/api/v1/xferstatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of file transfers
      effect: read
      questions:
      - Which file transfers are running right now on MOVEit Transfer?
      - Can I see transfers that finished in the last hour, filtered by user?
      - What share of recent transfers succeeded versus failed?
      instructions:
      - text: Show transfers completed in the last {recentlyCompletedPeriod} seconds.
        slots:
          recentlyCompletedPeriod: query.recentlyCompletedPeriod
      - text: List transfers by user {userLoginName} with status {transferStatus}.
        slots:
          userLoginName: query.userLoginName
          transferStatus: query.transferStatus
      - text: Find transfers of file {fileName} in folder {folderName}.
        slots:
          fileName: query.fileName
          folderName: query.folderName
      method: generated
      generated: '2026-10-01'