Optimizely · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Optimizely Sections API
9 actions
9 updates
phrasing
extends
openapi/optimizely-sections-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.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/sections/{id}'].get
$.paths['/sections/{id}'].patch
$.paths['/sections/{id}/content'].get
$.paths['/experiments/{experiment_id}/sections'].get
$.paths['/experiments/{experiment_id}/sections'].post
$.paths['/experiments/{experiment_id}/sections/{section_id}'].get
$.paths['/experiments/{experiment_id}/sections/{section_id}'].delete
$.paths['/experiments/{experiment_id}/sections/{section_id}'].patch
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 Sections API
version: 1.0.0
extends: openapi/optimizely-sections-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: 8
- target: $.paths['/sections/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a content section
effect: read
questions:
- Can I fetch the details of a content section by its id?
- What title, description and query define a given content section?
instructions:
- text: Get content section {id}.
slots:
id: path.id
- text: Show the title and query of content section {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/sections/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a content section
effect: write
questions:
- How do I rename a content section or change its description?
- Can I change the query that decides what content a section shows?
instructions:
- text: Rename content section {id} to {title}.
slots:
id: path.id
title: requestBody.title
- text: Set the description of content section {id} to {description} and its query to {query}.
slots:
id: path.id
description: requestBody.description
query: requestBody.query
method: generated
generated: '2026-09-26'
- target: $.paths['/sections/{id}/content'].get
update:
x-apievangelist-phrasing:
intent: List content items in a content section
effect: read
questions:
- Which content items are assigned to a content section?
- Can I page through a content section's items and include their topics?
instructions:
- text: List the content in section {id}.
slots:
id: path.id
- text: Show page {page} of section {id} content, {rpp} per page, with topics {include_topics}.
slots:
page: query.page
id: path.id
rpp: query.rpp
include_topics: query.include_topics
method: generated
generated: '2026-09-26'
- target: $.paths['/experiments/{experiment_id}/sections'].get
update:
x-apievangelist-phrasing:
intent: List sections in a multivariate test
effect: read
questions:
- Which sections make up my multivariate test?
- Can I page through all the sections of a multivariate experiment?
instructions:
- text: List the sections of multivariate test {experiment_id}.
slots:
experiment_id: path.experiment_id
- text: Show page {page} of sections for experiment {experiment_id}, {per_page} per page.
slots:
page: query.page
experiment_id: path.experiment_id
per_page: query.per_page
method: generated
generated: '2026-09-26'
- target: $.paths['/experiments/{experiment_id}/sections'].post
update:
x-apievangelist-phrasing:
intent: Add a section to a multivariate test
effect: write
questions:
- How do I add a new section with its own variations to a multivariate test?
- What variations must a new multivariate test section include?
instructions:
- text: Add a section named {name} with variations {variations} to multivariate test {experiment_id}.
slots:
name: requestBody.name
variations: requestBody.variations
experiment_id: path.experiment_id
- text: Create a new MVT section in experiment {experiment_id} using variations {variations}.
slots:
experiment_id: path.experiment_id
variations: requestBody.variations
method: generated
generated: '2026-09-26'
- target: $.paths['/experiments/{experiment_id}/sections/{section_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a section of a multivariate test
effect: read
questions:
- Can I read the metadata for one section of a multivariate test?
- Which variations belong to a particular multivariate test section?
instructions:
- text: Get section {section_id} of multivariate test {experiment_id}.
slots:
section_id: path.section_id
experiment_id: path.experiment_id
- text: Show the variations in MVT section {section_id} of experiment {experiment_id}.
slots:
section_id: path.section_id
experiment_id: path.experiment_id
method: generated
generated: '2026-09-26'
- target: $.paths['/experiments/{experiment_id}/sections/{section_id}'].delete
update:
x-apievangelist-phrasing:
intent: Archive a multivariate test section
effect: destructive
questions:
- How do I archive a section I no longer want in a multivariate test?
- Does deleting a multivariate test section archive it rather than erase it?
instructions:
- text: Archive section {section_id} of multivariate test {experiment_id}.
slots:
section_id: path.section_id
experiment_id: path.experiment_id
- text: Remove MVT section {section_id} from experiment {experiment_id}.
slots:
section_id: path.section_id
experiment_id: path.experiment_id
method: generated
generated: '2026-09-26'
- target: $.paths['/experiments/{experiment_id}/sections/{section_id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a multivariate test section
effect: write
questions:
- Can I rename a multivariate test section or change its variations?
- Is updating a multivariate section still a beta feature?
instructions:
- text: Rename section {section_id} in multivariate test {experiment_id} to {name}.
slots:
section_id: path.section_id
experiment_id: path.experiment_id
name: requestBody.name
- text: Replace the variations of MVT section {section_id} in experiment {experiment_id} with {variations}.
slots:
section_id: path.section_id
experiment_id: path.experiment_id
variations: requestBody.variations
method: generated
generated: '2026-09-26'