AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Claim Shipments API

3 actions 3 updates phrasing extends openapi/aftership-claim-shipments-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['/claims/{claim_id}/shipments'].post
$.paths['/claims/{claim_id}/shipments/{shipment_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 Claim Shipments API
  version: 1.0.0
extends: openapi/aftership-claim-shipments-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['/claims/{claim_id}/shipments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shipment for a claim
      effect: write
      questions:
      - How do I send a replacement shipment for an approved claim?
      - Can I create an inbound return shipment for a claim that's in process?
      instructions:
      - text: Create a shipment for claim {claim_id}.
        slots:
          claim_id: path.claim_id
      - text: Generate an AfterShip label shipment for claim {claim_id}.
        slots:
          claim_id: path.claim_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/claims/{claim_id}/shipments/{shipment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a claim shipment and its label status
      effect: read
      questions:
      - Has the label for my claim shipment finished generating yet?
      - What are the details of one shipment attached to a claim?
      instructions:
      - text: Show shipment {shipment_id} on claim {claim_id}.
        slots:
          shipment_id: path.shipment_id
          claim_id: path.claim_id
      - text: Check whether the label for claim {claim_id} shipment {shipment_id} was created or failed.
        slots:
          claim_id: path.claim_id
          shipment_id: path.shipment_id
      method: generated
      generated: '2026-09-26'