AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Return items API

3 actions 3 updates phrasing extends openapi/aftership-return-items-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['/returns/{return_id}/items/{item_id}'].patch

$.paths['/returns/rma/{rma_number}/items/{item_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 Return items API
  version: 1.0.0
extends: openapi/aftership-return-items-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['/returns/{return_id}/items/{item_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a return item by return ID
      effect: write
      questions:
      - How do I update an item on a return when I have the return ID?
      - Can I edit one item on a return identified by its internal return ID?
      instructions:
      - text: Update item {item_id} on return {return_id}.
        slots:
          item_id: path.item_id
          return_id: path.return_id
      - text: Edit return {return_id}'s item {item_id} using the return ID.
        slots:
          return_id: path.return_id
          item_id: path.item_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/returns/rma/{rma_number}/items/{item_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a return item by RMA number
      effect: write
      questions:
      - Can I update a return item using the customer-facing RMA number?
      - How do I edit one item on a return when I only know the RMA?
      instructions:
      - text: Update item {item_id} on the return with RMA {rma_number}.
        slots:
          item_id: path.item_id
          rma_number: path.rma_number
      - text: Edit RMA {rma_number} item {item_id}.
        slots:
          rma_number: path.rma_number
          item_id: path.item_id
      method: generated
      generated: '2026-09-26'