# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Unity Player Authentication API
  version: 1.0.0
extends: openapi/unity-authentication-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: 5
- target: $.paths['/v1/authentication/anonymous'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign a player in anonymously
      effect: write
      questions:
      - Can players start playing without creating an account?
      - What happens if an anonymous player's session token doesn't match anyone?
      instructions:
      - text: Sign the player in anonymously with session tokens {sessionTokens}.
        slots:
          sessionTokens: requestBody.sessionTokens
      - text: Get an access token for a guest player using session tokens {sessionTokens}.
        slots:
          sessionTokens: requestBody.sessionTokens
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/authentication/usernamepassword/sign-in'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign a player in with username and password
      effect: write
      questions:
      - How do I log an existing player in with a username and password?
      - Can a returning player authenticate using credentials they already registered?
      instructions:
      - text: Sign in player {username} with password {password}.
        slots:
          username: requestBody.username
          password: requestBody.password
      - text: Log in the existing account {username} using password {password}.
        slots:
          username: requestBody.username
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/authentication/usernamepassword/sign-up'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a player with username and password
      effect: write
      questions:
      - Can new players create an account with a username and password?
      - What do I need to register a brand-new player account?
      instructions:
      - text: Sign up a new player with username {username} and password {password}.
        slots:
          username: requestBody.username
          password: requestBody.password
      - text: Register account {username} with password {password}.
        slots:
          username: requestBody.username
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/authentication/external-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign a player in with an external identity token
      effect: write
      questions:
      - Can players sign in to my Unity game with their Google, Apple or Steam account?
      - Is it possible to only sign in an existing player without creating a new one from an external token?
      instructions:
      - text: Sign the player in with their {idProvider} token {token}.
        slots:
          idProvider: requestBody.idProvider
          token: requestBody.token
      - text: 'Authenticate using {idProvider} token {token}, sign-in only: {signInOnly}.'
        slots:
          idProvider: requestBody.idProvider
          token: requestBody.token
          signInOnly: requestBody.signInOnly
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/token/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a player's access token
      effect: write
      questions:
      - My player's access token expired; can I get a new one without logging in again?
      - What do I exchange to renew a session token?
      instructions:
      - text: Refresh the access token using refresh token {refreshToken}.
        slots:
          refreshToken: requestBody.refreshToken
      - text: Exchange refresh token {refreshToken} for a new access token.
        slots:
          refreshToken: requestBody.refreshToken
      method: generated
      generated: '2026-10-01'