AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Email Parses API

3 actions 3 updates phrasing extends openapi/aftership-email-parses-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['/email-parses-v2'].post

$.paths['/email-parses'].post

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 Email Parses API
  version: 1.0.0
extends: openapi/aftership-email-parses-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['/email-parses-v2'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse order and tracking details from an email (V2)
      effect: read
      questions:
      - Can I extract tracking numbers from a raw shipping confirmation email's headers and body?
      - What does the V2 email parser need to read an order email?
      instructions:
      - text: Parse the email with headers {headers} and body {body} using V2.
        slots:
          headers: requestBody.headers
          body: requestBody.body
      - text: Extract order and tracking details from email body {body} for {country_region}.
        slots:
          body: requestBody.body
          country_region: requestBody.country_region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email-parses'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse order details from an email subject and sender
      effect: read
      questions:
      - How do I pull tracking info out of an email using just its subject and sender?
      - Does the original email parser accept the message content as well?
      instructions:
      - text: Parse the email from {from} with subject {subject}.
        slots:
          from: requestBody.from
          subject: requestBody.subject
      - text: Use the original parser on subject {subject}, sender {from} and content {content}.
        slots:
          subject: requestBody.subject
          from: requestBody.from
          content: requestBody.content
      method: generated
      generated: '2026-09-26'