Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Storefront API V1 Realtimeinventory API

2 actions 2 updates phrasing extends openapi/optimizely-realtimeinventory-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 2

$.info
$.paths['/api/v1/realtimeinventory'].post

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 Storefront API V1 Realtimeinventory API
  version: 1.0.0
extends: openapi/optimizely-realtimeinventory-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: 1
- target: $.paths['/api/v1/realtimeinventory'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up real-time inventory for products
      effect: read
      questions:
      - How can I check live stock levels for a set of products?
      - Can a real-time inventory lookup include alternate inventory too?
      instructions:
      - text: Get real-time inventory for products {productIds}.
        slots:
          productIds: requestBody.productIds
      - text: 'Check live stock for {productIds} including alternate inventory: {includeAlternateInventory}.'
        slots:
          productIds: requestBody.productIds
          includeAlternateInventory: requestBody.includeAlternateInventory
      method: generated
      generated: '2026-09-26'