AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Pickups API

4 actions 4 updates phrasing extends openapi/aftership-pickups-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 4

$.info

$.paths['/pickups'].get

$.paths['/pickups'].post

$.paths['/pickups/{id}'].get

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 Overview Pickups API
  version: 1.0.0
extends: openapi/aftership-pickups-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: 3
- target: $.paths['/pickups'].get
  update:
    x-apievangelist-phrasing:
      intent: List carrier pickups
      effect: read
      questions:
      - How do I see all the carrier pickups I've scheduled?
      - Can I filter pickups by status or date created?
      instructions:
      - text: List my pickups.
      - text: Show pickups with status {status} created after {created_at_min}.
        slots:
          status: query.status
          created_at_min: query.created_at_min
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pickups'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a carrier pickup
      effect: write
      questions:
      - How do I book a courier to collect my parcels?
      - Which carriers support scheduling a pickup?
      instructions:
      - text: Schedule a pickup from {pickup_from} between {pickup_start_time} and {pickup_end_time}.
        slots:
          pickup_from: requestBody.pickup_from
          pickup_start_time: requestBody.pickup_start_time
          pickup_end_time: requestBody.pickup_end_time
      - text: Book a pickup on {pickup_date} for labels {label_ids}.
        slots:
          pickup_date: requestBody.pickup_date
          label_ids: requestBody.label_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pickups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pickup by ID
      effect: read
      questions:
      - Is my scheduled pickup confirmed?
      - Can I look up one pickup's details by ID?
      instructions:
      - text: Get pickup {id}.
        slots:
          id: path.id
      - text: Check the status of pickup {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'