Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Recommendations API

6 actions 6 updates phrasing extends openapi/optimizely-recommendations-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 6

$.info

$.paths['/recommendations/products'].get

$.paths['/recommendations/{id}'].patch

$.paths['/recommendations/catalogs/{catalog_id}/catalog/{date}'].get

$.paths['/recommendations/catalogs/{catalog_id}/recommenders/{recommender_id}/{date}'].get

$.paths['/recommendations/catalogs/{catalog_id}/stats/{date}'].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 Recommendations API
  version: 1.0.0
extends: openapi/optimizely-recommendations-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: 5
- target: $.paths['/recommendations/products'].get
  update:
    x-apievangelist-phrasing:
      intent: Get product recommendations
      effect: read
      questions:
      - How do I get personalized product recommendations for a customer?
      - Can I get products similar to the ones a shopper is looking at right now?
      - What's the maximum number of recommended products I can ask for in one call?
      instructions:
      - text: Recommend {limit} products related to product ids {product_ids}.
        slots:
          limit: query.limit
          product_ids: query.product_ids
      - text: Get {type} product recommendations filtered by {criteria}.
        slots:
          type: query.type
          criteria: query.criteria
      - text: Get recommended products sorted by {sort_by} in {order} order.
        slots:
          sort_by: query.sort_by
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/recommendations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark a recommendation as read
      effect: write
      questions:
      - Can I dismiss a pending recommendation once I've reviewed it?
      - How do I clear the pending flag on a recommendation?
      instructions:
      - text: Mark recommendation {id} as read.
        slots:
          id: path.id
      - text: Set pending to {pending} on recommendation {id}.
        slots:
          pending: requestBody.pending
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/recommendations/catalogs/{catalog_id}/catalog/{date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a recommendations catalog as CSV
      effect: read
      questions:
      - Can I export the product catalog data the recommender is using as a CSV?
      - How do I download a catalog snapshot for a given date?
      instructions:
      - text: Download the catalog CSV for catalog {catalog_id} on {date}.
        slots:
          catalog_id: path.catalog_id
          date: path.date
      - text: Export all current catalog data of {catalog_id} as of {date}.
        slots:
          catalog_id: path.catalog_id
          date: path.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/recommendations/catalogs/{catalog_id}/recommenders/{recommender_id}/{date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download computed recommendations as CSV
      effect: read
      questions:
      - Can I pull the full recommendations a recommender computed into a CSV?
      - How do I export a recommender's output for a specific date?
      instructions:
      - text: Download the output CSV of recommender {recommender_id} in catalog {catalog_id} for {date}.
        slots:
          recommender_id: path.recommender_id
          catalog_id: path.catalog_id
          date: path.date
      - text: Export computed recommendations from recommender {recommender_id}, catalog {catalog_id}, dated {date}.
        slots:
          recommender_id: path.recommender_id
          catalog_id: path.catalog_id
          date: path.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/recommendations/catalogs/{catalog_id}/stats/{date}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download recommendation summary stats as CSV
      effect: read
      questions:
      - Where can I get summary statistics about a recommendations catalog?
      - Can I download the recommendation stats for a particular day as a CSV?
      instructions:
      - text: Get the summary statistics spreadsheet for recommendations catalog {catalog_id} dated {date}.
        slots:
          catalog_id: path.catalog_id
          date: path.date
      - text: Export summary stats of catalog {catalog_id} for {date}.
        slots:
          catalog_id: path.catalog_id
          date: path.date
      method: generated
      generated: '2026-09-26'