Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Storefront API V1 Orderapprovals API

3 actions 3 updates phrasing extends openapi/optimizely-orderapprovals-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/orderapprovals'].get
$.paths['/api/v1/orderapprovals/{cartId}'].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 Orderapprovals API
  version: 1.0.0
extends: openapi/optimizely-orderapprovals-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/orderapprovals'].get
  update:
    x-apievangelist-phrasing:
      intent: List orders awaiting approval
      effect: read
      questions:
      - Which orders are waiting for me to approve them?
      - Can I filter pending approvals to orders above a certain total?
      - How do I find approval requests for one ship-to address or date range?
      instructions:
      - text: List orders awaiting approval.
      - text: Show approvals where the order total is {orderTotalOperator} {orderTotal}.
        slots:
          orderTotalOperator: query.parameter.orderTotalOperator
          orderTotal: query.parameter.orderTotal
      - text: List orders pending approval for ship-to {shipToId} placed between {fromDate} and {toDate}.
        slots:
          shipToId: query.parameter.shipToId
          fromDate: query.parameter.fromDate
          toDate: query.parameter.toDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/orderapprovals/{cartId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order awaiting approval
      effect: read
      questions:
      - What is in a specific cart that is waiting for approval?
      - Can I review one approval request's line items before deciding?
      instructions:
      - text: Get the approval request for cart {cartId}.
        slots:
          cartId: path.cartId
      - text: Show me the items in cart {cartId} pending approval.
        slots:
          cartId: path.cartId
      method: generated
      generated: '2026-09-26'