Hifi · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Hifi API

2 actions 2 updates update extends openapi/hifi-openapi-original.json

Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-categoryx-apievangelist-idempotencyx-apievangelist-error-envelopex-apievangelist-webhooksx-apievangelist-notesx-apievangelist-reviewed

Targets 2

$.info

$.tags[*]

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Hifi API
  version: 1.0.0
extends: openapi/hifi-openapi-original.json
actions:
- target: $.info
  update:
    x-apievangelist-provider: hifi
    x-apievangelist-category: stablecoin-money-movement
    x-apievangelist-idempotency:
      supported: true
      field: requestId
      format: uuid-v4
    x-apievangelist-error-envelope: '{ code, error, errorDetails }'
    x-apievangelist-webhooks: asyncapi/hifi-webhooks.yml
    x-apievangelist-notes: >-
      The original spec declares no operationIds and no application/problem+json
      error responses; errors use a custom {code,error,errorDetails} envelope
      documented at docs.hifi.com/api/errors. Idempotency is client-driven via a
      requestId body field. Gaps to raise with the provider: add operationIds and
      formalize the error schema in-spec.
- target: $.tags[*]
  update:
    x-apievangelist-reviewed: true