Omnisend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Images API

6 actions 6 updates phrasing extends openapi/omnisend-images-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/images'].get

$.paths['/images'].post

$.paths['/images/{id}'].get

$.paths['/images/{id}'].delete

$.paths['/images/upload'].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 Images API
  version: 1.0.0
extends: openapi/omnisend-images-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/images'].get
  update:
    x-apievangelist-phrasing:
      intent: List images in the library
      effect: read
      questions:
      - Which images are in my brand's image library?
      - Can I search my uploaded images by name?
      instructions:
      - text: List images whose name contains {nameContains}.
        slots:
          nameContains: query.nameContains
      - text: List my library images sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-10-02'
- target: $.paths['/images'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an image from a URL
      effect: write
      questions:
      - Can I add an image to my library from a public URL?
      - What name is used if I import an image by URL without naming it?
      instructions:
      - text: Upload the image at {url} and name it {name}.
        slots:
          url: requestBody.url
          name: requestBody.name
      - text: Import the image from URL {url}.
        slots:
          url: requestBody.url
      method: generated
      generated: '2026-10-02'
- target: $.paths['/images/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one image
      effect: read
      questions:
      - Can I get the details of a single library image by its ID?
      - What does the image library store for one particular image?
      instructions:
      - text: Get image {id}.
        slots:
          id: path.id
      - text: Show the details of library image {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/images/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an image
      effect: destructive
      questions:
      - Can I delete an image from my library?
      - Is there a way to remove an image I uploaded by mistake?
      instructions:
      - text: Delete image {id}.
        slots:
          id: path.id
      - text: Remove image {id} from my library.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/images/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an image file
      effect: write
      questions:
      - How do I upload an image file directly from my computer?
      - Which image formats and file sizes can I upload as a file?
      instructions:
      - text: Upload the image file {file} named {name}.
        slots:
          file: requestBody.file
          name: requestBody.name
      - text: Upload local file {file} to my image library.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-02'