AfterShip · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Overview Address Validations (Beta) API

2 actions 2 updates phrasing extends openapi/aftership-address-validations-beta-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['/address-validations'].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 Address Validations (Beta) API
  version: 1.0.0
extends: openapi/aftership-address-validations-beta-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['/address-validations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a beta address validation
      effect: read
      questions:
      - Can I run an address through the beta address validation check?
      - What does the older beta address-validations endpoint return for an address?
      instructions:
      - text: Run a beta address validation on {address}.
        slots:
          address: requestBody.address
      - text: Use the beta address-validations endpoint to check {address}.
        slots:
          address: requestBody.address
      method: generated
      generated: '2026-09-26'