Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Channel Request Log API

5 actions 5 updates phrasing extends openapi/lightspeed-channel-request-log-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Lightspeed Commerce's API. It is a proposal applied on top of the contract, not a document Lightspeed Commerce publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/channel_requests'].get

$.paths['/channel_requests/{request_log_id}'].get

$.paths['/channel_requests/{request_log_id}.txt'].get

$.paths['/channels'].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 2026-07 Channel Request Log API
  version: 1.0.0
extends: openapi/lightspeed-channel-request-log-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: 4
- target: $.paths['/channel_requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List channel request log records
      effect: read
      questions:
      - Which requests to my sales channel failed with an error status?
      - Can I filter channel request logs by time range and HTTP method?
      instructions:
      - text: List channel request logs with status code {status_code}.
        slots:
          status_code: query.status_code
      - text: Show request logs for channel {channel_id} that occurred after {occurred_after}.
        slots:
          channel_id: query.channel_id
          occurred_after: query.occurred_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/channel_requests/{request_log_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single channel request log
      effect: read
      questions:
      - How do I inspect one channel request log entry in detail?
      - What did a specific channel request return?
      instructions:
      - text: Get channel request log {request_log_id}.
        slots:
          request_log_id: path.request_log_id
      - text: Show the structured details of request log entry {request_log_id}.
        slots:
          request_log_id: path.request_log_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/channel_requests/{request_log_id}.txt'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a channel request log as plain text
      effect: read
      questions:
      - Can I download a request log entry as plain text?
      - Is there a text version of a channel request log for sharing with support?
      instructions:
      - text: Get request log {request_log_id} as a text file.
        slots:
          request_log_id: path.request_log_id
      - text: Export the plain-text version of channel request log {request_log_id}.
        slots:
          request_log_id: path.request_log_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured sales channels
      effect: read
      questions:
      - Which sales channels are configured on my store?
      - Where do I find the channel ID to filter request logs by?
      instructions:
      - text: List the configured channels.
      - text: Show all channel records and their IDs.
      method: generated
      generated: '2026-09-26'