Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Spire Logs API

3 actions 3 updates phrasing extends openapi/optimizely-spire-logs-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/admin/SpireLogs'].get

$.paths['/api/v1/admin/SpireLogs(\'{id}\')'].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 Admin API V1 Spire Logs API
  version: 1.0.0
extends: openapi/optimizely-spire-logs-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/admin/SpireLogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List Spire storefront log entries
      effect: read
      questions:
      - How do I browse the Spire logs from the commerce admin API?
      - Can I filter Spire log entries and sort them newest first?
      instructions:
      - text: List all Spire log entries.
      - text: List Spire logs matching {filter}, ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      - text: Show the latest {top} Spire log entries.
        slots:
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SpireLogs(\'{id}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Spire log entry
      effect: read
      questions:
      - How do I open a single Spire log entry by its ID?
      - Can I select only certain fields of one Spire log record?
      instructions:
      - text: Get Spire log entry {id}.
        slots:
          id: path.id
      - text: Show fields {select} of Spire log {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-09-26'