AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Courier connection API

6 actions 6 updates phrasing extends openapi/aftership-courier-connection-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 6

$.info

$.paths['/courier-connections'].get

$.paths['/courier-connections'].post

$.paths['/courier-connections/{id}'].get

$.paths['/courier-connections/{id}'].delete

$.paths['/courier-connections/{id}'].patch

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 Courier connection API
  version: 1.0.0
extends: openapi/aftership-courier-connection-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: 5
- target: $.paths['/courier-connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List courier connections
      effect: read
      questions:
      - How do I see all the carrier accounts I've connected for tracking?
      - Can I list courier connections for just one carrier?
      instructions:
      - text: List my courier connections.
      - text: Show my courier connections for {courier_slug}.
        slots:
          courier_slug: query.courier_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/courier-connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a courier account with credentials
      effect: write
      questions:
      - How do I connect my own carrier account so tracking uses its credentials?
      - Can I add a new courier connection for a carrier?
      instructions:
      - text: Connect courier {courier_slug} using credentials {credentials}.
        slots:
          courier_slug: requestBody.courier_slug
          credentials: requestBody.credentials
      - text: Add a new {courier_slug} courier connection.
        slots:
          courier_slug: requestBody.courier_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/courier-connections/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one courier connection
      effect: read
      questions:
      - What are the details of a single courier connection?
      - Can I look up a courier connection by its ID?
      instructions:
      - text: Show courier connection {id}.
        slots:
          id: path.id
      - text: Get the details of courier connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/courier-connections/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a courier connection
      effect: destructive
      questions:
      - How do I disconnect a carrier account I no longer use?
      - Can I remove a courier connection permanently?
      instructions:
      - text: Delete courier connection {id}.
        slots:
          id: path.id
      - text: Disconnect and remove courier connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/courier-connections/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a courier connection's credentials
      effect: write
      questions:
      - How do I update the credentials on an existing courier connection?
      - Can I rotate the password for a connected carrier account?
      instructions:
      - text: Update courier connection {id} with credentials {credentials}.
        slots:
          id: path.id
          credentials: requestBody.credentials
      - text: Replace the credentials on courier connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'