AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Specific Shipper Accounts API

3 actions 3 updates phrasing extends openapi/aftership-specific-shipper-accounts-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 3

$.info
$.paths['/couriers/fedex/shipper-accounts'].post
$.paths['/couriers/fedex/shipper-accounts/{id}/update'].post

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 Specific Shipper Accounts API
  version: 1.0.0
extends: openapi/aftership-specific-shipper-accounts-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: 2
- target: $.paths['/couriers/fedex/shipper-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a FedEx shipper account
      effect: write
      questions:
      - How do I connect my FedEx account for label creation?
      - Can I set up a FedEx Ground Economy shipper account through the API?
      instructions:
      - text: Create a {slug} shipper account {description} with credentials {credentials}, address {address} and invoice {invoice}.
        slots:
          slug: requestBody.slug
          description: requestBody.description
          credentials: requestBody.credentials
          address: requestBody.address
          invoice: requestBody.invoice
      - text: Register FedEx account {description} using invoice details {invoice}.
        slots:
          description: requestBody.description
          invoice: requestBody.invoice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/couriers/fedex/shipper-accounts/{id}/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a legacy FedEx shipper account
      effect: write
      questions:
      - How do I update a legacy FedEx shipper account?
      - Why does updating a FedEx account require invoice details?
      instructions:
      - text: Update FedEx shipper account {id} with invoice {invoice}.
        slots:
          id: path.id
          invoice: requestBody.invoice
      - text: Refresh the address on legacy FedEx account {id} to {address} using invoice {invoice}.
        slots:
          id: path.id
          address: requestBody.address
          invoice: requestBody.invoice
      method: generated
      generated: '2026-09-26'