Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Search API

3 actions 3 updates phrasing extends openapi/optimizely-search-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['/api/v1/search/redirect'].get

$.paths['/search'].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 Search API
  version: 1.0.0
extends: openapi/optimizely-search-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['/api/v1/search/redirect'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a storefront search redirect
      effect: read
      questions:
      - Does a storefront search term redirect shoppers to a specific page?
      - Which redirect URL is configured for a given commerce search term?
      instructions:
      - text: Check the search redirect for term {term}.
        slots:
          term: query.term
      - text: Find where a storefront search for {term} redirects.
        slots:
          term: query.term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search entities in my experimentation account
      effect: read
      questions:
      - How do I find experiments, flags or campaigns in my account by name?
      - Can I include archived entities when searching my account?
      - Can I narrow an account search to one project and to running items only?
      instructions:
      - text: Search my account for {query}.
        slots:
          query: query.query
      - text: Search project {project_id} for {query} of type {type}.
        slots:
          project_id: query.project_id
          query: query.query
          type: query.type
      - text: Search for {query} with archived included set to {archived} and status {status}.
        slots:
          query: query.query
          archived: query.archived
          status: query.status
      method: generated
      generated: '2026-09-26'