Salla · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salla Merchant Products API

9 actions 9 updates phrasing extends openapi/salla-products-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 9

$.info
$.paths['/products'].get
$.paths['/products'].post
$.paths['/products/{product_id}'].get
$.paths['/products/{product_id}'].put
$.paths['/products/{product_id}'].delete
$.paths['/products/{product_id}/skus'].get
$.paths['/products/options'].post
$.paths['/products/quantities'].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 Products API
  version: 1.0.0
extends: openapi/salla-products-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: 8
- target: $.paths['/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search products
      effect: read
      questions:
      - Which products are in my Salla store catalog?
      - Can I search products by name or SKU?
      - Is it possible to filter products by category or status?
      instructions:
      - text: Find products matching {keyword}.
        slots:
          keyword: query.keyword
      - text: List products in category {category} with status {status}.
        slots:
          category: query.category
          status: query.status
      - text: Show page {page} of products, {per_page} per page.
        slots:
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new product
      effect: write
      questions:
      - How do I add a new product to my store?
      - What fields are required to create a product?
      - Can I set a sale price and SKU when creating a product?
      instructions:
      - text: Create a {product_type} product named {name} priced at {price}.
        slots:
          product_type: requestBody.product_type
          name: requestBody.name
          price: requestBody.price
      - text: Add new product {name} at {price}, type {product_type}, with SKU {sku} and {quantity} in stock.
        slots:
          name: requestBody.name
          price: requestBody.price
          product_type: requestBody.product_type
          sku: requestBody.sku
          quantity: requestBody.quantity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{product_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product's details
      effect: read
      questions:
      - What details are stored for a specific product?
      - Can I fetch one product by its ID?
      instructions:
      - text: Show me product {product_id}.
        slots:
          product_id: path.product_id
      - text: Get the details of product {product_id}.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{product_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a product
      effect: write
      questions:
      - How do I change the price of an existing product?
      - Can I edit an existing product's sale dates or description?
      instructions:
      - text: Update product {product_id} to name {name}, price {price}, type {product_type}.
        slots:
          product_id: path.product_id
          name: requestBody.name
          price: requestBody.price
          product_type: requestBody.product_type
      - text: Put existing product {product_id} on sale at {sale_price}, keeping name {name}, price {price} and type {product_type}.
        slots:
          product_id: path.product_id
          sale_price: requestBody.sale_price
          name: requestBody.name
          price: requestBody.price
          product_type: requestBody.product_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{product_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product
      effect: destructive
      questions:
      - How do I remove a product from my store?
      - Can I permanently delete a product I no longer sell?
      instructions:
      - text: Delete product {product_id}.
        slots:
          product_id: path.product_id
      - text: Remove product {product_id} from the catalog.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{product_id}/skus'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's SKUs
      effect: read
      questions:
      - What variants and SKUs does a product have?
      - Can I see every SKU under one product?
      instructions:
      - text: List the SKUs of product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show variants for product {product_id}.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/options'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product option
      effect: write
      questions:
      - How do I add an option like size or color to products?
      - Can I create a new product option?
      instructions:
      - text: Create a new product option.
      - text: Add a size or color option for products.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/quantities'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update product stock
      effect: write
      questions:
      - How do I update stock levels for several products at once?
      - Can I adjust inventory quantities in bulk?
      instructions:
      - text: Update stock quantities for my products.
      - text: Bulk-adjust product inventory levels.
      method: generated
      generated: '2026-10-01'