# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for REST Clearing API
  version: 1.0.0
extends: openapi/gemini-trust-clearing-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: 8
- target: $.paths['/v1/clearing/new'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a new clearing order to a counterparty
      effect: write
      questions:
      - How do I settle an off-exchange trade with a counterparty through Gemini Clearing?
      - Can I set a clearing order to expire after a certain number of hours?
      - What happens if I submit a clearing order without naming a counterparty?
      instructions:
      - text: Create a clearing order to {side} {amount} {symbol} at {price} with counterparty {counterparty_id}.
        slots:
          side: requestBody.side
          amount: requestBody.amount
          symbol: requestBody.symbol
          price: requestBody.price
          counterparty_id: requestBody.counterparty_id
      - text: Submit a clearing order to {side} {amount} {symbol} at {price} that expires in {expires_in_hrs} hours.
        slots:
          side: requestBody.side
          amount: requestBody.amount
          symbol: requestBody.symbol
          price: requestBody.price
          expires_in_hrs: requestBody.expires_in_hrs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/clearing/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a clearing order
      effect: read
      questions:
      - Has my clearing order been confirmed or settled yet?
      - Where can I see the current state of one clearing trade by its ID?
      instructions:
      - text: Get the status of clearing order {clearing_id}.
        slots:
          clearing_id: requestBody.clearing_id
      - text: Check whether clearing order {clearing_id} on account {account} has settled.
        slots:
          clearing_id: requestBody.clearing_id
          account: requestBody.account
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/clearing/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending clearing order
      effect: destructive
      questions:
      - Can I withdraw a clearing order before the counterparty confirms it?
      - What do I need to call off a clearing trade I submitted by mistake?
      instructions:
      - text: Cancel clearing order {clearing_id}.
        slots:
          clearing_id: requestBody.clearing_id
      - text: Call off the unconfirmed clearing order {clearing_id} on account {account}.
        slots:
          clearing_id: requestBody.clearing_id
          account: requestBody.account
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/clearing/confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm a clearing order as the counterparty
      effect: write
      questions:
      - A counterparty sent me a clearing order. How do I accept it?
      - Do the symbol, amount, price and side have to match exactly when I confirm a clearing trade?
      instructions:
      - text: Confirm clearing order {clearing_id} to {side} {amount} {symbol} at {price}.
        slots:
          clearing_id: requestBody.clearing_id
          side: requestBody.side
          amount: requestBody.amount
          symbol: requestBody.symbol
          price: requestBody.price
      - text: Accept the incoming clearing trade {clearing_id} as the counterparty on account {account}.
        slots:
          clearing_id: requestBody.clearing_id
          account: requestBody.account
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/clearing/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List my clearing orders with filters
      effect: read
      questions:
      - Which of my clearing orders are still waiting on a counterparty?
      - Can I filter my clearing orders by counterparty and submission date?
      - Is there a way to see only funded clearing orders?
      instructions:
      - text: List my clearing orders with counterparty {counterparty}.
        slots:
          counterparty: requestBody.counterparty
      - text: Show my {symbol} clearing orders with status {status}.
        slots:
          symbol: requestBody.symbol
          status: requestBody.status
      - text: List clearing orders I submitted between {submission_start} and {submission_end}.
        slots:
          submission_start: requestBody.submission_start
          submission_end: requestBody.submission_end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/clearing/broker/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List broker-facilitated clearing orders
      effect: read
      questions:
      - As a broker, which clearing orders have I arranged between customers?
      - Can I see broker clearing orders that expire within a given window?
      instructions:
      - text: List the broker clearing orders I facilitated for {symbol}.
        slots:
          symbol: requestBody.symbol
      - text: Show broker clearing orders expiring between {expiration_start} and {expiration_end}.
        slots:
          expiration_start: requestBody.expiration_start
          expiration_end: requestBody.expiration_end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/clearing/broker/new'].post
  update:
    x-apievangelist-phrasing:
      intent: Broker a clearing trade between two customers
      effect: write
      questions:
      - Can a broker set up a trade between two Gemini customers that both sides must confirm?
      - Which side does the source counterparty take on a broker clearing order?
      instructions:
      - text: Broker a trade where {source_counterparty_id} will {side} {amount} {symbol} from {target_counterparty_id} at {price}.
        slots:
          source_counterparty_id: requestBody.source_counterparty_id
          side: requestBody.side
          amount: requestBody.amount
          symbol: requestBody.symbol
          target_counterparty_id: requestBody.target_counterparty_id
          price: requestBody.price
      - text: Submit a broker clearing order between {source_counterparty_id} and {target_counterparty_id} expiring in {expires_in_hrs} hours.
        slots:
          source_counterparty_id: requestBody.source_counterparty_id
          target_counterparty_id: requestBody.target_counterparty_id
          expires_in_hrs: requestBody.expires_in_hrs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/clearing/trades'].post
  update:
    x-apievangelist-phrasing:
      intent: List settled clearing trades
      effect: read
      questions:
      - Which clearing trades have actually settled on my accounts?
      - Can I pull clearing trades from a specific timestamp onward?
      instructions:
      - text: List my settled {symbol} clearing trades.
        slots:
          symbol: requestBody.symbol
      - text: Show up to {limit_trades} clearing trades for account {account}.
        slots:
          limit_trades: requestBody.limit_trades
          account: requestBody.account
      method: generated
      generated: '2026-10-01'