Spade · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Spade Merchant Search API

3 actions 3 updates phrasing extends openapi/spade-merchant-search-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/merchants'].get

$.paths['/corporations'].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 Spade Merchant Search API
  version: 1.0.0
extends: openapi/spade-merchant-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/merchants'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up detailed merchant information by name
      effect: read
      questions:
      - How do I get full details on a merchant that shows up as a counterparty in my enrichments?
      - Are merchant IDs in Spade's database stable over time?
      instructions:
      - text: Get detailed merchant records matching {name}.
        slots:
          name: query.name
      - text: Look up the full merchant profile for {name} in the merchant database.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/corporations'].get
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete merchant names with logos
      effect: read
      questions:
      - How can I power a merchant autocomplete box with names, logos and websites?
      - How many matches does the merchant autocomplete search return?
      instructions:
      - text: Suggest up to five merchants as the user types {name}.
        slots:
          name: query.name
      - text: Autocomplete merchant {name} with logo and website.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'