Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Storefront API V1 Spreedly API

3 actions 3 updates phrasing extends openapi/optimizely-spreedly-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/spreedly/config'].get
$.paths['/api/v1/spreedly/bnpl/redirect'].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 Spreedly API
  version: 1.0.0
extends: openapi/optimizely-spreedly-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/spreedly/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Spreedly payment configuration
      effect: read
      questions:
      - How do I get the storefront's Spreedly payment settings?
      - What Spreedly configuration does checkout need to load?
      instructions:
      - text: Fetch the Spreedly payment configuration.
      - text: Show me the current Spreedly config for checkout.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/spreedly/bnpl/redirect'].get
  update:
    x-apievangelist-phrasing:
      intent: Handle a buy-now-pay-later redirect
      effect: read
      questions:
      - How do I handle the return from a Spreedly buy-now-pay-later checkout?
      - What happens when a shopper comes back from a BNPL payment for a cart?
      instructions:
      - text: Process the BNPL redirect for cart {cartId} with transaction token {transaction_token}.
        slots:
          cartId: query.parameters.cartId
          transaction_token: query.parameters.transaction_token
      - text: Complete the Spreedly buy-now-pay-later return for cart {cartId}.
        slots:
          cartId: query.parameters.cartId
      method: generated
      generated: '2026-09-26'