AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Stores API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/stores'].get
$.paths['/stores'].post
$.paths['/stores/{id}'].get
$.paths['/stores/{id}'].patch

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 Overview Stores API
  version: 1.0.0
extends: openapi/aftership-stores-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/stores'].get
  update:
    x-apievangelist-phrasing:
      intent: List stores
      effect: read
      questions:
      - How do I see all the stores in my Commerce account?
      - Can I fetch several stores at once by ID?
      instructions:
      - text: List my stores.
      - text: Get stores {ids}.
        slots:
          ids: query.ids[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stores'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a store
      effect: write
      questions:
      - How do I create a new store before pushing orders and products?
      - Which fields are required when creating a store?
      instructions:
      - text: Create a store named {name} using currency {currency}.
        slots:
          name: requestBody.name
          currency: requestBody.currency
      - text: Set up store {name} in {currency} with support email {support_email}.
        slots:
          name: requestBody.name
          currency: requestBody.currency
          support_email: requestBody.support_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stores/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a store by ID
      effect: read
      questions:
      - What are the settings of a specific store?
      - Can I look up one store by its ID?
      instructions:
      - text: Show store {id}.
        slots:
          id: path.id
      - text: Get the details of store {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stores/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a store's details
      effect: write
      questions:
      - Can I change a store's support email or phone?
      - How do I update a store's weight unit or time zone?
      instructions:
      - text: Change the support email of store {id} to {support_email}.
        slots:
          id: path.id
          support_email: requestBody.support_email
      - text: Rename store {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'