AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Rates API

4 actions 4 updates phrasing extends openapi/aftership-rates-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['/rates'].get
$.paths['/rates'].post
$.paths['/rates/{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 Rates API
  version: 1.0.0
extends: openapi/aftership-rates-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['/rates'].get
  update:
    x-apievangelist-phrasing:
      intent: List past rate calculations
      effect: read
      questions:
      - Can I see the shipping rate quotes I've requested before?
      - How do I filter past rate calculations by status or date?
      instructions:
      - text: List my rate calculations.
      - text: Show rate requests with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rates'].post
  update:
    x-apievangelist-phrasing:
      intent: Calculate shipping rates
      effect: read
      questions:
      - How much will it cost to ship this package with each of my carriers?
      - Can I compare shipping rates across multiple shipper accounts?
      instructions:
      - text: Calculate rates for shipment {shipment} across shipper accounts {shipper_accounts}.
        slots:
          shipment: requestBody.shipment
          shipper_accounts: requestBody.shipper_accounts
      - text: Get shipping rates for {shipment} on {ship_date}.
        slots:
          shipment: requestBody.shipment
          ship_date: requestBody.ship_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rate calculation by ID
      effect: read
      questions:
      - Can I retrieve the result of a rate calculation later?
      - What rates came back for a particular rate request?
      instructions:
      - text: Get rate calculation {id}.
        slots:
          id: path.id
      - text: Show the results of rate request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'