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.
# 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 Milestones API
version: 1.0.0
extends: openapi/optimizely-milestones-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: 4
- target: $.paths['/milestones'].get
update:
x-apievangelist-phrasing:
intent: List campaign milestones
effect: read
questions:
- Which milestones are coming due in my Optimizely campaign?
- Can I list only milestones due between two dates?
- How do I page through milestones for one campaign?
instructions:
- text: List milestones for campaign {campaign_id}.
slots:
campaign_id: query.campaign_id
- text: Show milestones due between {due_date__from} and {due_date__to}.
slots:
due_date__from: query.due_date__from
due_date__to: query.due_date__to
method: generated
generated: '2026-09-26'
- target: $.paths['/milestones'].post
update:
x-apievangelist-phrasing:
intent: Create a campaign milestone
effect: write
questions:
- How do I add a milestone with a due date and colored label to a campaign?
- Can I attach tasks to a new milestone, and must they belong to the same campaign?
instructions:
- text: Create milestone {title} due {due_date} with label color {hex_color}.
slots:
title: requestBody.title
due_date: requestBody.due_date
hex_color: requestBody.hex_color
- text: Add milestone {title} to campaign {campaign_id}, due {due_date}, color {hex_color}, with tasks {tasks}.
slots:
title: requestBody.title
campaign_id: requestBody.campaign_id
due_date: requestBody.due_date
hex_color: requestBody.hex_color
tasks: requestBody.tasks
method: generated
generated: '2026-09-26'
- target: $.paths['/milestones/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a milestone
effect: read
questions:
- What's the due date and task list on a particular milestone?
- Can I look up one milestone by its ID?
instructions:
- text: Show milestone {id}.
slots:
id: path.id
- text: Get the details of milestone {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/milestones/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a milestone
effect: write
questions:
- Can I push back a milestone's due date without changing anything else?
- What happens to linked tasks if I send an empty task list when editing a milestone?
instructions:
- text: Move milestone {id} due date to {due_date}.
slots:
id: path.id
due_date: requestBody.due_date
- text: Rename milestone {id} to {title} and change its label color to {hex_color}.
slots:
id: path.id
title: requestBody.title
hex_color: requestBody.hex_color
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.