Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lightspeed Restaurant K Series PMS API

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

$.info
$.paths['/pms/v1/business-locations/{businessLocationId}/revenue-centers'].get
$.paths['/pms/v1/providers/{id}'].get
$.paths['/pms/v1/providers/{id}'].put
$.paths['/pms/v1/providers/{id}'].delete
$.paths['/pms/v1/providers'].get
$.paths['/pms/v1/providers'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lightspeed Restaurant K Series PMS API
  version: 1.0.0
extends: openapi/lightspeed-pms-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: 6
- target: $.paths['/pms/v1/business-locations/{businessLocationId}/revenue-centers'].get
  update:
    x-apievangelist-phrasing:
      intent: List POS configurations for PMS revenue centers
      effect: read
      questions:
      - Which POS configurations can I map to hotel PMS revenue centers?
      - How do I find revenue centers for a business location?
      instructions:
      - text: List the revenue centers for business location {businessLocationId}.
        slots:
          businessLocationId: path.businessLocationId
      - text: Show POS configurations I can map to PMS revenue centers at location {businessLocationId}.
        slots:
          businessLocationId: path.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pms/v1/providers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a PMS provider
      effect: read
      questions:
      - How do I see the settings of a PMS provider I created?
      - Can I fetch a PMS provider created by another OAuth client?
      instructions:
      - text: Get PMS provider {id}.
        slots:
          id: path.id
      - text: Show the endpoint and features of PMS provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pms/v1/providers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a PMS provider
      effect: write
      questions:
      - How do I change the endpoint or API key for my PMS provider?
      - Can I update the features enabled on an existing PMS provider?
      instructions:
      - text: Update PMS provider {id} to use endpoint {endpoint} and API key {apiKey}.
        slots:
          id: path.id
          endpoint: requestBody.endpoint
          apiKey: requestBody.apiKey
      - text: Rename existing PMS provider {id} to {name} with features {features}.
        slots:
          id: path.id
          name: requestBody.name
          features: requestBody.features
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pms/v1/providers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a PMS provider
      effect: destructive
      questions:
      - How do I permanently remove a PMS integration from a location?
      - Can I disconnect a hotel PMS provider I no longer use?
      instructions:
      - text: Delete PMS provider {id}.
        slots:
          id: path.id
      - text: Permanently remove PMS provider {id} from its business location.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pms/v1/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List PMS providers
      effect: read
      questions:
      - Which PMS providers have I configured for my locations?
      - Can I filter PMS providers by business location?
      instructions:
      - text: List the PMS providers I have configured.
      - text: List PMS providers for business location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pms/v1/providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a PMS provider
      effect: write
      questions:
      - How do I connect a property management system to a restaurant location?
      - What details do I need to register a new PMS provider?
      instructions:
      - text: Create PMS provider {name} at location {businessLocationId} with endpoint {endpoint} and API key {apiKey}.
        slots:
          name: requestBody.name
          businessLocationId: requestBody.businessLocationId
          endpoint: requestBody.endpoint
          apiKey: requestBody.apiKey
      - text: Register a new PMS provider for location {businessLocationId} with features {features}.
        slots:
          businessLocationId: requestBody.businessLocationId
          features: requestBody.features
      method: generated
      generated: '2026-09-26'