AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Cancel Labels API

4 actions 4 updates phrasing extends openapi/aftership-cancel-labels-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['/cancel-labels'].get

$.paths['/cancel-labels'].post

$.paths['/cancel-labels/{id}'].get

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 Cancel Labels API
  version: 1.0.0
extends: openapi/aftership-cancel-labels-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['/cancel-labels'].get
  update:
    x-apievangelist-phrasing:
      intent: List cancelled shipping labels
      effect: read
      questions:
      - How do I see all the shipping labels I've cancelled?
      - Can I filter cancelled labels by shipper account or cancellation status?
      - Which labels were cancelled within a given date range?
      instructions:
      - text: List my cancelled labels.
      - text: Show cancelled labels for shipper account {shipper_account_id}.
        slots:
          shipper_account_id: query.shipper_account_id
      - text: List cancelled labels with status {status} created after {created_at_min}.
        slots:
          status: query.status
          created_at_min: query.created_at_min
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cancel-labels'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a shipping label
      effect: destructive
      questions:
      - How do I void a shipping label I no longer need?
      - Can I cancel a label after it has been created so I'm not charged?
      instructions:
      - text: Cancel shipping label {label}.
        slots:
          label: requestBody.label
      - text: Void the label {label} I created by mistake.
        slots:
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cancel-labels/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one cancelled label's details
      effect: read
      questions:
      - What is the status of a specific label cancellation request?
      - Can I look up a single cancel-label record by its ID?
      instructions:
      - text: Show the cancellation record {id}.
        slots:
          id: path.id
      - text: Check whether label cancellation {id} succeeded.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'