Gemini Trust Company · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for REST Staking API

7 actions 7 updates phrasing extends openapi/gemini-trust-staking-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Gemini Trust Company's API. It is a proposal applied on top of the contract, not a document Gemini Trust Company publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v1/balances/staking'].post
$.paths['/v1/staking/stake'].post
$.paths['/v1/staking/history'].post
$.paths['/v1/staking/rates'].get
$.paths['/v1/staking/rewards'].post
$.paths['/v1/staking/unstake'].post

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 REST Staking API
  version: 1.0.0
extends: openapi/gemini-trust-staking-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: 6
- target: $.paths['/v1/balances/staking'].post
  update:
    x-apievangelist-phrasing:
      intent: Get staking balances
      effect: read
      questions:
      - How much of my crypto is currently staked?
      - What staked balance is available to withdraw?
      instructions:
      - text: Show my staking balances.
      - text: List staked and withdrawable balances for account {account}.
        slots:
          account: requestBody.account
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/staking/stake'].post
  update:
    x-apievangelist-phrasing:
      intent: Stake crypto with a staking provider
      effect: write
      questions:
      - How do I start staking ETH from my exchange balance?
      - Which provider ID do I need to make a staking deposit?
      instructions:
      - text: Stake {amount} {currency} with provider {providerId}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          providerId: requestBody.providerId
      - text: Deposit {amount} {currency} into staking for account {account} via provider {providerId}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          account: requestBody.account
          providerId: requestBody.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/staking/history'].post
  update:
    x-apievangelist-phrasing:
      intent: List staking deposits, redemptions and interest
      effect: read
      questions:
      - What staking deposits and redemptions have I made?
      - Can I show only daily interest accruals in my staking history?
      instructions:
      - text: List my {currency} staking history since {since}.
        slots:
          currency: requestBody.currency
          since: requestBody.since
      - text: Show up to {limit} staking events between {since} and {until}.
        slots:
          limit: requestBody.limit
          since: requestBody.since
          until: requestBody.until
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/staking/rates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get current staking interest rates
      effect: read
      questions:
      - What staking yield does each asset earn right now?
      - Are staking rates quoted in basis points?
      instructions:
      - text: Show current staking rates for all assets.
      - text: List the staking interest rates in bps.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/staking/rewards'].post
  update:
    x-apievangelist-phrasing:
      intent: List historical staking reward payments
      effect: read
      questions:
      - How much have I earned in staking rewards over time?
      - Can I see staking reward accruals for one currency?
      instructions:
      - text: List my staking rewards since {since}.
        slots:
          since: requestBody.since
      - text: Show {currency} staking reward payments from {since} to {until}.
        slots:
          currency: requestBody.currency
          since: requestBody.since
          until: requestBody.until
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/staking/unstake'].post
  update:
    x-apievangelist-phrasing:
      intent: Unstake crypto from a staking provider
      effect: write
      questions:
      - How do I take my crypto out of staking?
      - Can I unstake only part of my staked balance?
      instructions:
      - text: Unstake {amount} {currency} from provider {providerId}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          providerId: requestBody.providerId
      - text: Withdraw {amount} {currency} from staking for account {account} via provider {providerId}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          account: requestBody.account
          providerId: requestBody.providerId
      method: generated
      generated: '2026-10-01'