Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Media REST Directories API

6 actions 6 updates phrasing extends openapi/listrak-directories-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 6

$.info
$.paths['/v1/directories'].get
$.paths['/v1/directories/{directoryId}'].get
$.paths['/v1/directories/{directoryId}'].put
$.paths['/v1/directories/{directoryId}'].post
$.paths['/v1/directories/{directoryId}'].delete

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 Listrak Media REST Directories API
  version: 1.0.0
extends: openapi/listrak-directories-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: 5
- target: $.paths['/v1/directories'].get
  update:
    x-apievangelist-phrasing:
      intent: List top-level media directories
      effect: read
      questions:
      - What are the root folders in my media library?
      - Can I see the top-level directories where images are stored?
      instructions:
      - text: List the top-level directories in my media library.
      - text: Show the root media folders.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/directories/{directoryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a media directory's contents
      effect: read
      questions:
      - How do I see the subfolders and files inside a media directory?
      - Can I page through files and subdirectories separately?
      instructions:
      - text: List subdirectories and files in media directory {directoryId}.
        slots:
          directoryId: path.directoryId
      - text: Show page {filesPageNumber} of files in directory {directoryId}.
        slots:
          filesPageNumber: query.filesPageNumber
          directoryId: path.directoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/directories/{directoryId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a media directory
      effect: write
      questions:
      - Can I rename a media folder or move it under another folder?
      - How do I reorganize directories in the media library?
      instructions:
      - text: Rename media directory {directoryId} to {name} and put it under {newParentId}.
        slots:
          directoryId: path.directoryId
          name: requestBody.name
          newParentId: requestBody.newParentId
      - text: Move directory {directoryId} into parent {newParentId}, keeping name {name}.
        slots:
          directoryId: path.directoryId
          newParentId: requestBody.newParentId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/directories/{directoryId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a media subdirectory
      effect: write
      questions:
      - How do I make a new folder inside a media directory?
      - Can I create nested directories in the media library?
      instructions:
      - text: Create a subdirectory named {name} inside media directory {directoryId}.
        slots:
          name: requestBody.name
          directoryId: path.directoryId
      - text: Make a new media folder {name} under {directoryId}.
        slots:
          name: requestBody.name
          directoryId: path.directoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/directories/{directoryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a media directory
      effect: destructive
      questions:
      - How do I remove a folder from the media library?
      - Is deleting a media directory permanent?
      instructions:
      - text: Delete media directory {directoryId}.
        slots:
          directoryId: path.directoryId
      - text: Remove the folder {directoryId} from my media library.
        slots:
          directoryId: path.directoryId
      method: generated
      generated: '2026-09-26'