Salla · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salla Merchant Brands API

6 actions 6 updates phrasing extends openapi/salla-brands-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 6

$.info

$.paths['/brands'].get

$.paths['/brands'].post

$.paths['/brands/{brand_id}'].get

$.paths['/brands/{brand_id}'].put

$.paths['/brands/{brand_id}'].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 Salla Merchant Brands API
  version: 1.0.0
extends: openapi/salla-brands-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: 5
- target: $.paths['/brands'].get
  update:
    x-apievangelist-phrasing:
      intent: List product brands
      effect: read
      questions:
      - Which brands are set up in my Salla store?
      - Can I see every product brand the shop carries?
      instructions:
      - text: List all brands in my store.
      - text: Show the store's brand catalog.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/brands'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product brand
      effect: write
      questions:
      - How do I add a new brand to my store?
      - Can I create a brand before assigning products to it?
      instructions:
      - text: Create a new brand in my store.
      - text: Add a brand to the store catalog.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/brands/{brand_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand's details
      effect: read
      questions:
      - What information is saved for a specific brand?
      - Can I fetch one brand by its ID?
      instructions:
      - text: Show me brand {brand_id}.
        slots:
          brand_id: path.brand_id
      - text: Get the details of brand {brand_id}.
        slots:
          brand_id: path.brand_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/brands/{brand_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a brand
      effect: write
      questions:
      - How do I edit an existing brand's details?
      - Can I rename a brand that is already in my store?
      instructions:
      - text: Update brand {brand_id}.
        slots:
          brand_id: path.brand_id
      - text: Edit the existing brand {brand_id} in my store.
        slots:
          brand_id: path.brand_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/brands/{brand_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a brand
      effect: destructive
      questions:
      - How do I remove a brand I no longer sell?
      - Can I permanently delete a brand from the store?
      instructions:
      - text: Delete brand {brand_id}.
        slots:
          brand_id: path.brand_id
      - text: Remove brand {brand_id} from my store.
        slots:
          brand_id: path.brand_id
      method: generated
      generated: '2026-10-01'