Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Storefront API V1 Feederdata API

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

$.info
$.paths['/api/v1/feederdata/restrictionGroups/mostProducts'].get
$.paths['/api/v1/feederdata/customers/mostShipTos'].get
$.paths['/api/v1/feederdata/wishLists/mostProducts'].get
$.paths['/api/v1/feederdata/product/mostWarehouses'].get
$.paths['/api/v1/feederdata/quickorder/products'].get
$.paths['/api/v1/feederdata/brands/mostProducts'].get

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 Feederdata API
  version: 1.0.0
extends: openapi/optimizely-feederdata-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: 6
- target: $.paths['/api/v1/feederdata/restrictionGroups/mostProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the restriction group with most products
      effect: read
      questions:
      - Which product restriction group covers the most products, for test data?
      - Can I get a heavily populated restriction group to seed a load test?
      instructions:
      - text: Get the restriction group that contains the most products.
      - text: Fetch feeder data for the largest product restriction group.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/feederdata/customers/mostShipTos'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the customer with most ship-to addresses
      effect: read
      questions:
      - Which customer has the most ship-to addresses on file?
      - Can I pick a customer with many ship-tos to test address selection?
      instructions:
      - text: Get the customer with the most ship-to addresses.
      - text: Fetch feeder data for the bill-to customer with the largest ship-to list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/feederdata/wishLists/mostProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the wish list with most products
      effect: read
      questions:
      - Which wish list holds the most products?
      - Can I grab the biggest wish list to test list performance?
      instructions:
      - text: Get the wish list that contains the most products.
      - text: Fetch feeder data for the largest wish list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/feederdata/product/mostWarehouses'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the product stocked in most warehouses
      effect: read
      questions:
      - Which product is stocked across the most warehouses?
      - Can I get a product with wide warehouse coverage for inventory testing?
      instructions:
      - text: Get the product available in the most warehouses.
      - text: Fetch feeder data for the product with the widest warehouse inventory.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/feederdata/quickorder/products'].get
  update:
    x-apievangelist-phrasing:
      intent: Get sample products for quick order upload
      effect: read
      questions:
      - Which products can I use to test a quick order bulk upload?
      - Can I choose how many sample products come back for quick order testing?
      instructions:
      - text: Get sample products for a quick order upload.
      - text: Fetch {count} products to use in a quick order upload test.
        slots:
          count: query.count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/feederdata/brands/mostProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the brand with most products
      effect: read
      questions:
      - Which brand has the most products in the catalog?
      - Can I find the biggest brand whose name starts with a given letter?
      instructions:
      - text: Get the brand with the most products.
      - text: Find the brand starting with {startLetter} that has the most products.
        slots:
          startLetter: query.startLetter
      method: generated
      generated: '2026-09-26'