0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive System API

5 actions 5 updates phrasing extends openapi/0xarchive-system-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 5

$.info

$.paths['/health'].get

$.paths['/v1/symbols'].get

$.paths['/v1/stats'].get

$.paths['/v1/status/coverage'].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 System API
  version: 1.0.0
extends: openapi/0xarchive-system-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: 4
- target: $.paths['/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether the API is up
      effect: read
      questions:
      - Is the 0xArchive API up right now?
      - Can I ping a health endpoint without an API key?
      instructions:
      - text: Check the API health status.
      - text: Run an unauthenticated health check before starting my data pull.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/symbols'].get
  update:
    x-apievangelist-phrasing:
      intent: List every public market symbol
      effect: read
      questions:
      - Which market symbols can I get data for across all venues?
      - Where do I find the full symbol universe before picking a venue-specific route?
      instructions:
      - text: List all public market symbols across every venue family.
      - text: Pull the public symbol list so I can see which coins are covered.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get public API usage statistics
      effect: read
      questions:
      - What headline statistics does the public stats endpoint report?
      - Can I read the lightweight public API stats without authenticating?
      instructions:
      - text: Fetch the public API stats.
      - text: Show me the lightweight public statistics used on the website.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/status/coverage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the public data coverage status
      effect: read
      questions:
      - Is there a public, no-auth view of data coverage across venues?
      - How fresh is the public coverage summary shown on the status page?
      instructions:
      - text: Get the public coverage status summary.
      - text: Show the no-auth coverage status used by the status page.
      method: generated
      generated: '2026-09-26'