Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Integration Job Es Logs API

3 actions 3 updates phrasing extends openapi/optimizely-integration-job-es-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/IntegrationJobEsLogs'].get

$.paths['/api/v1/admin/IntegrationJobEsLogs(\'{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 Integration Job Es Logs API
  version: 1.0.0
extends: openapi/optimizely-integration-job-es-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/IntegrationJobEsLogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration job log entries
      effect: read
      questions:
      - Where can I see the log output from integration jobs in Optimizely Commerce?
      - Can I filter and page through integration job logs instead of pulling them all?
      instructions:
      - text: List integration job log entries.
      - text: Show integration job logs matching {filter}, top {top}.
        slots:
          filter: query.$filter
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobEsLogs(\'{id}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one integration job log entry
      effect: read
      questions:
      - What does a single integration job log entry contain?
      - Can I pull up one job log record by its id?
      instructions:
      - text: Fetch integration job log entry {id}.
        slots:
          id: path.id
      - text: Show the details of job log {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'