AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Labels API

4 actions 4 updates phrasing extends openapi/aftership-labels-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['/labels'].get
$.paths['/labels'].post
$.paths['/labels/{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 Overview Labels API
  version: 1.0.0
extends: openapi/aftership-labels-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['/labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping labels
      effect: read
      questions:
      - How do I see all the shipping labels I've created?
      - Can I filter labels by shipper account, status or date?
      instructions:
      - text: List my shipping labels.
      - text: Show labels for shipper account {shipper_account_id} with status {status}.
        slots:
          shipper_account_id: query.shipper_account_id
          status: query.status
      - text: List labels created between {created_at_min} and {created_at_max}.
        slots:
          created_at_min: query.created_at_min
          created_at_max: query.created_at_max
      method: generated
      generated: '2026-09-26'
- target: $.paths['/labels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shipping label
      effect: write
      questions:
      - How do I print a shipping label for a package?
      - Can I create a return label or include customs info for international shipments?
      - Which paper sizes and file types can a label be generated in?
      instructions:
      - text: Create a label for shipment {shipment} using shipper account {shipper_account}.
        slots:
          shipment: requestBody.shipment
          shipper_account: requestBody.shipper_account
      - text: Buy a {service_type} label for order {order_number}.
        slots:
          service_type: requestBody.service_type
          order_number: requestBody.order_number
      - text: Generate a return label for {shipment} with customs {customs}.
        slots:
          shipment: requestBody.shipment
          customs: requestBody.customs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/labels/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping label by ID
      effect: read
      questions:
      - Can I retrieve a label I already created, including its file?
      - What's the status of a specific shipping label?
      instructions:
      - text: Get label {id}.
        slots:
          id: path.id
      - text: Show the details and download link for label {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'