Salla · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salla Merchant Branches API

4 actions 4 updates phrasing extends openapi/salla-branches-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 4

$.info
$.paths['/branches'].get
$.paths['/branches'].post
$.paths['/branches/{branch_id}'].get

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 Branches API
  version: 1.0.0
extends: openapi/salla-branches-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: 3
- target: $.paths['/branches'].get
  update:
    x-apievangelist-phrasing:
      intent: List the store's branches
      effect: read
      questions:
      - Which physical branches does my Salla store have set up?
      - Can I see all of my store's branch locations in one list?
      instructions:
      - text: List all of my store branches.
      - text: Show every branch configured for the store.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branches'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new store branch
      effect: write
      questions:
      - How do I add a new branch location to my Salla store?
      - Can I register another pickup branch for the shop?
      instructions:
      - text: Create a new branch for my store.
      - text: Add a new store branch location.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/branches/{branch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store branch
      effect: read
      questions:
      - What details are stored for a specific branch of my shop?
      - Can I look up a single branch by its ID?
      instructions:
      - text: Show me the details of branch {branch_id}.
        slots:
          branch_id: path.branch_id
      - text: Get store branch {branch_id}.
        slots:
          branch_id: path.branch_id
      method: generated
      generated: '2026-10-01'