0xArchive · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 0xArchive HIP-4 Outcomes - Instruments API

3 actions 3 updates phrasing extends openapi/0xarchive-hip-4-outcomes-instruments-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 3

$.info
$.paths['/v1/hyperliquid/hip4/instruments'].get
$.paths['/v1/hyperliquid/hip4/instruments/{symbol}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 0xArchive HIP-4 Outcomes - Instruments API
  version: 1.0.0
extends: openapi/0xarchive-hip-4-outcomes-instruments-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: 2
- target: $.paths['/v1/hyperliquid/hip4/instruments'].get
  update:
    x-apievangelist-phrasing:
      intent: List HIP-4 outcome side instruments
      effect: read
      questions:
      - Which HIP-4 outcome sides are listed?
      - How are Yes and No sides of a HIP-4 outcome represented?
      instructions:
      - text: List all HIP-4 instruments.
      - text: Show every HIP-4 outcome side coin.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hyperliquid/hip4/instruments/{symbol}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one HIP-4 outcome side instrument
      effect: read
      questions:
      - What are the details of a single HIP-4 side coin?
      - 'Can I look up a HIP-4 instrument with or without the # prefix?'
      instructions:
      - text: Get HIP-4 instrument {symbol}.
        slots:
          symbol: path.symbol
      - text: Show the instrument for outcome side {symbol}.
        slots:
          symbol: path.symbol
      method: generated
      generated: '2026-09-26'