Veho · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the Veho API

4 actions 4 updates update extends openapi/veho-api-openapi-original.yml
Generated by API Evangelist Written by API Evangelist tooling for Veho's API. It is a proposal applied on top of the contract, not a document Veho publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelistx-support-emailx-notesx-deprecatedx-deprecation-source

Targets 3

$.info
$.servers[1]
$.tags[?(@.name=='pickups')]

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for the Veho API
  version: 1.0.0
x-generated: '2026-07-21'
x-method: generated
extends: openapi/veho-api-openapi-original.yml
actions:
  - target: $.info
    description: Tag the spec with API Evangelist enrichment metadata and canonical artifact cross-links.
    update:
      x-apievangelist:
        provider: veho
        enriched: '2026-07-21'
        artifacts:
          authentication: authentication/veho-authentication.yml
          conventions: conventions/veho-conventions.yml
          errors: errors/veho-problem-types.yml
          webhooks: asyncapi/veho-webhooks.yml
          sandbox: sandbox/veho-sandbox.yml
          lifecycle: lifecycle/veho-lifecycle.yml
          data-model: data-model/veho-data-model.yml
  - target: $.info
    description: Surface the docs-published support contact for API issues.
    update:
      x-support-email: api@shipveho.com
  - target: $.servers[1]
    description: Note that the sandbox uses a separate API key and a subset of serviceable ZIP codes.
    update:
      x-notes: >-
        Sandbox uses a separate API key issued by Veho and contains a subset
        of serviceable ZIP codes; GET /serviceable-zips is unauthenticated.
  - target: $.tags[?(@.name=='pickups')]
    description: Mark the pickups tag as deprecated per the 2025-01-31 changelog entry.
    update:
      x-deprecated: true
      x-deprecation-source: https://docs.api.shipveho.com/docs/veho-api/gkxy75st2tf4y-changelog