Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MOVEit Transfer REST Reports API

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

$.info
$.paths['/api/v1/reports/{Id}/results/download'].get
$.paths['/api/v1/reports'].get
$.paths['/api/v1/reports/import'].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 MOVEit Transfer REST Reports API
  version: 1.0.0
extends: openapi/progress-software-reports-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: 3
- target: $.paths['/api/v1/reports/{Id}/results/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a report's run results
      effect: read
      questions:
      - How do I download the results of a report run?
      - Can I choose the file format when downloading report results?
      instructions:
      - text: Download the results of report {Id}.
        slots:
          Id: path.Id
      - text: Download report {Id} results as {format}.
        slots:
          Id: path.Id
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List reports I can view
      effect: read
      questions:
      - Which reports am I allowed to view?
      - Can I sort the list of available reports?
      instructions:
      - text: List the reports I can view.
      - text: Show reports sorted by {sortField}, page {page}.
        slots:
          sortField: query.sortField
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/reports/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a custom report from a file
      effect: write
      questions:
      - How do I create a custom report by uploading a report definition file?
      - Can I import a report someone exported from another server?
      instructions:
      - text: Import a custom report from file {file}.
        slots:
          file: requestBody.file
      - text: Create a new report by uploading {file}.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'