SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse FileManager Public File API

5 actions 5 updates phrasing extends openapi/sendpulse-file-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 5

$.info

$.paths['/file'].post

$.paths['/file'].delete

$.paths['/file/exist'].post

$.paths['/file/filter'].post

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 File API
  version: 1.0.0
extends: openapi/sendpulse-file-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: 4
- target: $.paths['/file'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload files to storage
      effect: write
      questions:
      - How do I upload a file to my storage folder?
      - Can I upload several images at once and resize them?
      instructions:
      - text: Upload {content} to {pathToStore}.
        slots:
          content: requestBody.content[]
          pathToStore: requestBody.pathToStore
      - text: Store these files in {pathToStore} at width {width}.
        slots:
          pathToStore: requestBody.pathToStore
          width: requestBody.width
      method: generated
      generated: '2026-10-01'
- target: $.paths['/file'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file from storage
      effect: destructive
      questions:
      - Can I delete a file from storage?
      - What's the way to remove one stored file by its path?
      instructions:
      - text: Delete the file at {path}.
        slots:
          path: requestBody.path
      - text: Remove stored file {path}.
        slots:
          path: requestBody.path
      method: generated
      generated: '2026-10-01'
- target: $.paths['/file/exist'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether a file exists
      effect: read
      questions:
      - Is there already a file at a given storage path?
      - Can I check if an upload exists before overwriting it?
      instructions:
      - text: Check if a file exists at {path}.
        slots:
          path: requestBody.path
      - text: Tell me whether {path} is in storage.
        slots:
          path: requestBody.path
      method: generated
      generated: '2026-10-01'
- target: $.paths['/file/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: List files in a folder by date
      effect: read
      questions:
      - Which files were uploaded to a folder in a date range?
      - Can I sort the files in a storage directory?
      instructions:
      - text: List files in {path} uploaded between {fromDate} and {toDate}.
        slots:
          path: requestBody.path
          fromDate: requestBody.fromDate
          toDate: requestBody.toDate
      - text: Show files in folder {path} sorted by {sort}.
        slots:
          path: requestBody.path
          sort: requestBody.sort
      method: generated
      generated: '2026-10-01'