Xpansiv · OpenAPI Overlay 1.0.0

API Evangelist enrichment overlay for TIGRS Registry Client API

2 actions 2 updates update extends openapi/xpansiv-tigr-registry-client-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Xpansiv's API. It is a proposal applied on top of the contract, not a document Xpansiv publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-enrichmentx-idempotencyx-rate-limit-signalx-reversibility

Targets 2

$.info

$.paths['/api/ledger/retire'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enrichment overlay for TIGRS Registry Client API
  version: 1.0.0
extends: openapi/xpansiv-tigr-registry-client-openapi.yml
x-generated: '2026-09-04'
x-method: generated
x-source: Derived from openapi/xpansiv-tigr-registry-client-openapi.yml plus conventions/xpansiv-conventions.yml.
  Adds only API Evangelist annotations; changes no original schema, path, parameter or response.
actions:
- target: $.info
  description: Record API Evangelist enrichment provenance and the cross-cutting findings that are not
    expressible in the original contract.
  update:
    x-apievangelist-enrichment:
      profile: https://github.com/api-evangelist/xpansiv
      reviewed: '2026-09-04'
      source_spec: https://developer.xpansiv.com/_spec/openapi/...
      artifacts:
        authentication: authentication/xpansiv-authentication.yml
        conventions: conventions/xpansiv-conventions.yml
        errors: errors/xpansiv-problem-types.yml
        conformance: conformance/xpansiv-conformance.yml
        data_model: data-model/xpansiv-data-model.yml
        rate_limits: rate-limits/xpansiv-rate-limits.yml
        lifecycle: lifecycle/xpansiv-lifecycle.yml
    x-idempotency:
      coverage: none
      note: No Idempotency-Key or equivalent request header is declared on any operation in this contract.
        Duplicate submission is not suppressed by the API; clients must deduplicate. Observed by API Evangelist
        on 2026-09-04.
    x-rate-limit-signal:
      status_on_exhaustion: 429
      headers: []
      note: No Retry-After or RateLimit-* response header is declared or documented; retry interval is
        not discoverable from the response.
- target: $.paths['/api/ledger/retire'].post
  description: 'Mark this write as irreversible: no cancel, void, reverse or restore operation exists
    for it anywhere in the Xpansiv catalog.'
  update:
    x-reversibility:
      reversible: false
      reversal_operation: null
      window: null
      note: Terminal operation. Confirm program rules with getRegistryRules before calling, and confirm
        outcome afterwards rather than retrying blind (no idempotency key is supported).