AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Warranty Registrations API

4 actions 4 updates phrasing extends openapi/aftership-warranty-registrations-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['/orders/warranty-registrations'].get
$.paths['/warranty-registrations/{warranty_registration_id}'].patch
$.paths['/warranty-registrations/{warranty_registration_id}/invalidate'].post

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 Warranty Registrations API
  version: 1.0.0
extends: openapi/aftership-warranty-registrations-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['/orders/warranty-registrations'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up warranty registrations for an order
      effect: read
      questions:
      - Which items in a customer's order have registered warranties?
      - Can I see invalid warranty registrations as well as valid ones?
      instructions:
      - text: Show warranty registrations for order {order_number} and email {customer_email}.
        slots:
          order_number: query.order_number
          customer_email: query.customer_email
      - text: Look up the warranty history of order {order_number} for {customer_email}.
        slots:
          order_number: query.order_number
          customer_email: query.customer_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/warranty-registrations/{warranty_registration_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a warranty registration
      effect: write
      questions:
      - How do I extend the expiry of a warranty registration?
      - Can I change the plan name or benefits on a warranty?
      instructions:
      - text: Set warranty registration {warranty_registration_id} to expire at {expired_at}.
        slots:
          warranty_registration_id: path.warranty_registration_id
          expired_at: requestBody.expired_at
      - text: Change the plan on warranty {warranty_registration_id} to {plan_name}.
        slots:
          warranty_registration_id: path.warranty_registration_id
          plan_name: requestBody.plan_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/warranty-registrations/{warranty_registration_id}/invalidate'].post
  update:
    x-apievangelist-phrasing:
      intent: Invalidate a warranty registration
      effect: destructive
      questions:
      - How do I void a customer's warranty registration?
      - What happens to benefits when a warranty registration is invalidated?
      instructions:
      - text: Invalidate warranty registration {warranty_registration_id} because {reason}.
        slots:
          warranty_registration_id: path.warranty_registration_id
          reason: requestBody.reason
      - text: Mark warranty {warranty_registration_id} invalid with reason {reason}.
        slots:
          warranty_registration_id: path.warranty_registration_id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'