Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Users API

8 actions 8 updates phrasing extends openapi/lightspeed-users-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 8

$.info

$.paths['/user'].get

$.paths['/users'].get

$.paths['/users/bulk'].post

$.paths['/users/{user_id}'].get

$.paths['/users/{user_id}'].delete

$.paths['/users/{user_id}/sale_totals'].get

$.paths['/users/{user_id}/sessions'].delete

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 Users API
  version: 1.0.0
extends: openapi/lightspeed-users-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: 7
- target: $.paths['/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the currently signed-in user
      effect: read
      questions:
      - Which user is my API token acting as?
      - How do I check who is currently logged in through the API?
      instructions:
      - text: Get the current user for this token.
      - text: Show me which account I'm authenticated as.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List staff users
      effect: read
      questions:
      - What staff user accounts exist in my store?
      - Can I page through all users on the account?
      instructions:
      - text: List all users on the account.
      - text: List users, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Get several users by their IDs
      effect: read
      questions:
      - Can I fetch multiple specific users in one request?
      - How do I look up a batch of users by ID?
      instructions:
      - text: Get these users by ID in one bulk request.
      - text: Fetch a batch of specific users by their IDs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single user
      effect: read
      questions:
      - How do I look up one staff member's user record?
      - What details are stored for a particular user?
      instructions:
      - text: Get user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show the details of staff user {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - How do I delete a staff member who has left?
      - Does deleting a user return the removed record?
      instructions:
      - text: Delete user {user_id}.
        slots:
          user_id: path.user_id
      - text: Remove the staff account {user_id} from the store.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_id}/sale_totals'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's sales totals
      effect: read
      questions:
      - How much has a particular staff member sold?
      - Where can I see sales totals for one user?
      instructions:
      - text: Get the sales totals for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show how much staff member {user_id} has sold.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_id}/sessions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Sign a user out of all sessions
      effect: destructive
      questions:
      - How do I force a user to log out everywhere?
      - Can I revoke all of a user's personal tokens at once?
      instructions:
      - text: Delete all sessions and personal tokens for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Log user {user_id} out of every session.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'