Salla · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salla Merchant Customers API

5 actions 5 updates phrasing extends openapi/salla-customers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Salla's API. It is a proposal applied on top of the contract, not a document Salla publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/customers'].get
$.paths['/customers'].post
$.paths['/customers/{customer_id}'].get
$.paths['/customers/{customer_id}'].put

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 Salla Merchant Customers API
  version: 1.0.0
extends: openapi/salla-customers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/customers'].get
  update:
    x-apievangelist-phrasing:
      intent: List store customers
      effect: read
      questions:
      - Who are the customers registered in my Salla store?
      - Can I page through my customer list a set number at a time?
      instructions:
      - text: List my store's customers.
      - text: Show page {page} of customers, {per_page} per page.
        slots:
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new customer
      effect: write
      questions:
      - How do I register a new customer in my store?
      - What details are required to create a customer record?
      - Can I put a new customer into customer groups when I create them?
      instructions:
      - text: Create a customer named {first_name} with mobile {mobile_code} {mobile}.
        slots:
          first_name: requestBody.first_name
          mobile_code: requestBody.mobile_code
          mobile: requestBody.mobile
      - text: Add new customer {first_name} {last_name}, phone {mobile_code} {mobile}, email {email}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          mobile_code: requestBody.mobile_code
          mobile: requestBody.mobile
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer's details
      effect: read
      questions:
      - What information do I have on a specific customer?
      - Can I look up one customer by their ID?
      instructions:
      - text: Show me customer {customer_id}.
        slots:
          customer_id: path.customer_id
      - text: Get the profile of customer {customer_id}.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customer_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer's details
      effect: write
      questions:
      - How do I change an existing customer's phone number or email?
      - Can I edit the city or birthday on a customer I already have?
      instructions:
      - text: Update customer {customer_id} to mobile {mobile_code} {mobile} with first name {first_name}.
        slots:
          customer_id: path.customer_id
          mobile_code: requestBody.mobile_code
          mobile: requestBody.mobile
          first_name: requestBody.first_name
      - text: Change the email of existing customer {customer_id} to {email}, keeping name {first_name} and phone {mobile_code} {mobile}.
        slots:
          customer_id: path.customer_id
          email: requestBody.email
          first_name: requestBody.first_name
          mobile_code: requestBody.mobile_code
          mobile: requestBody.mobile
      method: generated
      generated: '2026-10-01'