AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aftership Locations API

5 actions 5 updates phrasing extends openapi/aftership-locations-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['/locations'].get
$.paths['/locations'].post
$.paths['/locations/{id}'].get
$.paths['/locations/{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 Aftership Locations API
  version: 1.0.0
extends: openapi/aftership-locations-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['/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List store and warehouse locations
      effect: read
      questions:
      - How do I see all my warehouse and store locations?
      - Can I list only locations from a particular source?
      instructions:
      - text: List my locations.
      - text: Show locations from source {source}.
        slots:
          source: query.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a manual location
      effect: write
      questions:
      - How do I add a new warehouse or pickup location?
      - Can I set opening hours and pickup settings on a new location?
      instructions:
      - text: Create a location named {name} at {address}.
        slots:
          name: requestBody.name
          address: requestBody.address
      - text: Add location {name} at {address} in time zone {timezone_identifier}.
        slots:
          name: requestBody.name
          address: requestBody.address
          timezone_identifier: requestBody.timezone_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/locations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a location by ID
      effect: read
      questions:
      - What are the details of one of my locations?
      - Can I look up a location's address and hours by ID?
      instructions:
      - text: Show location {id}.
        slots:
          id: path.id
      - text: Get the address and opening hours for location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/locations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a location's details
      effect: write
      questions:
      - How do I change the opening hours of an existing location?
      - Can I rename a location without touching its other fields?
      instructions:
      - text: Rename location {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the opening hours of location {id} to {opening_hours}.
        slots:
          id: path.id
          opening_hours: requestBody.opening_hours
      method: generated
      generated: '2026-09-26'