AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Address API

2 actions 2 updates phrasing extends openapi/aftership-address-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 2

$.info
$.paths['/addresses/validate'].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 Address API
  version: 1.0.0
extends: openapi/aftership-address-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: 1
- target: $.paths['/addresses/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate and standardize a shipping address
      effect: read
      questions:
      - How do I check that a shipping address is valid before I print a label?
      - Can AfterShip standardize a messy address into a carrier-approved format?
      - Is it possible to validate an address against a specific carrier's rules?
      instructions:
      - text: Validate and standardize the address {request_address}.
        slots:
          request_address: requestBody.request_address
      - text: Check {request_address} against the {carrier_slug} carrier's address rules.
        slots:
          request_address: requestBody.request_address
          carrier_slug: requestBody.carrier_slug
      - text: Validate {request_address} and give me at most {max_address_response} suggested matches.
        slots:
          request_address: requestBody.request_address
          max_address_response: requestBody.max_address_response
      method: generated
      generated: '2026-09-26'