Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Storefront API V1 Email Attachments API

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

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/api/v1/emailAttachments'].get

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 Storefront API V1 Email Attachments API
  version: 1.0.0
extends: openapi/optimizely-emailattachments-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: 1
- target: $.paths['/api/v1/emailAttachments'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an email attachment
      effect: read
      questions:
      - How do I download a file that was attached to a storefront email?
      - What do I need to fetch an email attachment, a file name and a key?
      instructions:
      - text: Download email attachment {filename} with key {key}.
        slots:
          filename: query.filename
          key: query.key
      - text: Get the attached file {filename} using access key {key}.
        slots:
          filename: query.filename
          key: query.key
      method: generated
      generated: '2026-09-26'