Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Storefront API V1 Autocomplete API

3 actions 3 updates phrasing extends openapi/optimizely-autocomplete-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/autocomplete'].get

$.paths['/api/v1/autocomplete/products'].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 Storefront API V1 Autocomplete API
  version: 1.0.0
extends: openapi/optimizely-autocomplete-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/autocomplete'].get
  update:
    x-apievangelist-phrasing:
      intent: Get search autocomplete suggestions
      effect: read
      questions:
      - How do I show type-ahead suggestions as a shopper types in the storefront search box?
      - Can autocomplete include categories, brands and content as well as products?
      instructions:
      - text: Get autocomplete suggestions for {query}.
        slots:
          query: query.autocompleteParameter.query
      - text: Suggest brands and categories matching {query}.
        slots:
          query: query.autocompleteParameter.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/autocomplete/products'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product-only autocomplete suggestions
      effect: read
      questions:
      - How do I autocomplete only product names from a partial search term?
      - Can I limit product autocomplete to one category and cap the result count?
      instructions:
      - text: Autocomplete products matching {query}.
        slots:
          query: query.model.query
      - text: Suggest up to {maximumResults} products in category {categoryId} for {query}.
        slots:
          maximumResults: query.model.maximumResults
          categoryId: query.model.categoryId
          query: query.model.query
      method: generated
      generated: '2026-09-26'