AfterShip · OpenAPI Overlay 1.0.0

API Evangelist enrichment overlay — Overview Address Validations (Beta) API

2 actions 2 updates update 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-providerx-provider-idx-apis-iox-docsx-envelopex-error-catalogx-rate-limitsx-conventions

Targets 2

$.info

$.components.securitySchemes

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enrichment overlay — Overview Address Validations (Beta) API
  version: 1.0.0
extends: openapi/aftership-address-validations-beta-api-openapi.yml
x-generated: '2026-08-27'
x-method: generated
x-source: apis.yml + conventions/, errors/, rate-limits/, authentication/, lifecycle/ in this repo
actions:
- target: $.info
  update:
    x-provider: AfterShip
    x-provider-id: aftership
    x-apis-io: https://apis.io/provider/aftership
    x-docs: https://www.aftership.com/docs
    x-envelope: '{"meta":{...},"data":{...}} — branch on meta.code, not the HTTP status'
    x-error-catalog: errors/aftership-problem-types.yml
    x-rate-limits: rate-limits/aftership-rate-limits.yml
    x-conventions: conventions/aftership-conventions.yml
    x-lifecycle: lifecycle/aftership-lifecycle.yml
    x-idempotency: not supported — no Idempotency-Key header on any AfterShip API
    x-versioning: date-based path segment (YYYY-MM); as-api-version response header
- target: $.components.securitySchemes
  update:
    x-additional-methods-documented: AES/HMAC-SHA256 request signing and OAuth 2.0 are documented by AfterShip but
      are not expressed in this spec — see authentication/aftership-authentication.yml