Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Audiences API

5 actions 5 updates phrasing extends openapi/optimizely-audiences-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 5

$.info
$.paths['/audiences'].get
$.paths['/audiences'].post
$.paths['/audiences/{audience_id}'].get
$.paths['/audiences/{audience_id}'].patch

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 Audiences API
  version: 1.0.0
extends: openapi/optimizely-audiences-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['/audiences'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's audiences
      effect: read
      questions:
      - Which audiences are defined in my Optimizely project?
      - Can I page through a project's audiences?
      instructions:
      - text: List audiences in project {project_id}.
        slots:
          project_id: query.project_id
      - text: Show page {page} of audiences for project {project_id}, {per_page} per page.
        slots:
          page: query.page
          project_id: query.project_id
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an audience
      effect: write
      questions:
      - How do I define a new targeting audience with conditions?
      - Can I give a new audience a description?
      instructions:
      - text: Create audience {name} in project {project_id} with conditions {conditions}.
        slots:
          name: requestBody.name
          project_id: requestBody.project_id
          conditions: requestBody.conditions
      - text: Add a new audience called {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audience_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audience's details
      effect: read
      questions:
      - What conditions make up a particular audience?
      - Can I see the full definition of one audience by ID?
      instructions:
      - text: Show audience {audience_id}.
        slots:
          audience_id: path.audience_id
      - text: Get the targeting conditions of audience {audience_id}.
        slots:
          audience_id: path.audience_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audience_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an audience
      effect: write
      questions:
      - Can I change an existing audience's conditions?
      - Is it possible to rename an audience after creating it?
      instructions:
      - text: Update audience {audience_id} conditions to {conditions}.
        slots:
          audience_id: path.audience_id
          conditions: requestBody.conditions
      - text: Rename audience {audience_id} to {name}.
        slots:
          audience_id: path.audience_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'