Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Media REST Files API

4 actions 4 updates phrasing extends openapi/listrak-files-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Listrak's API. It is a proposal applied on top of the contract, not a document Listrak publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v1/directories/{directoryId}/files'].post

$.paths['/v1/directories/{directoryId}/files/{fileId}'].put

$.paths['/v1/directories/{directoryId}/files/{fileId}'].delete

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 Listrak Media REST Files API
  version: 1.0.0
extends: openapi/listrak-files-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1/directories/{directoryId}/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to a media directory
      effect: write
      questions:
      - How do I upload an image into a media library folder?
      - Can I name a file when adding it to a directory?
      instructions:
      - text: Upload file {name} into media directory {directoryId}.
        slots:
          name: requestBody.name
          directoryId: path.directoryId
      - text: Add a new image file to directory {directoryId}.
        slots:
          directoryId: path.directoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/directories/{directoryId}/files/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a media file
      effect: write
      questions:
      - Can I rename an image in the media library or move it to another folder?
      - How do I relocate a file to a different directory?
      instructions:
      - text: Rename file {fileId} in directory {directoryId} to {name} and move it to {newDirectoryId}.
        slots:
          fileId: path.fileId
          directoryId: path.directoryId
          name: requestBody.name
          newDirectoryId: requestBody.newDirectoryId
      - text: Move media file {fileId} from {directoryId} to directory {newDirectoryId} as {name}.
        slots:
          fileId: path.fileId
          directoryId: path.directoryId
          newDirectoryId: requestBody.newDirectoryId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/directories/{directoryId}/files/{fileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a media file
      effect: destructive
      questions:
      - How do I remove an image from the media library?
      - Can I delete a single file from a directory?
      instructions:
      - text: Delete file {fileId} from media directory {directoryId}.
        slots:
          fileId: path.fileId
          directoryId: path.directoryId
      - text: Remove image {fileId} in folder {directoryId}.
        slots:
          fileId: path.fileId
          directoryId: path.directoryId
      method: generated
      generated: '2026-09-26'