Salla · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salla Shipping and Fulfillment Zones API

5 actions 5 updates phrasing extends openapi/salla-zones-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['/shipping/zones'].get
$.paths['/shipping/zones'].post
$.paths['/shipping/zones/{zone_id}'].get
$.paths['/shipping/zones/{zone_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 Shipping and Fulfillment Zones API
  version: 1.0.0
extends: openapi/salla-zones-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['/shipping/zones'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping zones
      effect: read
      questions:
      - Which shipping zones are set up in my store?
      - Can I see every zone with its delivery coverage?
      instructions:
      - text: List all shipping zones.
      - text: Show my configured shipping zones.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipping/zones'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shipping zone
      effect: write
      questions:
      - How do I add a new shipping zone for a region?
      - Can I set up a new delivery area?
      instructions:
      - text: Create a new shipping zone.
      - text: Add a delivery zone for my store.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipping/zones/{zone_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping zone
      effect: read
      questions:
      - What does one particular shipping zone include?
      - Can I fetch a single zone by ID?
      instructions:
      - text: Show shipping zone {zone_id}.
        slots:
          zone_id: path.zone_id
      - text: Get details of zone {zone_id}.
        slots:
          zone_id: path.zone_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipping/zones/{zone_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a shipping zone
      effect: write
      questions:
      - How do I change an existing shipping zone?
      - Can I edit the coverage of a zone I already set up?
      instructions:
      - text: Update shipping zone {zone_id}.
        slots:
          zone_id: path.zone_id
      - text: Edit the existing zone {zone_id}.
        slots:
          zone_id: path.zone_id
      method: generated
      generated: '2026-10-01'