Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Campaign REST Mailing Lists API

3 actions 3 updates phrasing extends openapi/optimizely-mailing-lists-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 3

$.info

$.paths['/{clientId}/mailinglists'].get

$.paths['/{clientId}/mailinglists/{mailingListId}'].get

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 Optimizely Campaign REST Mailing Lists API
  version: 1.0.0
extends: openapi/optimizely-mailing-lists-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: 2
- target: $.paths['/{clientId}/mailinglists'].get
  update:
    x-apievangelist-phrasing:
      intent: List mailing lists for a Campaign client
      effect: read
      questions:
      - Which mailing lists exist under my Optimizely Campaign client?
      - Can I see all the mailing lists for one client account?
      instructions:
      - text: List all mailing lists for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Show every mailing list in Campaign client {clientId}.
        slots:
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/mailinglists/{mailingListId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one mailing list
      effect: read
      questions:
      - What are the details of a specific mailing list?
      - Can I look up a single mailing list by its ID?
      instructions:
      - text: Get mailing list {mailingListId} in client {clientId}.
        slots:
          mailingListId: path.mailingListId
          clientId: path.clientId
      - text: Show the details of mailing list {mailingListId}.
        slots:
          mailingListId: path.mailingListId
      method: generated
      generated: '2026-09-26'