Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely CMP Open API Documentation Workflows API

3 actions 3 updates phrasing extends openapi/optimizely-workflows-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['/workflows'].get
$.paths['/workflows/{workflow_id}'].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 Optimizely CMP Open API Documentation Workflows API
  version: 1.0.0
extends: openapi/optimizely-workflows-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['/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List CMP workflows
      effect: read
      questions:
      - Which workflows exist in my content marketing platform?
      - Can I page through workflows with an offset and page size?
      instructions:
      - text: List workflows.
      - text: Show {page_size} workflows starting at offset {offset}.
        slots:
          page_size: query.page_size
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflows/{workflow_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CMP workflow
      effect: read
      questions:
      - What does a particular workflow look like in CMP?
      - Can I look up one workflow by its ID?
      instructions:
      - text: Get workflow {workflow_id}.
        slots:
          workflow_id: path.workflow_id
      - text: Show the details of workflow {workflow_id}.
        slots:
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-09-26'