Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Storefront API V1 Applepay API

3 actions 3 updates phrasing extends openapi/optimizely-apple-pay-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/applepay/session'].post

$.paths['/api/v1/applepay/config'].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 Storefront API V1 Applepay API
  version: 1.0.0
extends: openapi/optimizely-apple-pay-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/api/v1/applepay/session'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate an Apple Pay merchant session
      effect: write
      questions:
      - How does my storefront validate an Apple Pay merchant session before checkout?
      - Which domain name do I pass when starting an Apple Pay session?
      instructions:
      - text: Validate an Apple Pay session using validation URL {validationUrl}.
        slots:
          validationUrl: requestBody.validationUrl
      - text: Start an Apple Pay merchant session for domain {domainName} with validation URL {validationUrl}.
        slots:
          domainName: requestBody.domainName
          validationUrl: requestBody.validationUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/applepay/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Apple Pay configuration
      effect: read
      questions:
      - Is Apple Pay configured for my commerce storefront?
      - What Apple Pay settings does the site currently expose?
      instructions:
      - text: Get the Apple Pay configuration.
      - text: Show the current Apple Pay settings for the storefront.
      method: generated
      generated: '2026-10-01'