Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MOVEit Transfer REST Logs API

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

$.info

$.paths['/api/v1/logs/{Id}'].get

$.paths['/api/v1/logs'].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 Logs API
  version: 1.0.0
extends: openapi/progress-software-logs-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: 2
- target: $.paths['/api/v1/logs/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one audit log entry
      effect: read
      questions:
      - What are the full details of a single log entry?
      - Can I look up one audit record by its log ID?
      instructions:
      - text: Get log entry {Id}.
        slots:
          Id: path.Id
      - text: Show the details of audit record {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the audit logs
      effect: read
      questions:
      - Who downloaded a particular file from MOVEit Transfer last week?
      - Can I filter the activity log to only failed actions from one IP address?
      - Is it possible to include sign-on and sign-off events in the log listing?
      instructions:
      - text: List log entries between {startDateTime} and {endDateTime}.
        slots:
          startDateTime: query.startDateTime
          endDateTime: query.endDateTime
      - text: Find log entries for files named like {fileNameContains} in folder {folderId}.
        slots:
          fileNameContains: query.fileNameContains
          folderId: query.folderId
      - text: Show {action} actions from IP addresses like {ipContains}.
        slots:
          action: query.action
          ipContains: query.ipContains
      method: generated
      generated: '2026-10-01'