# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hilt So Auth API
  version: 1.0.0
extends: openapi/hilt-so-auth-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: 8
- target: $.paths['/v1/auth/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new merchant account
      effect: write
      questions:
      - How do I sign up for a free Hilt merchant account?
      - Can I use a referral code when I register?
      instructions:
      - text: Register a merchant account for {email} with password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      - text: Sign up {email} using referral code {referral_code} and password {password}.
        slots:
          email: requestBody.email
          referral_code: requestBody.referral_code
          password: requestBody.password
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/login'].post
  update:
    x-apievangelist-phrasing:
      intent: Log in with email and password
      effect: write
      questions:
      - How do I get a JWT by logging in with my email and password?
      - Does the login token include my plan entitlements?
      instructions:
      - text: Log in as {email} with password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      - text: Sign me in with {email} and get a token.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/wallet'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign in with a Phantom wallet
      effect: write
      questions:
      - Can I sign in with my Phantom wallet instead of an email?
      - What do I need to send to authenticate with a signed wallet nonce?
      instructions:
      - text: Authenticate wallet {wallet_address} with signed message {signed_message} for nonce {message_nonce}.
        slots:
          wallet_address: requestBody.wallet_address
          signed_message: requestBody.signed_message
          message_nonce: requestBody.message_nonce
      - text: Log in with Phantom wallet {wallet_address}.
        slots:
          wallet_address: requestBody.wallet_address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/oauth/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List available OAuth sign-in providers
      effect: read
      questions:
      - Which social OAuth providers can I sign in with?
      - Is OAuth login currently enabled for each provider?
      instructions:
      - text: List the OAuth sign-in providers and their status.
      - text: Show which OAuth logins are available.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/oauth/{provider}/start'].get
  update:
    x-apievangelist-phrasing:
      intent: Start an OAuth sign-in flow
      effect: read
      questions:
      - How do I begin signing in through an OAuth provider?
      - Can I choose where to redirect after the OAuth login finishes?
      instructions:
      - text: Start OAuth sign-in with {provider}.
        slots:
          provider: path.provider
      - text: Begin an OAuth login with {provider} and return to {next} afterward.
        slots:
          provider: path.provider
          next: query.next
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/oauth/{provider}/callback'].get
  update:
    x-apievangelist-phrasing:
      intent: Handle an OAuth provider callback
      effect: read
      questions:
      - What endpoint receives the authorization code when the OAuth provider redirects back?
      - How is an OAuth error returned from the provider handled on callback?
      instructions:
      - text: Complete the {provider} OAuth callback with code {code} and state {state}.
        slots:
          provider: path.provider
          code: query.code
          state: query.state
      - text: Process the {provider} callback that returned error {error}.
        slots:
          provider: path.provider
          error: query.error
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/logout'].post
  update:
    x-apievangelist-phrasing:
      intent: Log out of the current session
      effect: write
      questions:
      - How do I log out of my session?
      - Does logging out invalidate my JWT on the server?
      instructions:
      - text: Log me out.
      - text: End my current session.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a session token
      effect: write
      questions:
      - Can I renew my JWT before it expires?
      - Will a refreshed token pick up my new subscription plan?
      instructions:
      - text: Refresh token {token}.
        slots:
          token: requestBody.token
      - text: Get a fresh JWT from {token} with updated entitlements.
        slots:
          token: requestBody.token
      method: generated
      generated: '2026-09-26'