SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse FileManager Public Directory API

6 actions 6 updates phrasing extends openapi/sendpulse-directory-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/directory'].get

$.paths['/directory'].post

$.paths['/directory/size'].get

$.paths['/directory/{path}'].get

$.paths['/directory/find'].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 SendPulse FileManager Public Directory API
  version: 1.0.0
extends: openapi/sendpulse-directory-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: 5
- target: $.paths['/directory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the file storage directory tree
      effect: read
      questions:
      - What folders are in my file storage?
      - Can I see the whole directory tree of my uploaded files?
      instructions:
      - text: Show my file storage directory tree.
      - text: List all folders in my file manager.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a folder in file storage
      effect: write
      questions:
      - How do I create a new folder in my file storage?
      - Can I make a subfolder inside an existing path?
      instructions:
      - text: Create folder {name} under {pathToStore}.
        slots:
          name: requestBody.name
          pathToStore: requestBody.pathToStore
      - text: Make a new directory called {name} at path {pathToStore}.
        slots:
          name: requestBody.name
          pathToStore: requestBody.pathToStore
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/size'].get
  update:
    x-apievangelist-phrasing:
      intent: Get file storage usage statistics
      effect: read
      questions:
      - How much file storage space am I using?
      - What are my storage usage statistics?
      instructions:
      - text: Show my file storage usage.
      - text: How full is my file storage; report the stats
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the contents of a folder
      effect: read
      questions:
      - What files are inside a specific folder?
      - Can I open one directory and see what it holds?
      instructions:
      - text: Show the contents of folder {path}.
        slots:
          path: path.path
      - text: List what's stored in directory {path}.
        slots:
          path: path.path
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/find'].get
  update:
    x-apievangelist-phrasing:
      intent: Search for files in a folder
      effect: read
      questions:
      - Can I search for a file by name inside a folder?
      - Where is a particular uploaded file stored?
      instructions:
      - text: Search folder {path} for files matching {search}.
        slots:
          path: query.path
          search: query.search
      - text: Find {search} in directory {path}.
        slots:
          search: query.search
          path: query.path
      method: generated
      generated: '2026-10-01'