Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Audit API

3 actions 3 updates phrasing extends openapi/lightspeed-audit-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 3

$.info

$.paths['/auditlog_events'].get

$.paths['/security_events'].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 Audit API
  version: 1.0.0
extends: openapi/lightspeed-audit-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['/auditlog_events'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit log events
      effect: read
      questions:
      - Who changed customers, registers or outlets in my store and when?
      - Can I filter audit events by user, type or a time window?
      - Which changes are actually recorded in the audit log?
      instructions:
      - text: List audit events between {from} and {to}.
        slots:
          from: query.from
          to: query.to
      - text: Show audit events by user {user}.
        slots:
          user: query.user_id
      - text: List audit log events of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/security_events'].get
  update:
    x-apievangelist-phrasing:
      intent: List my security events
      effect: read
      questions:
      - What sign-ins and security events are recorded for my own account?
      - Can I review security activity for the user I'm logged in as?
      instructions:
      - text: List the security events for my user.
      - text: Show recent security log activity on my own account.
      method: generated
      generated: '2026-09-26'