AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Manifests API

4 actions 4 updates phrasing extends openapi/aftership-manifests-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['/manifests'].get
$.paths['/manifests'].post
$.paths['/manifests/{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 Manifests API
  version: 1.0.0
extends: openapi/aftership-manifests-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['/manifests'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping manifests
      effect: read
      questions:
      - How do I see the end-of-day manifests I've created?
      - Can I filter manifests by shipper account or status?
      instructions:
      - text: List my manifests.
      - text: Show manifests for shipper account {shipper_account_id}.
        slots:
          shipper_account_id: query.shipper_account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/manifests'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a manifest for labels
      effect: write
      questions:
      - How do I create an end-of-day manifest for my labels?
      - Can I manifest only specific labels?
      instructions:
      - text: Create a manifest for shipper account {shipper_account}.
        slots:
          shipper_account: requestBody.shipper_account
      - text: Manifest labels {label_ids}.
        slots:
          label_ids: requestBody.label_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/manifests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a manifest by ID
      effect: read
      questions:
      - What's in a specific manifest?
      - Is a particular manifest finished processing?
      instructions:
      - text: Get manifest {id}.
        slots:
          id: path.id
      - text: Check the status of manifest {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'