Gumlet · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gumlet Image Sources API

8 actions 8 updates phrasing extends openapi/gumlet-image-sources-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Gumlet's API. It is a proposal applied on top of the contract, not a document Gumlet publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/image/sources'].get
$.paths['/image/sources'].post
$.paths['/image/sources/{image_source_id}'].get
$.paths['/image/sources/{image_source_id}'].post
$.paths['/image/sources/{image_source_id}'].delete
$.paths['/purge/{subdomain}'].post
$.paths['/image/purge/{source_id}'].post

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 Gumlet Image Sources API
  version: 1.0.0
extends: openapi/gumlet-image-sources-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: 7
- target: $.paths['/image/sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List image sources
      effect: read
      questions:
      - Which image sources are set up on my account?
      - Can I page through image sources assigned to my API token?
      instructions:
      - text: List my image sources.
      - text: Show {size} image sources starting at offset {offset}.
        slots:
          size: query.size
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/image/sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an image source
      effect: write
      questions:
      - How do I connect my storage bucket so Gumlet can optimize my images?
      - Can I set up an image source that proxies images from my web folder?
      - What subdomain will my new image source be served from?
      instructions:
      - text: Create a {type} image source with subdomain {namespace}.
        slots:
          type: requestBody.type
          namespace: requestBody.namespace
      - text: Set up a {type} image source {namespace} using web folder {webfolder}.
        slots:
          type: requestBody.type
          namespace: requestBody.namespace
          webfolder: requestBody.webfolder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/image/sources/{image_source_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an image source's settings
      effect: read
      questions:
      - What origin and cache settings does one of my image sources use?
      - Can I see the full configuration of a single image source?
      instructions:
      - text: Get image source {image_source_id}.
        slots:
          image_source_id: path.image_source_id
      - text: Show the configuration of image source {image_source_id}.
        slots:
          image_source_id: path.image_source_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/image/sources/{image_source_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an image source's configuration
      effect: write
      questions:
      - Can I change the CDN or browser cache time on an existing image source?
      - How do I add a custom CNAME or fallback origins to an image source?
      - Is there a way to temporarily disable an image source?
      instructions:
      - text: Set the CDN cache time on image source {image_source_id} to {cdn_cache_time}.
        slots:
          image_source_id: path.image_source_id
          cdn_cache_time: requestBody.cdn_cache_time
      - text: Point image source {image_source_id} at custom domain {cname}.
        slots:
          image_source_id: path.image_source_id
          cname: requestBody.cname
      - text: Set image source {image_source_id} active status to {is_active}.
        slots:
          image_source_id: path.image_source_id
          is_active: requestBody.is_active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/image/sources/{image_source_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an image source
      effect: destructive
      questions:
      - What happens to image delivery if I delete an image source?
      - Can I permanently remove an image source I no longer use?
      instructions:
      - text: Delete image source {image_source_id}.
        slots:
          image_source_id: path.image_source_id
      - text: Remove image source {image_source_id} and stop serving its subdomain.
        slots:
          image_source_id: path.image_source_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/purge/{subdomain}'].post
  update:
    x-apievangelist-phrasing:
      intent: Purge cached images by subdomain
      effect: write
      questions:
      - Can I clear the cache for images served from a particular subdomain?
      - Is there a purge call that works off my source subdomain name?
      instructions:
      - text: Purge the image cache on subdomain {subdomain}.
        slots:
          subdomain: path.subdomain
      - text: Purge paths {paths} on subdomain {subdomain}.
        slots:
          paths: requestBody.paths
          subdomain: path.subdomain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/image/purge/{source_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Purge cached image paths by source id
      effect: write
      questions:
      - How do I force fresh copies of specific images after I replace them at the origin?
      - Can I purge particular image paths using the image source id?
      instructions:
      - text: Purge image paths {paths} from source {source_id}.
        slots:
          paths: requestBody.paths
          source_id: path.source_id
      - text: Clear the cached copies of {paths} for image source id {source_id}.
        slots:
          paths: requestBody.paths
          source_id: path.source_id
      method: generated
      generated: '2026-10-01'