Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Email Message Attachments API

10 actions 10 updates phrasing extends openapi/optimizely-email-message-attachments-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 10

$.info
$.paths['/api/v1/admin/EmailMessageAttachments'].get
$.paths['/api/v1/admin/EmailMessageAttachments'].post
$.paths['/api/v1/admin/EmailMessageAttachments({id})'].get
$.paths['/api/v1/admin/EmailMessageAttachments({id})'].put
$.paths['/api/v1/admin/EmailMessageAttachments({id})'].delete
$.paths['/api/v1/admin/EmailMessageAttachments({id})'].patch
$.paths['/api/v1/admin/EmailMessageAttachments/Default.Default()'].get
$.paths['/api/v1/admin/emailmessageattachments/delete'].delete
$.paths['/api/v1/admin/emailmessageattachments({key})/customproperties({custompropertyKey})'].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 Admin API V1 Email Message Attachments API
  version: 1.0.0
extends: openapi/optimizely-email-message-attachments-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: 9
- target: $.paths['/api/v1/admin/EmailMessageAttachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List email message attachments
      effect: read
      questions:
      - Which files are attached to emails the commerce site has sent?
      - Can I filter email attachments by the email message they belong to?
      instructions:
      - text: List all email message attachments.
      - text: Find email message attachments matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAttachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a file to an email message
      effect: write
      questions:
      - How do I add a file attachment to a stored email message?
      - What fields does a new email attachment take, file content and file name?
      instructions:
      - text: Attach file {fileName} to email message {emailMessageId}.
        slots:
          fileName: requestBody.fileName
          emailMessageId: requestBody.emailMessageId
      - text: Create an email attachment named {fileName} with content {file} on message {emailMessageId}.
        slots:
          fileName: requestBody.fileName
          file: requestBody.file
          emailMessageId: requestBody.emailMessageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAttachments({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email message attachment by ID
      effect: read
      questions:
      - What file name and content does one email attachment hold?
      - Can I download a single email message attachment record by ID?
      instructions:
      - text: Get email message attachment {id}.
        slots:
          id: path.id
      - text: Show the file name and content of email attachment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAttachments({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an email message attachment
      effect: write
      questions:
      - Can I overwrite an entire email attachment record, file and all?
      - What does a full replace of an email attachment require?
      instructions:
      - text: Replace email attachment {id} with file {fileName}.
        slots:
          id: path.id
          fileName: requestBody.fileName
      - text: Overwrite the whole email message attachment {id} using a full PUT.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAttachments({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email message attachment by ID
      effect: destructive
      questions:
      - How do I remove one attachment from a stored email?
      - Does deleting an email attachment accept an If-Match ETag?
      instructions:
      - text: Delete email message attachment {id}.
        slots:
          id: path.id
      - text: Delete email attachment {id} only if its ETag matches {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAttachments({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an email message attachment
      effect: write
      questions:
      - How do I rename the file on an existing email attachment?
      - Can I move an attachment to a different email message?
      instructions:
      - text: Rename email attachment {id} to {fileName}.
        slots:
          id: path.id
          fileName: requestBody.fileName
      - text: Move email attachment {id} to email message {emailMessageId}.
        slots:
          id: path.id
          emailMessageId: requestBody.emailMessageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAttachments/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default email attachment template
      effect: read
      questions:
      - What default values does a new email message attachment start with?
      - Is there a blank email attachment template to fetch first?
      instructions:
      - text: Fetch the default email message attachment template.
      - text: Show me the default values for a new email attachment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailmessageattachments/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete email message attachments
      effect: destructive
      questions:
      - How do I delete several email attachments at once?
      - Can I pass a list of IDs to remove many email message attachments?
      instructions:
      - text: Bulk delete the email message attachments with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all of these email attachments in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailmessageattachments({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an email attachment
      effect: read
      questions:
      - Where do I read a custom property stored on an email message attachment?
      - Can I fetch one extra property value from an email attachment?
      instructions:
      - text: Get custom property {custompropertyKey} on email attachment {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of email message attachment {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'