0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive Data Quality API

9 actions 9 updates phrasing extends openapi/0xarchive-data-quality-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info

$.paths['/v1/data-quality/status'].get

$.paths['/v1/data-quality/coverage'].get

$.paths['/v1/data-quality/coverage/{exchange}'].get

$.paths['/v1/data-quality/coverage/{exchange}/{symbol}'].get

$.paths['/v1/data-quality/incidents'].get

$.paths['/v1/data-quality/incidents/{id}'].get

$.paths['/v1/data-quality/latency'].get

$.paths['/v1/data-quality/sla'].get

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 0xArchive Data Quality API
  version: 1.0.0
extends: openapi/0xarchive-data-quality-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: 8
- target: $.paths['/v1/data-quality/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check overall data system health
      effect: read
      questions:
      - Is any exchange or data type currently degraded?
      - What is the overall data system status per exchange and data type?
      instructions:
      - text: Get the overall data quality system status.
      - text: Show me the per-exchange and per-data-type health status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/data-quality/coverage'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize data coverage across venues
      effect: read
      questions:
      - How far back does archived data go for each venue family?
      - What completeness and record counts does the coverage summary include?
      instructions:
      - text: Get the data coverage summary for all venue families.
      - text: Show earliest and latest data and completeness across every venue.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/data-quality/coverage/{exchange}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get data coverage for one exchange
      effect: read
      questions:
      - What data coverage exists for a single exchange like Lighter?
      - Why does the per-exchange coverage call sometimes take 30-60 seconds?
      instructions:
      - text: Get data coverage for exchange {exchange}.
        slots:
          exchange: path.exchange
      - text: Show how much history is archived for {exchange}.
        slots:
          exchange: path.exchange
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/data-quality/coverage/{exchange}/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find data gaps for one symbol
      effect: read
      questions:
      - Are there missing periods in the archived data for a specific coin?
      - Can I limit gap detection for a symbol to a time window?
      instructions:
      - text: Check coverage and gaps for {symbol} on {exchange}.
        slots:
          symbol: path.symbol
          exchange: path.exchange
      - text: Find data gaps for {symbol} on {exchange} between {from} and {to}.
        slots:
          symbol: path.symbol
          exchange: path.exchange
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/data-quality/incidents'].get
  update:
    x-apievangelist-phrasing:
      intent: List data quality incidents
      effect: read
      questions:
      - Which data quality incidents have been reported recently?
      - Can I filter data incidents by status or exchange?
      instructions:
      - text: List data quality incidents for {exchange} since {since}.
        slots:
          exchange: query.exchange
          since: query.since
      - text: Show all incidents with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/data-quality/incidents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one data quality incident
      effect: read
      questions:
      - What happened in a specific data quality incident?
      - Can I look up the details of an incident by its ID?
      instructions:
      - text: Get incident {id}.
        slots:
          id: path.id
      - text: Show me the full details of data incident {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/data-quality/latency'].get
  update:
    x-apievangelist-phrasing:
      intent: Get current latency metrics
      effect: read
      questions:
      - How much latency is there on WebSocket and REST data right now?
      - How fresh is the data feed for each venue family?
      instructions:
      - text: Get current latency metrics.
      - text: Show WebSocket, REST and data freshness latency for each venue.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/data-quality/sla'].get
  update:
    x-apievangelist-phrasing:
      intent: Get monthly SLA compliance metrics
      effect: read
      questions:
      - Did uptime and completeness meet the SLA targets last month?
      - What SLA actuals versus targets were recorded for a given month?
      instructions:
      - text: Get SLA metrics for {month} {year}.
        slots:
          month: query.month
          year: query.year
      - text: Show this month's SLA compliance for uptime, completeness and latency.
      method: generated
      generated: '2026-09-26'